Formatting structured data in Python

Introduction

We format structured data to make it easy to read and understand. It helps us share data clearly with others or save it in a neat way.

When you want to print data like lists or dictionaries in a readable way.

When saving data to a file so others can open and understand it easily.

When sending data over the internet in a format like JSON.

When debugging, to see the structure of your data clearly.

When you want to organize data output for reports or logs.

Syntax

Python

import json

json.dumps(data, indent=number_of_spaces)

# or

print(json.dumps(data, indent=4))

json.dumps() converts Python data into a formatted string.

The indent parameter adds spaces to make the output easier to read.

Examples

Prints the dictionary as a compact JSON string without extra spaces.

Python

import json

my_data = {'name': 'Alice', 'age': 30}
print(json.dumps(my_data))

Prints the dictionary with indentation of 2 spaces for better readability.

Python

import json

my_data = {'name': 'Alice', 'age': 30}
print(json.dumps(my_data, indent=2))

Formats a list containing numbers and a dictionary with 4 spaces indentation.

Python

import json

my_list = [1, 2, 3, {'a': 4, 'b': 5}]
print(json.dumps(my_list, indent=4))

Sample Program

This program formats a dictionary with nested list into a nicely indented JSON string and prints it.

Python

import json

person = {
    'name': 'John',
    'age': 25,
    'hobbies': ['reading', 'gaming', 'hiking']
}

formatted = json.dumps(person, indent=4)
print(formatted)

Important Notes

Use json.dumps() for formatting data as a string.

You can also use json.dump() to write formatted data directly to a file.

Indentation helps humans read data but is ignored by computers when parsing.

Summary

Formatting structured data makes it easier to read and share.

Use json.dumps() with indent to add spaces and new lines.

This is useful for printing, saving, or sending data clearly.

Practice

1. What does the indent parameter do in json.dumps() when formatting structured data?

easy

A. Adds spaces and new lines to make the output easier to read

B. Converts data into a binary format

C. Removes all spaces and new lines for compact output

D. Encrypts the JSON data for security

Solution

1. Step 1: Understand the purpose of json.dumps()

   This function converts Python data into a JSON string.

2. Step 2: Role of indent parameter

   The indent parameter adds spaces and new lines to format the JSON string nicely for readability.

3. Final Answer:

   Adds spaces and new lines to make the output easier to read -> Option A

4. Quick Check:

   indent = readable JSON [OK]

Hint: Remember: indent means pretty print with spaces [OK]

Common Mistakes:

• Thinking indent compresses JSON
• Confusing indent with encryption
• Assuming indent changes data content

2. Which of the following is the correct syntax to format a Python dictionary data as a JSON string with indentation of 4 spaces?

easy

A. json.dumps(data, indent=4)

B. json.dumps(data, indent='4')

C. json.dumps(data, indent=True)

D. json.dumps(data, space=4)

Solution

1. Step 1: Check the correct parameter type for indent

   The indent parameter expects an integer number of spaces, not a string or boolean.

2. Step 2: Validate each option

   json.dumps(data, indent=4) uses indent=4 correctly. json.dumps(data, indent='4') uses a string '4' which is invalid. json.dumps(data, indent=True) uses boolean True which is invalid. json.dumps(data, space=4) uses a wrong parameter name space.

3. Final Answer:

   json.dumps(data, indent=4) -> Option A

4. Quick Check:

   Indent value must be integer [OK]

Hint: Use integer for indent, not string or boolean [OK]

Common Mistakes:

• Passing indent as a string instead of integer
• Using wrong parameter name like 'space'
• Passing boolean instead of number

3. What is the output of this code?

import json
data = {'name': 'Alice', 'age': 30}
print(json.dumps(data, indent=2))

medium

A. {"name": "Alice", "age": 30}

B. {
"name": "Alice",
"age": 30
}

C. {name: Alice, age: 30}

D. SyntaxError

Solution

1. Step 1: Understand json.dumps with indent=2

   The function converts the dictionary to a JSON string with 2 spaces indentation for each nested level.

2. Step 2: Check the output format

   The output will have new lines and spaces, keys and string values in double quotes, and numeric values as is.

3. Final Answer:

   { "name": "Alice", "age": 30 } -> Option B

4. Quick Check:

   Indent=2 adds spaces and new lines [OK]

Hint: Indent adds new lines and spaces for readability [OK]

Common Mistakes:

• Expecting compact JSON without spaces
• Using single quotes instead of double quotes
• Confusing Python dict print with JSON string

4. The following code throws an error. What is the mistake?

import json
data = {'x': 1, 'y': 2}
print(json.dumps(data, indent=2.0))

medium

A. json.dumps requires a second argument for separators

B. The data dictionary keys must be strings only

C. json.dumps cannot format dictionaries

D. The indent parameter should be an integer, not a float

Solution

1. Step 1: Identify the error cause

   The indent parameter is given as a float 2.0 instead of an integer 2.

2. Step 2: Understand parameter type requirements

   json.dumps expects indent to be an integer number of spaces for formatting, passing a float causes a TypeError.

3. Final Answer:

   The indent parameter should be an integer, not a float -> Option D

4. Quick Check:

   Indent must be int, not float [OK]

Hint: Check indent type: must be integer, not float [OK]

Common Mistakes:

• Passing indent as float instead of int
• Thinking keys must be strings for json.dumps
• Expecting separators argument is mandatory

5. You have a list of dictionaries representing users:

users = [{'name': 'Bob', 'age': 25}, {'name': 'Eve', 'age': 28}]

How do you create a JSON string with indentation of 2 spaces and keys sorted alphabetically?

hard

A. json.dumps(users, indent='2', sort_keys=True)

B. json.dumps(users, indent=2, sort=True)

C. json.dumps(users, indent=2, sort_keys=True)

D. json.dumps(users, pretty=2, sort_keys=True)

Solution

1. Step 1: Use json.dumps with indent and sort_keys

   The indent parameter formats the JSON with spaces and new lines. The sort_keys=True sorts dictionary keys alphabetically.

2. Step 2: Validate correct parameter names and types

   json.dumps(users, indent=2, sort_keys=True) uses correct parameters and types. json.dumps(users, indent=2, sort=True) uses invalid parameter sort. json.dumps(users, indent='2', sort_keys=True) passes indent as string which is invalid. json.dumps(users, pretty=2, sort_keys=True) uses invalid parameter pretty.

3. Final Answer:

   json.dumps(users, indent=2, sort_keys=True) -> Option C

4. Quick Check:

   Use indent=int and sort_keys=True [OK]

Hint: Use sort_keys=True and indent as integer [OK]

Common Mistakes:

• Using wrong parameter names like sort or pretty
• Passing indent as string
• Forgetting sort_keys to sort keys