Python Pretty-Print JSON with Indentation and Sorting

This Python tutorial explains Pretty-Print JSON with Indentation and Sorting. Follow the example, inspect the output, and practise an input change so you understand the behavior rather than simply copying the syntax.

What This Feature Does

Format JSON for human review with indentation and stable key order.

json.dumps(..., indent=2, sort_keys=True) adds whitespace and sorts object keys for readable output. Formatting does not validate a business schema, and changing separators can affect the resulting file size.

When to Use It

This technique belongs to JSON processing. It is useful when the input, operation and expected outcome are known. Start with a small controlled example before integrating it into a larger workflow.

Step-by-Step Python Example

Read the code once before running it. Notice which values are inputs, which function or method performs the work, and whether the result is returned or stored by changing an existing object.

import json
record = {'zeta': 3, 'alpha': {'enabled': True}}
pretty_text = json.dumps(record, indent=2, sort_keys=True)
print(pretty_text.splitlines()[1].strip())
print(json.loads(pretty_text) == record)

Understanding the Code

First, the imports make json available. They provide the filesystem, data or standard-library functions used later.
Find the call json.dumps(record, indent=2, sort_keys=True). Its parameters determine the specific operation demonstrated in the title.
Its purpose is to format json for human review with indentation and stable key order. Compare this description against the result printed by the program.
The print() expressions display a checkable outcome. Print values and exception names are not substitutes for the program result itself.

Expected Output

"alpha": {
True

Each printed line corresponds to a separate observation in the program. Use the lines to distinguish returned data, changes to existing objects, and status checks.

Important Details and Edge Cases

Format a nested JSON configuration and save it with a trailing newline.

Decoding a valid file format does not automatically validate the meaning of its data. Confirm expected keys, types, permitted values and resource limits before using externally supplied content.

Practice: Try It Yourself

Use compact separators only when file size matters more than readability.

Begin by copying the example into a separate practice file. Change one input at a time, run it again, and describe why the result changed. If the exercise writes or deletes files, keep it inside a temporary test folder.

Official Python Documentation

For the complete reference, see the Python standard library documentation.

Common Beginner Mistakes

Assuming pretty printing fixes invalid source JSON or guarantees a stable order in arrays.
Format a nested JSON configuration and save it with a trailing newline.
Decoding a valid file format does not automatically validate the meaning of its data. Confirm expected keys, types, permitted values and resource limits before using externally supplied content.

Key Takeaways

Format JSON for human review with indentation and stable key order.
json.dumps(..., indent=2, sort_keys=True) adds whitespace and sorts object keys for readable output. Formatting does not validate a business schema, and changing separators can affect the resulting file size.
Avoid this common pitfall: Assuming pretty printing fixes invalid source JSON or guarantees a stable order in arrays.