Python中json.dump的使用方法与示例|极客教程

Python中json.dump的使用方法与示例

1. 简介

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，常用于前后端数据传递和存储。在Python中，我们可以使用json模块来处理JSON数据。其中，json.dump()函数用于将Python对象转换为JSON格式，并将其写入文件。

2. json.dump的基本用法

json.dump(obj, fp, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)

obj: 需要转换为JSON格式的Python对象。
fp: 文件对象，用于写入JSON数据。

示例代码1: 将Python对象转换为JSON格式，并写入文件。

import json

data = {
    "name": "Alice",
    "age": 25,
    "city": "New York"
}

# 打开文件，将JSON数据写入文件
with open("data.json", "w") as f:
    json.dump(data, f)

运行结果1: 在当前目录下生成一个名为data.json的文件，内容如下：

{"name": "Alice", "age": 25, "city": "New York"}

3. 参数说明

skipkeys参数

默认情况下，如果obj中的键不是基本数据类型（str、int、float、bool、None），会抛出TypeError异常。设置skipkeys为True可以跳过这些非基本数据类型的键。

示例代码2: 设置skipkeys参数为True，跳过非基本数据类型的键。

import json

data = {
    "name": "Alice",
    "age": 25,
    "city": "New York",
    "address": {
        "street": "123 Main St",
        "apt": "4B"
    },
    "married": False,
    "hobbies": ["reading", "painting", "music"]
}

# 将数据转换为JSON格式，并设置skipkeys为True
json_data = json.dumps(data, skipkeys=True)

print(json_data)

运行结果2: 输出将非基本数据类型的键跳过的JSON数据。

{"name": "Alice", "age": 25, "city": "New York", "married": false, "hobbies": ["reading", "painting", "music"]}

ensure_ascii参数

默认情况下，当ensure_ascii设置为True时，所有非ASCII字符会被转义为\x的形式。设置为False时，这些字符不会发生转义。

示例代码3: 设置ensure_ascii参数为False，非ASCII字符不转义。

import json

data = {
    "name": "李华",
    "age": 30,
    "city": "北京"
}

# 将数据转换为JSON格式，并设置ensure_ascii为False
json_data = json.dumps(data, ensure_ascii=False)

print(json_data)

运行结果3: 输出非ASCII字符不转义的JSON数据。

{"name": "李华", "age": 30, "city": "北京"}

indent参数

indent参数用于指定缩进的空格数，可读性更好。如果设置为非负整数，则每级缩进会使用指定数量的空格；如果设置为字符串，则该字符串作为空格。

示例代码4: 设置indent参数为4，输出具有缩进的JSON数据。

import json

data = {
    "name": "Tom",
    "age": 28,
    "city": "London"
}

# 将数据转换为JSON格式，并设置indent为4
json_data = json.dumps(data, indent=4)

print(json_data)

运行结果4: 输出具有缩进的JSON数据。

{
    "name": "Tom",
    "age": 28,
    "city": "London"
}

sort_keys参数

默认情况下，转换后的JSON数据中的键是无序的。设置sort_keys为True可以按照键的字母顺序进行排序。

示例代码5: 设置sort_keys参数为True，按照键的字母顺序进行排序。

import json

data = {
    "name": "John",
    "age": 35,
    "city": "Paris"
}

# 将数据转换为JSON格式，并设置sort_keys为True
json_data = json.dumps(data, sort_keys=True)

print(json_data)

运行结果5: 输出按照键的字母顺序进行排序的JSON数据。

{"age": 35, "city": "Paris", "name": "John"}

4. 总结

通过json.dump函数，我们可以将Python对象转换为JSON格式，并将其写入文件。在使用过程中，我们可以根据需要设置一些参数，如skipkeys、ensure_ascii、indent、sort_keys等，以满足不同的转换需求。

Python中json.dump的使用方法与示例