如何使用Python读取INI配置文件并保持原有注释不丢失?

浅强君_9302

浅强君_9302

2026-07-19

709人浏览

原创

会。python原生configparser读写ini时丢失注释、空行和缩进,因只解析键值对;rawconfigparser也无法保留注释;推荐使用configobj库,它专为保留格式设计,支持注释、空行、内联注释等。

如何使用python读取ini配置文件并保持原有注释不丢失?

Python原生configparser读INI会丢注释吗?

会。标准configparser.ConfigParser在read()后再write(),所有注释、空行、原始缩进全部消失——它只解析键值对,不保留文件结构。这不是bug,是设计使然。

用configparser.RawConfigParser + 自定义写入能保注释吗?

不能直接保。即使改用RawConfigParser(避免%变量展开),write()方法仍只输出标准格式。真正可行的方案是:**不依赖write(),改用手动拼接+原文件解析还原**。

  • 先用configparser.ConfigParser读取结构(section/key/value)
  • 再用open()逐行读原文件,用正则或状态机识别注释、空行、section头、key行
  • 修改时只替换对应key的值部分,其余行原样保留
  • 写回时按原顺序输出所有行(含注释)

有没有轻量级第三方库能直接保注释?

有,configobj是目前最成熟的选择。它专为保留格式而设计,支持注释、空行、内嵌注释、续行,且API与configparser高度兼容。

安装:pip install configobj

huaweicloud-python-sdk-helper
huaweicloud-python-sdk-helper

华为云 Python SDK 查询工具。自动发现已安装 SDK 的服务包、Client类、API 方法、入参详情、类信息(__init__ 参数、属性、类型、描述),支持关键字搜索,快速定位目标 API 使用方法。

下载

基本用法:

from configobj import ConfigObj<br>config = ConfigObj('app.ini')<br>config['database']['host'] = '10.0.1.5'<br>config.write()  # 注释和格式全保留

注意:configobj默认不严格校验INI语法(比如允许无引号的value含空格),若需强校验,得配合validate模块;另外它不支持interpolation(如%(...)s),这点和configparser不同。

自己手写解析器要注意哪些坑?

手动维护注释的关键陷阱不在逻辑,而在边界情况:

  • ;和#都算注释符,但#在Windows下可能被误认为无效(某些老工具只认;)
  • 注释可能紧跟在key后:port = 8080 # 推荐端口,这种内联注释必须整体保留整行
  • section名支持空格和特殊字符:[my section]合法,但configparser默认会strip掉方括号外空格,手动解析得原样存
  • 写回时换行符要和原文件一致(\n vs \r\n),否则Git diff会炸

真要自己造轮子,建议优先复用configobj,除非项目禁用第三方依赖或需要极简体积——那种情况下,别碰内联注释,只处理行首注释+空行,复杂度能降一大半。

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4624

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

27377

23

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

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

2023.08.04

3307

5

python eval
python eval

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

2023.08.04

3307

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2583

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习