prettyjson怎么用

轻松美化你的JSON数据：prettyjson使用指南

在开发过程中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，被广泛应用于前后端数据交互、配置文件存储等场景，直接输出或查看未经格式化的JSON数据时，往往会遇到代码压缩、无缩进、换行混乱的问题，不仅难以阅读，还容易因手动修改出错，一个可靠的JSON格式化工具就显得尤为重要。prettyjson就是这样一个简单易用的Python库，能将杂乱的JSON数据一键转换为结构清晰、层级分明的“美化”格式，本文将详细介绍prettyjson的安装、核心功能及使用方法,帮助你高效处理JSON数据。

什么是prettyjson？

prettyjson是一个专为Python设计的JSON格式化工具，它的核心功能是将压缩的JSON字符串或文件转换为“美化”后的格式——通过合理的缩进、换行和空格，让JSON数据的结构（如对象、数组、键值对）一目了然，与Python内置的json模块相比，prettyjson在保持功能简洁的同时，提供了更友好的输出效果和更便捷的使用方式，尤其适合在终端调试、日志查看或配置文件编辑中使用。

安装prettyjson

在使用prettyjson之前，需要先通过pip进行安装，打开终端或命令行工具，执行以下命令：

pip install prettyjson

安装完成后，即可在Python脚本中导入使用：

import prettyjson

prettyjson核心功能与使用方法

prettyjson的核心功能是将JSON数据转换为格式化字符串，并支持直接输出到终端或文件,以下是常见使用场景的详细说明：

格式化JSON字符串

当你有一个未经格式化的JSON字符串时，可以使用prettyjson.dumps()方法将其转换为美化后的字符串，该方法与Python内置json.dumps()的用法类似，但默认更简洁易读。

示例：

import prettyjson
# 压缩的JSON字符串
ugly_json = '{"name":"Alice","age":25,"is_student":false,"courses":["math","physics"],"info":{"gender":"female","city":"New York"}}'
# 使用prettyjson格式化
pretty_json = prettyjson.dumps(ugly_json)
print(pretty_json)

输出效果：

{
    "name": "Alice",
    "age": 25,
    "is_student": false,
    "courses": [
        "math",
        "physics"
    ],
    "info": {
        "gender": "female",
        "city": "New York"
    }
}

可以看到，prettyjson自动为JSON对象添加了缩进（默认4个空格），对数组、嵌套对象进行了换行处理,使结构清晰可辨。

自定义格式化样式

prettyjson.dumps()支持通过参数调整格式化效果，满足个性化需求：

• indent：设置缩进空格数，默认为4，可修改为2、8等（如indent=2）。
• sort_keys：是否对JSON对象的键进行排序（默认为False，设为True可按字母顺序排序键）。
• ensure_ascii：是否确保输出为ASCII字符（默认为False，支持中文等非ASCII字符直接显示）。

示例：

import prettyjson
ugly_json = '{"name":"Bob","age":30,"city":"北京","hobbies":["reading","coding"]}'
# 自定义缩进为2，并对键排序
pretty_json = prettyjson.dumps(
    ugly_json,
    indent=2,
    sort_keys=True,
    ensure_ascii=False  # 支持中文显示
)
print(pretty_json)

输出效果：

{
  "age": 30,
  "city": "北京",
  "hobbies": [
    "reading",
    "coding"
  ],
  "name": "Bob"
}

通过indent=2减少了缩进宽度，sort_keys=True让键按字母顺序排列，ensure_ascii=False确保中文正常显示,灵活性十足。

格式化JSON文件

在实际开发中，我们常需要处理存储在文件中的JSON数据（如config.json、response.json）。prettyjson提供了便捷的文件格式化方法，支持直接读取文件并输出美化后的结果。

示例：假设有一个data.json为：

{"id":1,"title":"Python教程","author":"John","chapters":[{"title":"基础语法","pages":50},{"title":"进阶技巧","pages":80}]}

使用prettyjson格式化文件：

import prettyjson
# 读取并格式化JSON文件
with open("data.json", "r", encoding="utf-8") as f:
    json_data = f.read()
pretty_json = prettyjson.dumps(json_data, indent=4)
# 将格式化结果写入新文件或直接打印
with open("data_pretty.json", "w", encoding="utf-8") as f:
    f.write(pretty_json)
print("文件格式化完成，结果已保存至 data_pretty.json")

生成的data_pretty.json

{
    "id": 1,: "Python教程",
    "author": "John",
    "chapters": [
        {
            "title": "基础语法",
            "pages": 50
        },
        {
            "title": "进阶技巧",
            "pages": 80
        }
    ]
}

python -c "import prettyjson; print(prettyjson.dumps(''{\"key\":\"value\",\"array\":[1,2,3]}'))"

{
    "key": "value",
    "array": [
        1,
        2,
        3
    ]
}