Python json.dump() Function: Usage and Examples

This Python tutorial explains json.dump() Function: Usage and Examples. 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

Write a JSON document to a text file or file-like object.

json.dump(value, file, indent=..., ensure_ascii=...) writes text into an already open writable stream. It does not add a trailing newline automatically and multiple dump() calls into one file do not create one valid JSON document.

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
from io import StringIO
output_stream = StringIO()
json.dump({'ready': True, 'items': [1, 2]}, output_stream, indent=2)
print(json.loads(output_stream.getvalue())['ready'])

Understanding the Code

First, the imports make json, io available. They provide the filesystem, data or standard-library functions used later.
Find the call json.dump({'ready': True, 'items': [1, 2]}, output_stream, indent=2). Its parameters determine the specific operation demonstrated in the title.
Its purpose is to write a json document to a text file or file-like object. 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

True

The output is the observable result of the sample operation. Compare its value and type with the explanation, not just whether the program runs.

Important Details and Edge Cases

Write one inventory record to an indented UTF-8 JSON file.

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

Write JSON Lines deliberately when you need one document per line.

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

Calling dump() repeatedly to append independent JSON objects and expecting one valid JSON document.
Write one inventory record to an indented UTF-8 JSON file.
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

Write a JSON document to a text file or file-like object.
json.dump(value, file, indent=..., ensure_ascii=...) writes text into an already open writable stream. It does not add a trailing newline automatically and multiple dump() calls into one file do not create one valid JSON document.
Avoid this common pitfall: Calling dump() repeatedly to append independent JSON objects and expecting one valid JSON document.