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实现的逻辑回归算法示例【附测试csv文件下载】

    Python实现的逻辑回归算法示例【附测试csv文件下载】

    这篇文章主要介绍了Python实现的逻辑回归算法,结合具体实例形式分析了Python逻辑回归算法相关实现技巧,需要的朋友可以参考下
    2018-12-12
  • python利用dlib获取人脸的68个landmark

    python利用dlib获取人脸的68个landmark

    这篇文章主要介绍了python利用dlib获取人脸的68个landmark,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • 使用python绘制地图的示例代码

    使用python绘制地图的示例代码

    要在Python中绘制地图,你可以使用各种库和工具包,其中最常用的是matplotlib和folium,本文就来给大家介绍一下如何使用python绘制地图,文章通过代码示例介绍的非常详细,需要的朋友可以参考下
    2023-08-08
  • Python下的twisted框架入门指引

    Python下的twisted框架入门指引

    这篇文章主要介绍了Python下的twisted框架入门指引,twisted框架是一个异步机制的框架,也被许多Python教程所介绍,需要的朋友可以参考下
    2015-04-04
  • Python实现自动签到脚本的示例代码

    Python实现自动签到脚本的示例代码

    这篇文章主要介绍了Python实现自动签到脚本的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • 怎么使用python生成词云图

    怎么使用python生成词云图

    这篇文章主要给大家介绍了关于怎么使用python生成词云图的相关资料,词云图主要用途是将文本数据中出现频率较高的关键词以可视化的形式展现出来,使人一眼就可以领略文本数据的主要表达意思,需要的朋友可以参考下
    2023-06-06
  • 一文掌握Python正则表达式

    一文掌握Python正则表达式

    这篇文章主要介绍了Python正则表达式的相关知识,主要包括re模块的使用及正则表达式基础知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • python冒泡排序算法的实现代码

    python冒泡排序算法的实现代码

    这篇文章主要介绍了python冒泡排序算法的实现代码,大家参考使用
    2013-11-11
  • Python 列表和字典常踩坑即解决方案

    Python 列表和字典常踩坑即解决方案

    这篇文章介绍了 Python 列表和字典常踩坑即解决方案,主要针对python列表和字典得一些问题,提出了多种解决方案。需要的小伙伴可以参考一下
    2022-05-05
  • Python使用chardet判断字符编码

    Python使用chardet判断字符编码

    这篇文章主要介绍了Python使用chardet判断字符编码的方法,较为详细的分析了Python中chardet的功能、安装及使用技巧,需要的朋友可以参考下
    2015-05-05

最新评论