兄弟们做 Python 开发的谁没写过 ini 配置文件自带的configparser不用装依赖开箱即用简直不要太方便但是今天我必须给你泼一盆冷水这个用了十几年的老库藏了 9 个反人类的坑稍不注意就踩雷今天我把这些坑全扒出来每个都给你演示全是从 Python 官方文档抠出来的实锤还实际跑了测试脚本验证保证 100% 准确看完你再也不会被它坑了1. 你写的大写键它偷偷给你转成小写了坑点现场你是不是写配置的时候习惯把端口写成Port数据库名写成DB_Name比如你有个db.ini[mysql] Port 3306 DB_Name test_db然后你写代码读importconfigparser cfgconfigparser.ConfigParser()cfg.read(db.ini)print(cfg[mysql].keys())# 输出dict_keys([port, db_name])我靠我明明写的大写怎么存进去全变小写了哦对了默认情况下不管你用大写还是小写读都能读到值 —— 因为它会把你输入的键也转成小写再查所以不会报错。但是如果你把配置改了之后写回去原来的大写键全变成小写了比如你原来的配置里是Port、DB_Name写完之后直接变成了[mysql] port 3306 db_name test_db合着我精心写的大小写格式你说改就改要是你用 git 管理配置文件这一下就给你改了一堆文件的内容diff 全是变更烦死了为啥会这样官方说了默认情况下configparser为了让你大小写不敏感访问—— 比如你写Port还是port都能读到所以它有个默认的optionxform函数会把所有键名都转成小写结果就是不管你配置里写的啥大小写读出来存的全是小写写回去也全是小写怎么解决一行代码搞定把这个转换函数改成原样返回就行cfg.optionxformstr就这么简单加了这行之后键名就完全保持你写的样子了大写就是大写小写就是小写这个方法全版本通用不管你是 Python3.2 还是最新的 3.13都能用放心用2. 节名大小写敏感键名却不敏感搞混了讲完键的大小写问题还有一个更迷惑的坑等着你节名和键名的大小写敏感居然不一样坑点现场这个坑很容易搞混一会敏感一会不敏感头都大了比如你写了两个节[DB] host 127.0.0.1 [db] host 192.168.1.1你以为这是一个节不对节名是大小写敏感的这是两个完全不同的节然后键名呢你在同一个节里写Port 3306 port 3307你以为这是两个键不对默认情况下键名会转小写所以这两个会变成同一个键而且更坑的是这时候不会像你想的那样后面的覆盖前面的而是直接给你抛个重复键的报错哦说到这里这就引出了我们的下一个坑点重复键的问题3. 重复键默认直接报错刚才我们说到大小写不同的键会因为转小写变成同一个然后触发重复键的报错其实这就是重复键坑的一个典型场景。坑点现场你是不是有时候配置里不小心写了重复的键比如[app] port 5000 port 5001你以为后面的会覆盖前面的不对默认情况下它直接给你抛DuplicateOptionError说你有重复的键还有重复的节也是一样直接报错为啥会这样因为从 Python3.2 开始strict参数默认是True就是严格检查重复的键和节防止你写错。老版本的话默认是False会自动覆盖所以很多人习惯了结果新版本直接报错。怎么解决如果你想要老版本的行为重复的键自动覆盖初始化的时候把strict设成False就行cfgconfigparser.ConfigParser(strictFalse)不过官方推荐还是开着strict毕竟重复键一般都是你写错了早点报错早点改。4. [DEFAULT] 节是个老六偷偷给你塞默认值搞定了大小写和重复键的问题还有一个藏得很深的老六坑就是\[DEFAULT\]节坑点现场你是不是用过\[DEFAULT\]节以为它就是个普通的默认节给没找到的键用不对它是个老六它会把自己的键偷偷塞到所有的节里比如你有个配置[DEFAULT] timeout 30 [mysql] host 127.0.0.1 [redis] host 127.0.0.1你看DEFAULT里有个timeout30然后mysql和redis里都没写。然后你读mysql的timeout你以为没有这个键所以你写了个fallback默认值timeoutcfg.get(mysql,timeout,fallback10)你以为会返回 10 对不对不对它返回 30因为DEFAULT的键会自动加到所有的节里优先级比你给的fallback还高更坑的是你要是删mysql的timeout键delcfg[mysql][timeout]你以为删完了结果你再读还是 30因为它又把DEFAULT的给你露出来了你根本删不掉除非你删DEFAULT里的怎么解决首先[DEFAULT]别乱加键只放真正所有节都要用的全局配置别啥都往里面塞其次如果你想判断某个键是不是当前节自己的不是DEFAULT塞进来的用has_optionifcfg.has_option(mysql,timeout):# 这个是mysql自己的键不是DEFAULT的else:# 要么是DEFAULT的要么真没有这样就能区分开了不会被老六坑了。5. 没有 Section直接报错给你看讲完了节的基础问题再来说说最基础的配置格式问题你是不是有时候想写个超简单的配置就几个键值对不想加什么花里胡哨的[section]比如你写了个simple.ini# 我就想这么写简单点不行吗 name test port 5000结果你一读直接给你抛个大错configparser.MissingSectionHeaderError: File contains no section headers. file: stdin, line: 1 name test\n哦合着我写个键值对还犯法了必须要包个节为啥会这样老版本的configparser就是这么死脑筋它默认认为所有的键必须属于某个section不然它根本不认这也是 INI 文件的传统格式但是有时候我们就是想写个简单的配置不想加节啊怎么解决分情况如果你用的是 Python3.13最新版本终于加了个allow_unnamed_section参数开了它就能支持这种无节的裸键值了cfgconfigparser.ConfigParser(allow_unnamed_sectionTrue)cfg.read(simple.ini)# 读的时候用 UNNAMED_SECTION 这个常量来读顶层的键print(cfg[configparser.UNNAMED_SECTION][name])# 输出test完美终于不用加节了如果你用的是老版本没办法只能乖乖加个默认节比如[main] name test port 5000然后读的时候从main里读就行虽然麻烦点但是能跑。6. 所有值都是字符串你以为的 False 其实是 True搞定了节的问题再来说说值的问题这个坑刚学 Python 的时候最容易踩比如你配置里写[app] debug False port 5000然后你读出来debugcfg[app][debug]print(type(debug))# 输出class str哦是字符串那你要是写ifdebug:print(开启调试模式)结果你发现哪怕你配置里写的是False它也进了 if分支因为字符串False非空啊布尔判断就是 True 啊我靠这谁顶得住还有port你以为是整数结果是字符串5000;你要是拿去做运算比如port 1直接报错字符串不能加整数为啥会这样因为configparser把配置里的所有值默认都当成字符串读不管你写的是数字还是布尔全是字符串怎么解决别自己强转用它自带的类型转换方法它早就给你做好了# 读整数自动转成intportcfg.getint(app,port)# 读浮点数自动转成floatratecfg.getfloat(app,rate)# 读布尔值这个最坑一定要用这个debugcfg.getboolean(app,debug)这个getboolean牛的地方是它能识别各种写法比如yes/no、on/off、true/false、1/0不管大小写比如你写FALSE、False、false它都能识别成False不会像你自己bool(False)那样搞错要是你有自定义的类型比如时间啥的Python3.5 之后还能自己注册转换器不过一般用自带的这几个就够了。7. 读多个配置文件它偷偷忽略不存在的文件接下来是读取配置的时候的坑你是不是想把基础配置和本地覆盖配置分开比如base.ini是公共的local\.ini是每个人自己的然后你这么读cfg.read([base.ini,local.ini])你以为它会把两个文件合并local里有的就覆盖base的没有的就用base的哦这个倒是对的但是如果local.ini不存在呢比如你文件名写错了或者你同事的电脑上有你的没有你以为它会报错说找不到文件不对它直接静默忽略了连个警告都没有你还以为你加载了local的配置结果其实只加载了base的你改了半天local\.ini发现根本没生效找了半天原因才发现文件名写错了它根本没告诉你怎么解决对于必须要加载的文件别用read用read_file这个找不到会直接报错你能及时发现# 必须加载的基础配置找不到就报错withopen(base.ini,encodingutf-8)asf:cfg.read_file(f)# 可选的本地覆盖配置找不到也没关系cfg.read(local.ini)这样就完美了必须的文件找不到就炸你能马上知道可选的找不到也不影响。8. 你写的注释改完配置全没了然后是注释的坑这个很多人都踩过你是不是在配置里写了很多注释方便自己看比如[mysql] # 数据库地址生产环境要改不要乱改 host 127.0.0.1 # 端口默认3306 port 3306然后你用configparser改了个port然后write回去withopen(db.ini,w)asf:cfg.write(f)结果你打开文件一看我靠所有的注释全没了变成了[mysql] host 127.0.0.1 port 3306合着我写了半天的说明全没了还有更坑的行内注释比如你写port 3306 # 数据库端口默认情况下这个#后面的内容不会被当成注释会被当成port的值的一部分你读出来的port就是3306 # 数据库端口;转整数直接报错为啥会这样因为configparser根本不保存注释它解析的时候直接把注释扔了你写回去的时候自然就没了官方文档都明说了原始配置文件中的注释在写回配置时不会被保留。怎么解决首先别指望用configparser改完配置还能保留注释它做不到要是你需要保留注释要么别用它改配置要么换别的库比如configobj之类的。其次行内注释的话你可以初始化的时候开inline_comment_prefixes比如cfgconfigparser.ConfigParser(inline_comment_prefixes(#,;))不过官方不推荐这么干容易出问题比如你密码里本来就有#那就会被截断了慎用9. 无值的键默认不认然后是特殊配置的坑比如 mysql 的配置里经常有这种[mysqld] skip-external-locking skip-name-resolve就是这种只有键没有等号和值用来表示开启某个选项。结果你用默认的configparser读直接报错说解析错误怎么解决初始化的时候开allow_no_valueTrue就行这个是 Python3.2 之后就有的功能cfgconfigparser.ConfigParser(allow_no_valueTrue)开了之后这种无值的键读出来就是None你可以判断if skip-external-locking in cfg[mysqld]就知道有没有开了完美最后说两句其实configparser作为 Python 自带的老配置库虽然能用但是藏了太多的历史包袱各种默认行为反直觉踩坑无数。如果你是新项目我更推荐你用现代化的配置库比如configobj它原生支持保留注释、自动类型转换、无节配置这些功能根本不用踩这么多坑用起来舒服多了要是大家对configobj的保姆级教程感兴趣评论区告诉我人数多的话我专门出一期教你怎么用它搞定所有配置问题
别被configparser坑了！Python配置库避坑指南
兄弟们做 Python 开发的谁没写过 ini 配置文件自带的configparser不用装依赖开箱即用简直不要太方便但是今天我必须给你泼一盆冷水这个用了十几年的老库藏了 9 个反人类的坑稍不注意就踩雷今天我把这些坑全扒出来每个都给你演示全是从 Python 官方文档抠出来的实锤还实际跑了测试脚本验证保证 100% 准确看完你再也不会被它坑了1. 你写的大写键它偷偷给你转成小写了坑点现场你是不是写配置的时候习惯把端口写成Port数据库名写成DB_Name比如你有个db.ini[mysql] Port 3306 DB_Name test_db然后你写代码读importconfigparser cfgconfigparser.ConfigParser()cfg.read(db.ini)print(cfg[mysql].keys())# 输出dict_keys([port, db_name])我靠我明明写的大写怎么存进去全变小写了哦对了默认情况下不管你用大写还是小写读都能读到值 —— 因为它会把你输入的键也转成小写再查所以不会报错。但是如果你把配置改了之后写回去原来的大写键全变成小写了比如你原来的配置里是Port、DB_Name写完之后直接变成了[mysql] port 3306 db_name test_db合着我精心写的大小写格式你说改就改要是你用 git 管理配置文件这一下就给你改了一堆文件的内容diff 全是变更烦死了为啥会这样官方说了默认情况下configparser为了让你大小写不敏感访问—— 比如你写Port还是port都能读到所以它有个默认的optionxform函数会把所有键名都转成小写结果就是不管你配置里写的啥大小写读出来存的全是小写写回去也全是小写怎么解决一行代码搞定把这个转换函数改成原样返回就行cfg.optionxformstr就这么简单加了这行之后键名就完全保持你写的样子了大写就是大写小写就是小写这个方法全版本通用不管你是 Python3.2 还是最新的 3.13都能用放心用2. 节名大小写敏感键名却不敏感搞混了讲完键的大小写问题还有一个更迷惑的坑等着你节名和键名的大小写敏感居然不一样坑点现场这个坑很容易搞混一会敏感一会不敏感头都大了比如你写了两个节[DB] host 127.0.0.1 [db] host 192.168.1.1你以为这是一个节不对节名是大小写敏感的这是两个完全不同的节然后键名呢你在同一个节里写Port 3306 port 3307你以为这是两个键不对默认情况下键名会转小写所以这两个会变成同一个键而且更坑的是这时候不会像你想的那样后面的覆盖前面的而是直接给你抛个重复键的报错哦说到这里这就引出了我们的下一个坑点重复键的问题3. 重复键默认直接报错刚才我们说到大小写不同的键会因为转小写变成同一个然后触发重复键的报错其实这就是重复键坑的一个典型场景。坑点现场你是不是有时候配置里不小心写了重复的键比如[app] port 5000 port 5001你以为后面的会覆盖前面的不对默认情况下它直接给你抛DuplicateOptionError说你有重复的键还有重复的节也是一样直接报错为啥会这样因为从 Python3.2 开始strict参数默认是True就是严格检查重复的键和节防止你写错。老版本的话默认是False会自动覆盖所以很多人习惯了结果新版本直接报错。怎么解决如果你想要老版本的行为重复的键自动覆盖初始化的时候把strict设成False就行cfgconfigparser.ConfigParser(strictFalse)不过官方推荐还是开着strict毕竟重复键一般都是你写错了早点报错早点改。4. [DEFAULT] 节是个老六偷偷给你塞默认值搞定了大小写和重复键的问题还有一个藏得很深的老六坑就是\[DEFAULT\]节坑点现场你是不是用过\[DEFAULT\]节以为它就是个普通的默认节给没找到的键用不对它是个老六它会把自己的键偷偷塞到所有的节里比如你有个配置[DEFAULT] timeout 30 [mysql] host 127.0.0.1 [redis] host 127.0.0.1你看DEFAULT里有个timeout30然后mysql和redis里都没写。然后你读mysql的timeout你以为没有这个键所以你写了个fallback默认值timeoutcfg.get(mysql,timeout,fallback10)你以为会返回 10 对不对不对它返回 30因为DEFAULT的键会自动加到所有的节里优先级比你给的fallback还高更坑的是你要是删mysql的timeout键delcfg[mysql][timeout]你以为删完了结果你再读还是 30因为它又把DEFAULT的给你露出来了你根本删不掉除非你删DEFAULT里的怎么解决首先[DEFAULT]别乱加键只放真正所有节都要用的全局配置别啥都往里面塞其次如果你想判断某个键是不是当前节自己的不是DEFAULT塞进来的用has_optionifcfg.has_option(mysql,timeout):# 这个是mysql自己的键不是DEFAULT的else:# 要么是DEFAULT的要么真没有这样就能区分开了不会被老六坑了。5. 没有 Section直接报错给你看讲完了节的基础问题再来说说最基础的配置格式问题你是不是有时候想写个超简单的配置就几个键值对不想加什么花里胡哨的[section]比如你写了个simple.ini# 我就想这么写简单点不行吗 name test port 5000结果你一读直接给你抛个大错configparser.MissingSectionHeaderError: File contains no section headers. file: stdin, line: 1 name test\n哦合着我写个键值对还犯法了必须要包个节为啥会这样老版本的configparser就是这么死脑筋它默认认为所有的键必须属于某个section不然它根本不认这也是 INI 文件的传统格式但是有时候我们就是想写个简单的配置不想加节啊怎么解决分情况如果你用的是 Python3.13最新版本终于加了个allow_unnamed_section参数开了它就能支持这种无节的裸键值了cfgconfigparser.ConfigParser(allow_unnamed_sectionTrue)cfg.read(simple.ini)# 读的时候用 UNNAMED_SECTION 这个常量来读顶层的键print(cfg[configparser.UNNAMED_SECTION][name])# 输出test完美终于不用加节了如果你用的是老版本没办法只能乖乖加个默认节比如[main] name test port 5000然后读的时候从main里读就行虽然麻烦点但是能跑。6. 所有值都是字符串你以为的 False 其实是 True搞定了节的问题再来说说值的问题这个坑刚学 Python 的时候最容易踩比如你配置里写[app] debug False port 5000然后你读出来debugcfg[app][debug]print(type(debug))# 输出class str哦是字符串那你要是写ifdebug:print(开启调试模式)结果你发现哪怕你配置里写的是False它也进了 if分支因为字符串False非空啊布尔判断就是 True 啊我靠这谁顶得住还有port你以为是整数结果是字符串5000;你要是拿去做运算比如port 1直接报错字符串不能加整数为啥会这样因为configparser把配置里的所有值默认都当成字符串读不管你写的是数字还是布尔全是字符串怎么解决别自己强转用它自带的类型转换方法它早就给你做好了# 读整数自动转成intportcfg.getint(app,port)# 读浮点数自动转成floatratecfg.getfloat(app,rate)# 读布尔值这个最坑一定要用这个debugcfg.getboolean(app,debug)这个getboolean牛的地方是它能识别各种写法比如yes/no、on/off、true/false、1/0不管大小写比如你写FALSE、False、false它都能识别成False不会像你自己bool(False)那样搞错要是你有自定义的类型比如时间啥的Python3.5 之后还能自己注册转换器不过一般用自带的这几个就够了。7. 读多个配置文件它偷偷忽略不存在的文件接下来是读取配置的时候的坑你是不是想把基础配置和本地覆盖配置分开比如base.ini是公共的local\.ini是每个人自己的然后你这么读cfg.read([base.ini,local.ini])你以为它会把两个文件合并local里有的就覆盖base的没有的就用base的哦这个倒是对的但是如果local.ini不存在呢比如你文件名写错了或者你同事的电脑上有你的没有你以为它会报错说找不到文件不对它直接静默忽略了连个警告都没有你还以为你加载了local的配置结果其实只加载了base的你改了半天local\.ini发现根本没生效找了半天原因才发现文件名写错了它根本没告诉你怎么解决对于必须要加载的文件别用read用read_file这个找不到会直接报错你能及时发现# 必须加载的基础配置找不到就报错withopen(base.ini,encodingutf-8)asf:cfg.read_file(f)# 可选的本地覆盖配置找不到也没关系cfg.read(local.ini)这样就完美了必须的文件找不到就炸你能马上知道可选的找不到也不影响。8. 你写的注释改完配置全没了然后是注释的坑这个很多人都踩过你是不是在配置里写了很多注释方便自己看比如[mysql] # 数据库地址生产环境要改不要乱改 host 127.0.0.1 # 端口默认3306 port 3306然后你用configparser改了个port然后write回去withopen(db.ini,w)asf:cfg.write(f)结果你打开文件一看我靠所有的注释全没了变成了[mysql] host 127.0.0.1 port 3306合着我写了半天的说明全没了还有更坑的行内注释比如你写port 3306 # 数据库端口默认情况下这个#后面的内容不会被当成注释会被当成port的值的一部分你读出来的port就是3306 # 数据库端口;转整数直接报错为啥会这样因为configparser根本不保存注释它解析的时候直接把注释扔了你写回去的时候自然就没了官方文档都明说了原始配置文件中的注释在写回配置时不会被保留。怎么解决首先别指望用configparser改完配置还能保留注释它做不到要是你需要保留注释要么别用它改配置要么换别的库比如configobj之类的。其次行内注释的话你可以初始化的时候开inline_comment_prefixes比如cfgconfigparser.ConfigParser(inline_comment_prefixes(#,;))不过官方不推荐这么干容易出问题比如你密码里本来就有#那就会被截断了慎用9. 无值的键默认不认然后是特殊配置的坑比如 mysql 的配置里经常有这种[mysqld] skip-external-locking skip-name-resolve就是这种只有键没有等号和值用来表示开启某个选项。结果你用默认的configparser读直接报错说解析错误怎么解决初始化的时候开allow_no_valueTrue就行这个是 Python3.2 之后就有的功能cfgconfigparser.ConfigParser(allow_no_valueTrue)开了之后这种无值的键读出来就是None你可以判断if skip-external-locking in cfg[mysqld]就知道有没有开了完美最后说两句其实configparser作为 Python 自带的老配置库虽然能用但是藏了太多的历史包袱各种默认行为反直觉踩坑无数。如果你是新项目我更推荐你用现代化的配置库比如configobj它原生支持保留注释、自动类型转换、无节配置这些功能根本不用踩这么多坑用起来舒服多了要是大家对configobj的保姆级教程感兴趣评论区告诉我人数多的话我专门出一期教你怎么用它搞定所有配置问题
