如何在Python中使用Json库解析带注释或格式不规范的JSON文件?

浅丽同学_9568

浅丽同学_9568

2026-08-06

293人浏览

原创

python原生json模块不支持注释,因json标准(rfc 8259)明确禁止;应改用json5(支持注释、单引号、尾逗号)或commentjson(保留注释位置信息),或用jq预处理脏数据。

如何在python中使用json库解析带注释或格式不规范的json文件?

Python原生json模块无法解析带注释的JSON

直接用json.load()或json.loads()读取含//或/* */注释的文件,会抛出json.decoder.JSONDecodeError——因为JSON标准(RFC 8259)明确不支持注释。这不是bug,是设计如此。别指望改几个参数就能绕过。

常见错误现象:Expecting property name enclosed in double quotes 或 Invalid \escape,其实根源常是注释被当成非法字符解析了。

  • 别手动删注释再读:容易误删字符串里的//(比如URL),也难处理嵌套注释
  • 别用正则粗暴替换:JSON字符串里可能含"//",正则很难安全区分注释与内容
  • 真正可行的是换解析器,或预处理时保留语义结构

用json5库安全读取带注释、单引号、尾逗号的JSON-like文件

json5是JSON的超集,兼容ES5语法,支持注释、单引号字符串、末尾逗号、未加引号的键名等。它不是“修JSON”,而是按另一套规范解析——对配置文件、前端mock数据特别友好。

安装:pip install json5

用法几乎和标准json一致:

import json5
<p>with open("config.json5", "r", encoding="utf-8") as f:
data = json5.load(f)  # 不是 json.load()</p>
  • 支持//行注释和/* */块注释,且能正确跳过字符串内的注释符号
  • 允许{name: "foo"}这种无引号键名(但注意:Python字典键仍是字符串,不会变成变量名)
  • 容忍[1, 2,]末尾逗号,避免git diff污染
  • 性能略低于原生json,但对配置类场景影响可忽略

用commentjson处理已有JSON文件但需保留注释元信息

如果项目要求“读取时知道哪行是注释”,比如做配置校验、生成文档,commentjson能返回带注释位置的AST结构。它底层用pyparsing,比json5重,但提供额外能力。

A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.
A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.

调用 Cutout.Pro 视觉处理 API 进行背景移除、人像抠图和照片增强,支持文件上传与图片 URL 输入。

下载

安装:pip install commentjson

基础用法:

import commentjson
<p>with open("api_spec.json", "r") as f:
data = commentjson.load(f)  # 返回普通dict,注释被丢弃</p>
  • 若需要注释原文,得用commentjson.loads(text, preserve_comments=True),返回特殊对象,含__comment__属性
  • 不支持单引号字符串,只扩展JSON标准(加注释、尾逗号),比json5更保守
  • 遇到NaN、Infinity等非标准值会报错,而json5默认接受

格式严重损坏时:先用jq命令行工具清洗再进Python

当文件混杂HTML标签、BOM头、多余空格、乱码甚至部分缺失括号时,Python库容易崩溃。此时不如交给jq——它专为JSON流设计,容错强、速度快。

示例:清洗并验证一个脏JSON文件

jq -c 'del(.comments)' dirty.json > clean.json
# 或直接管道给Python
cat dirty.json | jq -r '.host + ":" + (.port|tostring)' | python -c "import sys; print('API endpoint:', sys.stdin.read().strip())"
  • jq能自动修复BOM、标准化缩进、删除无效字段,比手写正则可靠得多
  • Windows用户需装jq或用wsl;macOS用brew install jq;Linux多数发行版自带
  • 注意:jq输出默认是纯JSON,无注释,适合后续用原生json加载

真正麻烦的不是注释本身,而是团队把JSON当通用配置格式用,又不统一规范。选json5还是commentjson,取决于你是否需要运行时感知注释——大多数情况,前者够用;真要生成文档或做配置审计,后者才值得引入。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1591

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3804

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1589

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

21957

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2707

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2747

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1103

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2123

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程