python中configparser读取配置文件的大小写和重复项问题
6,972 阅读
使用配置文件控制程序的运行是一种非常常见的编程技巧，因此配置文件的解析是所有编程语言中都不可缺少的模块。在Python中，通常使用configparser模块进行配置文件解析。但是configparser解析配置文件有几个常见问题：读取当前项目下某个位置的配置文件、重复配置项的处理以及大小写配置项的读取。本文将描述如何解决这三个问题。
加载中...
加载中...
测试环境如下：
CPU：Intel(R) Core(TM) i5-8600K CPU @ 3.60GHz 3.60 GHz 内存：32.0 GB（其中一个还是国产长鑫内存颗粒的16G，效果不错，哈哈哈）
windows10 21H1
3.7（2.X的版本不建议用了，3.X的版本也建议升级到3.8以上使用，毕竟安全和新特性还是要关注）
F:/OneDrive/Programs
|-python_ai
|-test
|-config_parser_test.py
|config.ini
本项目名称是python_ai，路径在F:/OneDrive/Programs下，项目中包含一个包路径test，下面有一个config_parser_test.py文件，还包含一个配置文件config.ini，与test包同级别。
配置文件内容如下：
[test]
config = a
CONFIG = b
这里我们提供的分类配置，包含一个test节点，该节点下包含两个配置项：config1与CONFIG，这两个配置项完全一样，只是大小写不同。
下面我们看问题。
一般来说，配置文件都放在项目中某个位置，所以一般都是获取项目目录之后再根据项目结构来读取配置文件。但是项目位置我们一般不会固定，所以最好的思路是根据当前执行文件所在的位置来确定项目位置。在python中，可以在不同的其实位置执行python脚本，这些会影响到当前项目或者当前目录的获取，但是脚本的绝对路径是不会错的，所以我们先获取脚本绝对路径，再根据项目目录获取配置文件路径是比较可靠的。
因此，本例中读取项目配置文件真实地址代码如下：
import os
from os.path import dirname
# __file__是python内置的获取当前文件所在路径的变量，但是返回的有时候是相对路径，有的时候是绝对路径，使用os.path.realpath可以获取绝对路径
script_path = os.path.realpath(__file__)
# 根据项目结构我们知道本脚本在test包下，因此项目路径是父目录的父目录，需要两个dirname()
project_path = dirname(dirname(script_path))
# 根据项目结构，获取配置文件路径
config_path = os.path.join(project_path, "config.ini")
print(f"script filepath: {script_path}")
print(f"project filepath: {project_path}")
print(f"config filepath: {project_path}")
本项目中，上述打印结果：
script filepath: F:\OneDrive\Programs\python_ai\test\config_parser_test.py
project filepath: F:\OneDrive\Programs\python_ai
config filepath: F:\OneDrive\Programs\python_ai
默认情况下，configparser读取配置文件的时候是不允许重复项存在的。在本例中，我们特意在test下构造了两个重复的配置项（默认情况下，配置项的key大小写是被忽略的，所以我们这里目前默认可以当作是两个相同的配置项）。直接采用configparser解析这个文件会报错：
# 代码接着前面
import configparser
config = configparser.ConfigParser()
config.read(config_path)
运行这段代码会报错：
Traceback (most recent call last):
File "F:/OneDrive/Programs/python_ai/test/config_parser_test.py", line 17, in <module>
config.read(config_path)
File "D:\Program Files\Python3.7\lib\configparser.py", line 696, in read
self._read(fp, filename)
File "D:\Program Files\Python3.7\lib\configparser.py", line 1091, in _read
fpname, lineno)
configparser.DuplicateOptionError: While reading from 'F:\\OneDrive\\Programs\\python_ai\\config.ini' [line 3]: option 'config' in section 'test' already exists
它提示，在test下面，config配置项已经存在了，现在读取到2个，会报错。如果不希望报错，直接采用新的配置项覆盖，那么需要在configparser.ConfigParser(strict=False)方法中strict参数设置未False，改成如下代码：
config = configparser.ConfigParser(strict=False)
这样可以顺利读取包含重复配置项的文件，当然，这个配置项的输出是b，因为b是最新的会覆盖旧的。当然，这个参数还是控制是否允许小节的出现的。这不是本文重点。不说了。这个配置项在python3.2之前是默认False的，但是由于安全等原因，现在都是默认True。
大小写配置项也是一个非常容易被忽略的问题。configparser默认是将所有的key转换成小写的，读取的时候，也会默认将任何要获取的key转换成小写进行。所以以下几种情况，只有一种会出现问题：
这里的代码循环key大写是什么意思呢？比如有如下一种情况，你需要通过配置项获取对数据中每一列的处理，配置项中的key表明是列名，value表示对这列的处理。默认情况下，例如pandas.DataFrame对列名是大小写敏感的。这时候你要循环configparser读取的列，且列名是大写，进行处理就会报错。因为，configparser读取了配置项之后所有的key都是小写了，这时候你要是通过key读取配置还是能获取到对应的value，但是如果你想循环读取configparser中的key，那么所有的key都是小写。我们用如下代码测试：
config = configparser.ConfigParser(strict=False)
config.read(config_path)
for config_key in config["test"]:
print(f"{config_key}:{config['test'].get(config_key)}")
我们循环输出test节点下的key，可以看到只会打印出config一个小写的key。
config:b
尽管我们配置项如下：
[test]
config = a
CONFIG = b
尽管这个config["test"].get("CONFIG")还会输出b，尽管config["test"].get("config")也是输出b（首先这里用第二个config覆盖了第一个，同时它将CONFIG大写转成小写，所以这两个输出都是b），但实际上循环key的时候是娶不到CONFIG原始的大写的。
如果你希望区分大小写应采用如下写法：
config = configparser.ConfigParser(strict=False)
# -----------加上这下面一行就可以区分大小写-----------
config.optionxform = str
# -----------加上这上面一行就可以区分大小写-----------
config.read(config_path)
for config_key in config["test"]:
print(f"{config_key}:{config['test'].get(config_key)}")
这时候输出如下：
config:a
CONFIG:b
以上就python中configparser的三个简单却很实用的小问题。欢迎关注https://www.datalearner.com/ 获取最新的编程、人工智能、学术信息。