Python3读写ini配置文件的示例

 更新时间:2020年11月06日 11:33:55   作者:临渊  
这篇文章主要介绍了Python3读写ini配置文件的示例,帮助大家更好的理解和使用python,感兴趣的朋友可以了解下

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

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

相关文章

  • 用python如何绘制表格不同颜色的excel

    用python如何绘制表格不同颜色的excel

    做数据分析的时候,用到了对Excel中的数据进行显示处理,能更直观的了解数据,所以下面这篇文章主要给大家介绍了关于利用python如何绘制表格不同颜色excel的相关资料,需要的朋友可以参考下
    2021-11-11
  • Python3 多线程(连接池)操作MySQL插入数据

    Python3 多线程(连接池)操作MySQL插入数据

    本文将结合实例代码,介绍Python3 多线程(连接池)操作MySQL插入数据,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-06-06
  • 修复python-memcached在python3.8环境中报SyntaxWarning的问题(完美解决)

    修复python-memcached在python3.8环境中报SyntaxWarning的问题(完美解决)

    我们一直使用python-memcached库来操作memcached,最近发现在python3.8的环境中,代码会报错,下面通过本文给大家讲解修复python-memcached在python3.8环境中报SyntaxWarning的问题及解决方法,需要的朋友可以参考下
    2022-08-08
  • pygame游戏之旅 创建游戏窗口界面

    pygame游戏之旅 创建游戏窗口界面

    这篇文章主要为大家详细介绍了pygame游戏之旅,教大家如何创建游戏窗口界面,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-11-11
  • Matplotlib绘图基础之子图详解

    Matplotlib绘图基础之子图详解

    这篇文章主要为大家详细介绍了Matplotlib绘制子图的常用方式和技巧,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的可以了解一下
    2023-07-07
  • python实现用户登录系统

    python实现用户登录系统

    这篇文章主要为大家详细介绍了python实现用户登录系统的相关资料,感兴趣的朋友可以参考一下
    2016-05-05
  • 详解Python如何检查一个数字是否是三态数

    详解Python如何检查一个数字是否是三态数

    在数学中,三态数(Triangular Number)是一种特殊的数列,它是由自然数按照一定规律排列而成的,本文主要介绍了如何使用Python检查判断一个数字是否是三态数,需要的可以参考下
    2024-03-03
  • Python3运算符常见用法分析

    Python3运算符常见用法分析

    这篇文章主要介绍了Python3运算符常见用法,结合实例形式分析了Python3算术运算符、逻辑运算符、比较运算符、位运算符等相关原理与操作技巧,需要的朋友可以参考下
    2020-02-02
  • itchat和matplotlib的结合使用爬取微信信息的实例

    itchat和matplotlib的结合使用爬取微信信息的实例

    下面小编就为大家带来一篇itchat和matplotlib的结合使用爬取微信信息的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • Gradio中button组件的基本使用方式

    Gradio中button组件的基本使用方式

    Gradio中的button组件用于实现点击事件,通过click事件绑定函数来处理值的变化,点击时,函数接收组件的值作为输入,返回新的值或更新组件的属性,示例代码展示了如何在点击按钮时修改文本框的值并控制按钮的可见性
    2024-11-11

最新评论