以前搞Java的时候,就有专门读取配置文件的类,好像是什么Property这种吧,记不太清了,最近用Python,想着有没有现成的可以用,就找了下,还有真有,就是这个ConfigParser。
在日常使用中,我们经常会有一些.ini,.cnf这类配置文件,configparser可以用来读取配置文件
准备工作
我们得先准备一个配置文件,就叫demo.ini好了,内容直接粘过来的,可以参考最后的参考文档,
[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes
[bitbucket.org]
User = hg
[topsecret.server.com]
Port = 50022
ForwardX11 = no
INI文件,是Windows系统下一种规范的配置文件,它有一些默认的规范,比如[XXX]表示一节,可以当做是某个模块,比如上面,我们就有3个模块,一个是[DEFAULT],一个是[bitbucket.org],一个是[topsecret.server.com],每一节下面都有key=value这种参数。
读取配置文件
好了,这里,我们就开始读取配置文件了,就算不使用这个ConfigParser,我们自己去读取文件,然后解析,也是可以的,不过不用重复发明轮子呦,现成的拿来用就好了。
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read('C:\document\python_demo\demo-config\demo.ini')
print(cfg.sections())
很简单,引入包,初始化,然后加载配置文件,然后使用就可以了。
这里输出了两个section,section就是我们上面说的一节,一个模块,一开始我有点儿纳闷那个[DEFAULT]咋没有了,其实这个和一些约定有关,因为default是默认参数,就是说每个section都共用的,所以默认就加载到所有的section中去了,所以我们可以继续输出看看。
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read('C:\document\python_demo\demo-config\demo.ini')
for section_name in cfg.sections():
print('section=',section_name)
for key in cfg[section_name]:
print(key,'=',cfg[section_name][key])
这里,我们遍历每一个section,然后输出里面的配置参数
这里会看到,每个section,都附带了default的参数,而且单独section中的参数是会覆盖default的,当然,我们也可以显是输出default。
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read('C:\document\python_demo\demo-config\demo.ini')
for section_name in cfg.sections():
print('section=',section_name)
for key in cfg[section_name]:
print(key,'=',cfg[section_name][key])
print('default section')
for key in cfg['DEFAULT']:
print(key,'=',cfg['DEFAULT'][key])
一般用,这也就差不多了,还可以参考下最后提供的那个使用文档,下面,分享下使用过程中遇到的问题。
遇到的问题
加载不了文件
一开始写文件路径的时候,使用的 C:\document\python_demo\demo-config\demo.ini,然后有一次发现,文件就在那,但是不去不了,怪了,但是可能嵌套的文件夹比较多,迷茫了半天,发现把路径里面的\改成/就可以了 C:/document/python_demo/demo-config/demo.ini ,这可能是Windows下才会有的坑中文
不可避免的,中文也是一个必须面对的问题,我们先来试下,中文有什么问题。
我们再配置文件找那个,加个中文
[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes
msg = 哇哦,哇哦
[bitbucket.org]
User = hg
[topsecret.server.com]
Port = 50022
ForwardX11 = no
这下,你再执行的话,就会报错了:
一看就知道是编码的问题,一开始没找到在哪去配置这个编码,后来看到函数介绍:
read(filenames, encoding=None)
所以,我们再加载配置文件的时候,加上编码就可以了
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read('C:/document/python_demo/demo-config/demo.ini',encoding='utf-8')
for section_name in cfg.sections():
print('section=',section_name)
for key in cfg[section_name]:
print(key,'=',cfg[section_name][key])
print('default section')
for key in cfg['DEFAULT']:
print(key,'=',cfg['DEFAULT'][key])
再次执行就好了
参考文档
13.10 读取配置文件
Configuration file parser