5 Best Ways to Convert Python Dict to JSON Pretty Print

by

💡 Problem Formulation: When working with data in Python, it’s often necessary to convert a dictionary to a JSON string for ease of readability, data interchange or for feeding into a web service. The desired output is a JSON string that maintains the hierarchical structure and is easy on the eyes – typically achieved with appropriate indentation. For example, turning {'name': 'Alice', 'age': 30, 'city': 'Wonderland'} into a neatly formatted JSON string.

Method 1: Using json.dumps() with indent parameter

This method involves Python’s built-in json module, specifically the dumps() function, which serializes dict to a JSON formatted str with an optional indent parameter that specifies the number of spaces for each indentation level in the output.

Here’s an example:

import json

data = {'name': 'Alice', 'age': 30, 'city': 'Wonderland'}
pretty_json = json.dumps(data, indent=4)
print(pretty_json)

The output of this code snippet will be:

{
    "name": "Alice",
    "age": 30,
    "city": "Wonderland"
}

This code snippet serializes the Python dictionary data into a JSON formatted string with an indentation of 4 spaces for each level, resulting in a human-readable JSON printout.

Method 2: Using json.dump() with a file object

The json.dump() function is similar to json.dumps(), but instead of returning a string, it writes the JSON data directly to a file-like object, which can be useful for saving the prettified JSON to a file.

Here’s an example:

import json

data = {'name': 'Alice', 'age': 30, 'city': 'Wonderland'}
with open('data.json', 'w') as json_file:
    json.dump(data, json_file, indent=4)

This snippet doesn’t produce a visible output on the console but creates a file named data.json with the prettified JSON content.

This method avoids using extra memory for storing the JSON string and is efficient for large amounts of data since it writes to the file directly.

Method 3: Integrate sort_keys for ordered output

Enhancing the output further, by using the json.dumps() function with the indent parameter as well as the sort_keys parameter, the keys within the JSON string can be sorted alphabetically.

Here’s an example:

import json

data = {'name': 'Alice', 'age': 30, 'city': 'Wonderland'}
pretty_json = json.dumps(data, indent=4, sort_keys=True)
print(pretty_json)

The resulting output:

{
    "age": 30,
    "city": "Wonderland",
    "name": "Alice"
}

In this example, the sort_keys parameter is set to True, which outputs the dictionary keys in an alphabetic order, making the JSON output more structured and predictable.

Method 4: Pretty-printing JSON string from the command line

Another useful context is when working with JSON data in the command line. Python’s -m option allows modules to be run as scripts, and combining this with pipe operators can pretty-print JSON straight from the command line.

Here’s an example:

echo '{"name": "Alice", "age": 30, "city": "Wonderland"}' | python -m json.tool

This will produce the following output on your terminal:

{
    "name": "Alice",
    "age": 30,
    "city": "Wonderland"
}

This example uses the echo command to send a JSON string to Python’s json.tool module, which automatically formats the JSON to be human-readable, providing a quick way to pretty-print JSON data on the fly.

Bonus One-Liner Method 5: Utilizing online JSON formatters

As a quick alternative, there are numerous online tools that can pretty-print JSON data. While not a Python-specific method, it’s handy for one-off formatting without writing any code.

Here’s an example:

{"name": "Alice", "age": 30, "city": "Wonderland"}

Just paste the code into an online JSON formatter, and it will automatically prettify it for you.

This one-liner alternative is useful for ad-hoc use but requires an internet connection and isn’t suitable for sensitive or large-scale data processing.

Summary/Discussion

  • Method 1: json.dumps() with indent: Straightforward and reliable. Easily customizable indentation. In-memory operation.
  • Method 2: json.dump() with a file object: Ideal for writing directly to files. Efficient for large data. No immediate output, as data is written to a file.
  • Method 3: json.dumps() with sort_keys: Provides ordered output. Easy to compare different JSON data. Indentation and sorting can be customized for pretty-printing.
  • Method 4: Command line json.tool: Convenient for command-line users. No need for writing a script for quick tasks. Limited by the command line environment’s capabilities.
  • Bonus Method 5: Online JSON formatters: Quick and user-friendly. Not secure for sensitive data. Requires internet connection.