欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Python3读写ini配置文件的示例

程序员文章站 2022-08-07 18:01:41
ini文件即initialization file初始化文件,在应用程序及框架中常作为配置文件使用,是一种静态纯文本文件,使用记事本即可编辑。配置文件的主要功能就是存储一批变量和变量值,在ini文件中...

ini文件即initialization file初始化文件,在应用程序及框架中常作为配置文件使用,是一种静态纯文本文件,使用记事本即可编辑。
配置文件的主要功能就是存储一批变量和变量值,在ini文件中使用[章(section)]对变量进行了分组,基本格式如下。

# filename: config.ini
[user]
name=admin
password=123456
is_admin=true

[mysql]
host=10.10.10.10
port=3306
db=apitest
user=root
password=123456

[log]
file=run.log
level=info

以上文件中,有3个section段,分别user、mysql和log。
使用配置文件的好处在于,不用修改代码文件就可以更改使用的用户、数据库以及日志的配置,避免修改代码带来新的bug,或需要重新打包(如java项目中)。

ini文件中使用#或者;添加注释,最好独占一行,不能写在变量后面

读取

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

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下是否有该变量值

如果想遍历一个section所有的变量和值,可以像遍历字典意义操作,示例如下。

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

注意:ini文件中的变量名是大小写不敏感的,而section名是大小写敏感的。

公共变量

假如我们每个section变量组都有一批相同的重复变量,如:

[dev]
# 开发环境
user=admin
password=123456
base_url=http://localhost:7777

[test]
# 测试环境
user=admin
password=123456
base_url=http://test.abc.com

[prod]
# 生产环境
user=admin
password=123456
base_url=http://www.abc.com

对应这种,我们可以设置[default]段公用变量,公用变量会自动添加到每一个段中,修改后如下。

[default]
user=admin
password=123456

[dev]
# 开发环境
base_url=http://localhost:7777

[test]
# 测试环境
base_url=http://test.abc.com

[prod]
# 生产环境
base_url=http://www.abc.com

在python文件中使用conf['test']['user']同样能获取到变量的值。

参数化

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

[default]
url = %(base_url)s/get?a=%(a)s&b=%(b)s
base_url=https://httpbin.org

[dev]
# 开发环境
base_url=http://localhost:5555
a=1
b=2

[prod-case1]
# 生成环境-场景1
a=1
b=2

[prod-case2]
# 生成环境-场景2
a=kevin
b=male

上例中,我们在[default]段设置了一个参数化的公用变量url,其中埋设了三个占位符,%(base_url)s、%(a)s、和%(b)s。
并且我们设置了base_url变量的默认值为。
当下面的section中没有覆盖该变量时,如prod-case1和prod-case2中,是用base_url的默认值。

注意:每个section段中,加上默认变量base_url,必须提供所有参数化变量的值,比如此例中每个段最少必须设置a和b的值,否则会报错。

在python脚本中打印conf['prod-case2']['url'],可以得到组装后的url。

https://httpbin.org/get?a=kevin&b=male

修改保存

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文件,示例如下。

from configparser import configparser
from configparser import configparser

conf = configparser()

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

conf.set('default', 'url', '%(base_url)s/get?a=%(a)s&b=%(b)s') # 可以设置default段的值
conf.set('default', 'base_url', 'https://httpbin.org') # 可以设置default段的值
conf.add_section('dev')
conf.set('dev', 'base_url', 'http://localhost:5555')
conf.set('dev', 'a', '1') # 值必须是字符串
conf.set('dev', 'b', '2')

conf['prod-case1'] = {'a': 1, 'b': 2} # 直接使用字典添加多个变量
conf['prod-case2'] = {'a': 'kevin', 'b': 'male'}

print(conf.get('dev', 'url'))
print(conf.get('prod-case1', 'url'))
print(conf.get('prod-case2', 'url'))

# 保存csv
with open('httpbin.ini', 'w', encoding='utf-8') as f:
  conf.write(f)

运行打印结果如下:

http://localhost:5555/get?a=1&b=2
https://httpbin.org/get?a=1&b=2
https://httpbin.org/get?a=kevin&b=male

生成的文件内容如下。

[default]
url = %(base_url)s/get?a=%(a)s&b=%(b)s
base_url = https://httpbin.org

[dev]
base_url = http://localhost:5555
a = 1
b = 2

[prod-case1]
a = 1
b = 2

[prod-case2]
a = kevin
b = male

以上就是python3读写ini配置文件的示例的详细内容,更多关于python 读写ini的资料请关注其它相关文章!

相关标签: python ini