JSON, short for JavaScript Object Notation, is an open standard. Although its name doesn’t imply so, it is a language-independent data format. With Python’s JSON library, we can read, write, and parse JSON, in order to both store and exchange data using this versatile data format. It’s a prevalent data format because it is easy to read and write for humans too, although not as easy as YAML!
Working with JSON in Python is super easy! Python has two data types that, together, form the perfect tool for working with JSON in Python: dictionaries and lists.
Table of contents
Importing the JSON library
Python ships with a powerful and elegant JSON library to help you decode and encode JSON. You can import the module with:
import json
This library is part of Python, so you don’t need to install it with the Pip package manager.
How to parse JSON in Python
Parsing a string of JSON data, also called decoding JSON, is as simple as using json.loads(…)
. Loads is short for load string.
It converts:
- objects to dictionaries
- arrays to lists,
- booleans, integers, floats, and strings are recognized for what they are and will be converted into the correct types in Python
- Any
null
will be converted into Python’sNone
type
Here’s an example of json.loads
in action:
json.loads
to parse a JSON stringIf the interactive example above doesn’t work (it’s still in beta), here’s a more static example instead:
>>> import json >>> jsonstring = '{"name": "erik", "age": 38, "married": true}' >>> person = json.loads(jsonstring) >>> print(person['name'], 'is', person['age'], 'years old') erik is 38 years old >>> print(person) {'name': 'erik', 'age': 38, 'married': True}
The output might look like a string, but it’s actually a dictionary that you can use in your code as explained on our page about Python dictionaries. You can check for yourself:
>>> type(person) <class 'dict'>
Encoding JSON with json.dumps
Encoding JSON data with Python’s json.dumps
is just as easy as decoding. Use json.dumps
(short for ‘dump to string’) to convert a Python object consisting of dictionaries, lists, and other native types into a string:
Here’s the same example, in case the above interactive example doesn’t work in your browser:
import json person = {'name': 'erik', 'age': 38, 'married': True} json_string = json.dumps(person) print(json_string) # {"name": "erik", "age": 38, "married": true} # To make sure, let's print the type too print(type(json_string)) # <class 'str'>
This is the same document, converted back to a string! If you want to make your JSON document more readable for humans, use the indent option. It will nicely format the JSON, using space characters:
>>> person = {'name': 'erik', 'age': 38, 'married': True} >>> print(json.dumps(person, indent=2)) { "name": "erik", "age": 38, "married": true }
Pretty printing JSON on the command line
Python’s JSON module can also be used from the command line. It will both validate and pretty-print your JSON:
$ echo "{ \"name\": \"Monty\", \"age\": 45 }" | \ python3 -m json.tool { "name": "Monty", "age": 45 }
You may also be interested in using the jq-tool for this though!
How to read a JSON file in python
Besides json.loads
, there’s also a function called json.load
(without the s). It will load data from a file, but you have to open the file yourself. If you want to read the contents of a JSON file into Python and parse it, use the following example:
with open('data.json') as json_file: data = json.load(json_file) ...
How to write JSON to a file in Python
The json.dump
function is used to write data to a JSON file. You’ll need to open the file in write mode first:
data = {'name': 'Eric', 'age': 38 } with open('data.json', 'w') as json_file: json.dump(data, json_file)
Frequently Asked Questions
Simply use the methods described above. The json.dump
and json.dumps
functions accept both dictionaries and lists
Similar to arrays, so use json.dump
or json.dumps
on the dictionary.
The dump and dumps functions both accept an option called sort_keys, for example: json.dumps(data, sort_keys=True)
.
By default: no. The library outputs ASCII and will convert characters that are not part of ASCII. If you want to output Unicode, set ensure_ascii to False. Example: json.dumps(data, ensure_ascii=False)
Keep learning
- If you’re looking for a format that is easy to write for humans (e.g.: config files), read our article on reading and writing YAML with Python.
- JMESPath is a query language for JSON. JMESPath in Python allows you to obtain the data you need from a JSON document or dictionary easily.
- If you need to parse JSON on the command-line, try our article on a tool called jq!
- Get a refresher on opening, writing, and reading files with Python.