{"id":17713,"date":"2020-06-01T06:15:50","date_gmt":"2020-06-01T13:15:50","guid":{"rendered":"https:\/\/careerkarma.com\/blog\/?p=17713"},"modified":"2023-12-01T03:05:30","modified_gmt":"2023-12-01T11:05:30","slug":"python-json","status":"publish","type":"post","link":"https:\/\/careerkarma.com\/blog\/python-json\/","title":{"rendered":"Python JSON"},"content":{"rendered":"\n

JSON is a popular data format used for storing structured data.
<\/p>\n\n\n\n

When you\u2019re building an application in Python, you may decide that you want to use JSON in your app. For instance, you may want to read data from a JSON file, or write data stored in the JSON format to a file.
<\/p>\n\n\n\n

In this guide, we\u2019re going to break down the basics of the JSON data format, how to use the Python json module, and how to work with JSON in Python. By the end of reading this tutorial, you\u2019ll be an expert at using JSON in your Python programs!
<\/p>\n\n\n\n

What is JSON?<\/h2>\n\n\n\n

JSON, which is short for JavaScript Object Notation, is a data format that allows you to store structured data.
<\/p>\n\n\n\n

Often, JSON is used to send data to and from a server in a web application. You may have seen, for instance, that many APIs such as the Fitbit API, or the Google Maps API return data in the JSON format
<\/p>\n\n\n\n

This is because JSON data is standardized, structured, and easy to read.
<\/p>\n\n\n\n

Here is an example of a JSON record in Python:
<\/p>\n\n\n\n

{\n\t\"name\": \"James Smith\",\n\t\"id\": 202,\n\t\"probation\": False\n}\n<\/pre><\/div>\n\n\n\n
This record stores three keys, which are on the left side of the colons (:), and three values, which are stored on the right side of the colons. Each key is bound to a value.
<\/p>\n\n\n\n
The JSON data format should not be confused with a dictionary. While this may look just like a dictionary, JSON is a data format, whereas a dictionary is a data structure.
<\/p>\n\n\n\n
This means that, if you want to store your JSON data in a dictionary, you will need to convert it to a dictionary; if you want to store a dictionary as JSON, you\u2019ll need to convert it to JSON.
<\/p>\n\n\n\n
Import json in Python<\/h2>\n\n\n\n
Before you start working with JSON objects in Python, you\u2019ll need to import the Python json module. This module includes a number of functions that allow you to work with JSON data.
<\/p>\n\n\n\n
To import the JSON module, you can use this statement:
<\/p>\n\n\n\n
import json
<\/code><\/p>\n\n\n\n
Now that we\u2019ve imported the JSON module into your code, we can start working with its functions.
<\/p>\n\n\n\n
Parse JSON in Python<\/h2>\n\n\n\n
One of the most important functions you\u2019ll need to perform when it comes to working with JSON data is parsing JSON into a dictionary.
<\/p>\n\n\n\n
To parse JSON into a dictionary, you can use the json.loads() <\/code>method.
<\/p>\n\n\n\n
json.loads()<\/code> accepts one parameter: the JSON string you want to convert to a dictionary.
<\/p>\n\n\n\n
Suppose you have a JSON string that stores information about the projects a coder is assigned to on an engineering team. You want to convert that JSON string into a dictionary. To do so, you could use this code:
<\/p>\n\n\n\n
import json\nemployee = \"{'name': 'Linda Richardson', 'projects': ['Directory', 'Homepage']}\"\nemployee_dictionary = json.loads(employee)\nprint(employee_dictionary)\nprint(employee_dictionary[\"name\"])\n<\/pre><\/div>\n\n\n\n
Our code returns:
<\/p>\n\n\n\n
{‘name’: ‘Linda Richardson’, ‘projects’: [‘Directory’, ‘Homepage’]}<\/p>\n\n\n\n
Linda Richardson
<\/p>\n\n\n\n
Let\u2019s break down our code. First, we import the json module into our code. Then, we declare a string called employee<\/code> which stores our employee record in a JSON structure.
<\/p>\n\n\n\n
Next, we use json.loads()<\/code> to convert our employee<\/code> string to JSON. Then, we print our new dictionary to the console. We also print the value of the name<\/code> key to the console.
<\/p>\n\n\n\n
As you can see, our dictionary looks the same as our JSON string. But, now our data is stored as a dictionary. We can tell because, when we print out the value of the \u201cname\u201d key, \u201cLinda Richardson\u201d is printed to the console.
<\/p>\n\n\n\n
Convert Dictionary to JSON String<\/h2>\n\n\n\n
When you\u2019re working with a dictionary, you may want to convert it into a JSON string.
<\/p>\n\n\n\n
This is a common operation because, because you save a JSON value to a file, it needs to be formatted as a string. To convert a dictionary to JSON, we can use the json.dumps()<\/code> method.
<\/p>\n\n\n\n
Suppose we want to convert a dictionary with information about an employee to a JSON string. We could do so using this code:
<\/p>\n\n\n\n
import json\nemployee = {\n\t\"name\": \"Linda Richardson\",\n\t\"id\": 107,\n\t\"probation\": False,\n\t\"department\": \"Sales\"\n}\nemployee_json = json.dumps(employee)\nprint(employee_json)\n<\/pre><\/div>\n\n\n\n
Our code returns:
<\/p>\n\n\n\n
\u2018{“name”: “Linda Richardson”, “id”: 107, “probation”: false, “department”: “Sales”}\u2019
<\/p>\n\n\n\n
While the output of our code may look just like our original dictionary, our dictionary is now stored as a string. 
<\/p>\n\n\n\n
Formatting a JSON String<\/h2>\n\n\n\n
The json.dumps()<\/code> method comes with a few parameters that you can use to make it easier to read the final string created by the method.
<\/p>\n\n\n\n
The indent<\/code> parameter allows you to define the number of indents that appear in the final JSON string. Suppose you want to add four indents to each line on your JSON string. You could do so using the following json.dumps()<\/code> statement:
<\/p>\n\n\n\n
employee_json = json.dumps(employee, indent=4)\n<\/pre><\/div>\n\n\n\n
This statement, when combined with our last example, would return:
<\/p>\n\n\n\n
{\n    \"name\": \"Linda Richardson\",\n    \"id\": 107,\n    \"probation\": false,\n    \"department\": \"Sales\"\n}\n<\/pre><\/div>\n\n\n\n
You can also change the separators of the data in the JSON string. The default values for the separators are \u201c, \u201d and \u201c: \u201d, which means that every object will be separated using a comma, and every key and value will be separated using a colon.
<\/p>\n\n\n\n
Suppose we want our keys and values to be separated using an equals sign (=), and we want to use an indent of 4. We could do so using this statement:
<\/p>\n\n\n\n
employee_json = json.dumps(employee, indent=4, separators=(\", \", \" = \"))\n<\/pre><\/div>\n\n\n\n
Our code returns:
<\/p>\n\n\n\n
{\n    \"name\" = \"Linda Richardson\", \n    \"id\" = 107, \n    \"probation\" = false, \n    \"department\" = \"Sales\"\n}\n<\/pre><\/div>\n\n\n\n
As you can see, every key and value in our JSON string is now separated using an equals sign.
<\/p>\n\n\n\n
Read a JSON File<\/h2>\n\n\n\n
To read a JSON file in Python, you can use json.load()<\/code>. This method accepts one parameter: the file object that you want to read in your program.
<\/p>\n\n\n\n
Suppose we have a file called employee.json that we want to load into our program. The contents of this file are as follows:
<\/p>\n\n\n\n
{\"name\": \"Linda Richardson\", \"id\": 107, \"probation\": false}\n<\/pre><\/div>\n\n\n\n
We could do so using this code:
<\/p>\n\n\n\n
{\"name\": \"Linda Richardson\", \"id\": 107, \"probation\": false}\nWe could do so using this code:\nimport json\nwith open('employee.json') as final_file:\n\temployee = json.load(final_file)\nprint(employee)\n<\/pre><\/div>\n\n\n\n
Our code returns:
<\/p>\n\n\n\n
{“name”: “Linda Richardson”, “id”: 107, “probation”: false}
<\/p>\n\n\n\n
In this code, we first import the json library. Then, we use a with<\/code> statement to read our employee.json<\/code> file. We use the json.load() <\/code>method to convert the contents of our file, stored in the file<\/code> variable, to a dictionary. Then, we print out the value of our dictionary.
<\/p>\n\n\n\n
Write JSON to a File<\/h2>\n\n\n\n
You can use the json.dump()<\/code> method to write JSON to a file in Python.
<\/p>\n\n\n\n
The json.dump()<\/code> method accepts two parameters: the dictionary you want to write to a file, and the file object that you want to write your dictionary.
<\/p>\n\n\n\n
Suppose we want to save our employee\u2019s record as a JSON value in a file. The name of this file should be linda_employee.json<\/code>. We could do so using the following code:
<\/p>\n\n\n\n
import json\nemployee = {\n\t\"name\": \"Linda Richardson\",\n\t\"id\": 107,\n\t\"probation\": False,\n\t\"department\": \"Sales\"\n}\nwith open('linda_employee.json', 'w') as final_file:\n\tjson.dump(employee, final_file)\n<\/pre><\/div>\n\n\n\n
Let\u2019s break down our code. First, we import the json module into our program. Then, we declare a variable which stores information about an employee called Linda Richardson in a dictionary structure.
<\/p>\n\n\n\n
Next, we use a \u201cwith\u201d statement with the \u201cw\u201d flag to prepare a file called linda_employee.json<\/code> to which we can write. We then use json.dump() <\/code>to convert our employee<\/code> dictionary to a JSON string and to save it to our final_file<\/code> object.
<\/p>\n\n\n\n
When this program is run, the contents of our employee<\/code> dictionary are written to the linda_employee.json<\/code> file. The final contents of this file are:
<\/p>\n\n\n\n
{\"name\": \"Linda Richardson\", \"id\": 107, \"probation\": false, \"department\": \"Sales\"}
<\/code><\/p>\n\n\n\n
Conclusion<\/h2>\n\n\n\n
The Python json module allows you to read and manipulate JSON data.
<\/p>\n\n\n\n
Using the json module, you can:
<\/p>\n\n\n\n