Python3读写ini配置文件的示例

作者:临渊 时间:2023-05-29 22:59:21 

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变量的默认值为https://httpbin.org。
当下面的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

来源:https://www.cnblogs.com/superhin/p/13883802.html

标签:python,ini
0
投稿

猜你喜欢

  • vuecli3.0脚手架搭建及不同的打包环境配置vue.config.js的详细过程

    2024-04-30 08:42:13
  • python读取配置文件方式(ini、yaml、xml)

    2022-10-12 05:07:29
  • python 对给定可迭代集合统计出现频率,并排序的方法

    2023-02-10 17:28:47
  • wxpython+pymysql实现用户登陆功能

    2023-01-06 11:32:04
  • Python实现自动签到脚本功能

    2022-07-24 21:53:40
  • Jupyter notebook中5个有趣的魔法命令分享

    2021-11-28 23:26:30
  • pandas 把数据写入txt文件每行固定写入一定数量的值方法

    2021-06-13 20:08:14
  • python实现粒子群算法

    2021-03-20 02:27:34
  • opera img onload重复执行

    2008-01-17 12:01:00
  • keras 实现轻量级网络ShuffleNet教程

    2023-06-27 05:19:26
  • Python中使用pprint函数进行格式化输出的教程

    2022-08-26 03:34:17
  • 在MySQL中使用更新日志文件

    2009-02-26 16:22:00
  • Mysql5.7定时备份的实现

    2024-01-22 13:08:27
  • 在JScript中使用RecordSet对象的GetRows方法

    2008-01-16 13:12:00
  • 根据DataFrame某一列的值来选择具体的某一行方法

    2021-01-08 20:33:42
  • Pycharm之快速定位到某行快捷键的方法

    2022-06-20 14:07:53
  • Python学习之configparser模块的使用详解

    2022-07-21 23:21:25
  • 一篇文章弄懂Python中所有数组数据类型

    2023-01-12 18:25:05
  • Python中range、np.arange和np.linspace的区别

    2023-10-17 14:45:14
  • 模式化窗口

    2009-06-18 18:41:00
  • asp之家 网络编程 m.aspxhome.com