Python3读写ini配置文件

作为一名Linux运维工程师，大部分人接触的第一门语言可能都是Shell。而经常写Shell的朋友可能会经常有通过位置参数来进行传参的需求或者习惯。那么想必很多Python初学者都和我一样，一开始也习惯用sys.argv 这种命令让脚本来接收位置参数。比如：Python脚本在运行的时候，接收一个位置参数，这个位置参数是一个文件，然后Python脚本通过open或者with open来读取文件中的内容。这里我就要介绍一下Python读取ini配置文件的方法。

什么是 ini 配置文件？

ini文件即Initialization File初始化文件，在应用程序及框架中常作为配置文件使用，是一种静态纯文本文件，使用记事本即可编辑。使用配置文件的好处在于，不用修改代码文件就可以更改使用的用户、数据库以及日志的配置，避免修改代码带来新的bug，或需要重新打包（如Java项目、Python项目）。

1、ini配置文件基本格式

配置文件的主要功能就是存储一批变量和变量值，在ini文件中使用[章(Section)]对变量进行了分组，基本格式如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


$ cat config.ini
[default]
name=root
password=root#123456
default_env=sit

[mysql]
host=192.168.10.100
port=3306
db=prometheus
user=root
password=prom#123456

[log]
log_file=run.log
log_level=info

上面的[default]、[mysql]、[log]就是 Section。

注意: ini文件中使用#或者;添加注释，建议最好独占一行，不可以写在变量后面.

2、Python读取ini配置文件

读取ini配置文件需要使用Python3自带的configparser库，示例如下:

1
2
3
4


from configparser import ConfigParser   # Python2中是from ConfigParser import ConfigParser
conf = ConfigParser()  # 需要实例化一个ConfigParser对象
conf.read('config.ini')  # 需要添加上config.ini的路径，不需要open打开，直接给文件路径就读取，也可以指定encoding='utf-8'
print(conf['user']['name'])  # 读取user段的name变量的值，字符串格式

conf对象每个section段的数据类似于一个字典，可以使用['变量名'] 或者 .get('变量名')的方法来获取对应的值，获取到的是字符串格式。所以配置文件里是不需要将值用引号引起来的。

其他常用的读取方法如下：

conf.sections(): 获取所有的section名，结果[‘user’, ‘mysql’, ’log’]
conf[‘mysql’][‘port’]: 获取section端port变量的值，字符串格式
conf[‘mysql’].get(‘port’): 同上，字符串格式
conf.get(‘mysql’, ‘port’): 同上，字符串格式
conf[‘mysql’].getint(‘port’): 获取对应变量的整型值
conf[‘mysql’].getfloat(‘port’): 获取对应变量的浮点型值
conf[‘user’].getboolean(‘is_admin’): 获取对应变量的布尔值，支持配置为yes/no, on/‘off, true/false 和 1/0，都可以转化为Python中的True/False
conf.has_section(section)：检查是否有该section
conf.options(section)：输出section中所有的变量名
conf.has_option(section, option)：检查指定section下是否有该变量值

3、遍历section所有变量和值

Python可以像遍历字典意义操作来遍历一个section所有的变量和值

1
2


for key, value in conf['default'].items():
    print(key, value)

注意： ini文件中的变量名是大小写不敏感的，而Section名是大小写敏感的。

4、存在公共变量推荐使用的方式

很多时候我们可能会用配置文件来进行区分环境，特别是我们会用环境明对section来进行命名。那么可能存在很多重复的变量

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


[sit]
; 开发环境
user=admin
password=123456
domain_url=https://www.sit.ayunw.cn

[perf]
; 测试环境
user=admin
password=123456
domain_url=https://www.perf.ayunw.cn

[pre]
; 预生产环境
user=admin
password=123456
domain_url=https://www.pre.ayunw.cn

[pro]
; 生产环境
user=admin
password=123456
domain_url=https://www.pro.ayunw.cn

比如：user=admin,password=123456 等这样重复的情况。对于这种情况，其实我们可以设置[DEFAULT]这个section公用变量，这个公用变量会自动添加到每一个section中，修改后如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


[DEFAULT]
user=admin
password=123456

[sit]
; 开发环境
domain_url=https://www.sit.ayunw.cn

[perf]
; 测试环境
domain_url=https://www.perf.ayunw.cn

[pre]
; 预生产环境
domain_url=https://www.pre.ayunw.cn

[pro]
; 生产环境
domain_url=https://www.pro.ayunw.cn

最后，如果你想要获取perf环境中的user变量的值，你可以通过 conf['perf']['user'] 来进行获取也是能获取到的。

5、参数化

在ini文件中我们还可以使用%(变量名)s的占位符进行参数化，这种特性被称为Interpolation(插值)。
这里以一个接口为例，不同的params参数对应不同的环境场景，示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


[DEFAULT]
user=admin
password=123456
url=%(domain_url)s/get?name=%(name)s&sex=%(sex)s
domain_url=https://sre.ayunw.cn

[sit]
; 开发环境
domain_url=https://www.sit.ayunw.cn
name=allen
sex=male

[perf]
; 测试环境
domain_url=https://www.perf.ayunw.cn
name=judy
sex=female

[pre]
; 预生产环境
name=hasen
sex=female

[pro]
; 生产环境
name=jea
sex=male

上面例子中，我们在[DEFAULT]段设置了一个参数化的公用变量url，其中埋设了三个占位符，%(domain_url)s、%(name)s、和%(sex)s。并且我们设置了domain_url变量的默认值为https://sre.ayunw.cn。当下面的section中没有覆盖该变量时，如pre和pro中，是用domain_url的默认值。而sit和perf环境则用的是sit和perf自己的section下的domain_url的值。

注意： 每个section段中，加上默认变量domain_url，必须提供所有参数化变量的值，比如此例中每个段最少必须设置name和sex的值，否则会报错。

在Python脚本中打印conf['pre']['url']，可以得到拼接后的url如下：

1

https://sre.ayunw.cn/get?name=hasen&sex=female

还可以使用ExtendedInterpolation()来支持${变量}占位符方式迈入下：

1
2


from configparser import ExtendedInterpolation
conf = ConfigParser(interpolation=ExtendedInterpolation(),  inline_comment_prefixes=['#', ';'],allow_no_value=True)

6、修改保存

conf对象常用的修改如下：

conf.add_section(section)：添加section

conf.set(section, option, value): 在指定section中添加变量和变量值，section必须存在或已添加，value必须为字符串形式，可以设置DEFAULT字段的值

conf.remove_option(section, option)：移除指定section下指定变量

conf.remove_section(section)：移除section

conf.write(f)：保存ini文件

动态生成conf文件，示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38


#!/usr/bin/env python3
# -*- encoding: utf-8 -*-

from configparser import ConfigParser

conf = ConfigParser()
''' 如果新建config.ini文件的话就不需要read,如果修改则需要使用read打开 '''
# conf.read('config.ini', encoding='utf-8')

# 可以设置DEFAULT段的值
conf.set('DEFAULT', 'url', '%(domain_url)s/get?a=%(name)s&b=%(sex)s')
conf.set('DEFAULT', 'domain_url', 'https://sre.ayunw.cn')

''' 生成section为sit部分的配置 '''
conf.add_section('sit')
conf.set('sit', 'domain_url', 'https://www.sit.ayunw.cn')
# 值必须是字符串
conf.set('sit', 'name', 'judy')
conf.set('sit', 'sex', 'female')

''' 生成section为perf部分的配置 '''
conf.add_section('perf')
conf.set('perf', 'domain_url', 'https://www.perf.ayunw.cn')
conf.set('perf', 'name', 'joe')
conf.set('perf', 'sex', 'male')

''' 使用字典的方式添加多个变量来生成section为pre和pro部分的配置 '''
conf['pre'] = {'name': 18, 'sex': 22}  # 直接使用字典添加多个变量.如果值是数字，则不需要引号包裹
conf['pro'] = {'name': 'jea', 'sex': 'male'}

print(conf.get('sit', 'url'))
print(conf.get('perf', 'url'))
print(conf.get('pre', 'url'))
print(conf.get('pro', 'url'))

# 保存为config.ini文件
with open('config.ini', 'w', encoding='utf-8') as f:
    conf.write(f)

运行上述Python脚本

1
2
3
4
5


# python3 generate-config.py 
https://www.sit.ayunw.cn/get?a=judy&b=female
https://www.perf.ayunw.cn/get?a=joe&b=male
https://sre.ayunw.cn/get?a=18&b=22
https://sre.ayunw.cn/get?a=jea&b=male

生成的文件内容如下

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


# cat config.ini 
[DEFAULT]
url = %(domain_url)s/get?a=%(name)s&b=%(sex)s
domain_url = https://sre.ayunw.cn

[sit]
domain_url = https://www.sit.ayunw.cn
name = judy
sex = female

[perf]
domain_url = https://www.perf.ayunw.cn
name = joe
sex = male

[pre]
name = 18
sex = 22

[pro]
name = jea
sex = male

                                    ----- 如果文章对你有用,就请我喝杯咖啡吧! -----