INI 简介

INI 即 Initialize 初始化之意，早期是在 Windows 上配置文件的存储格式。INI 文件的写法通俗易懂，往往比较简单，通常由节（Section）、键（key）和值（value）组成，section名不能重复，就像以下形式：

[db]
host     = 127.0.0.1
user     = root
password = 123456
port     = 3306
database = mysql

[cfg]
data1 = 1
data2 = 2

Python 本身内置的 configparser 标准库，直接就可以用来对 INI 文件进行解析。如将上述内容保存在一个名为 db.ini 的文件中，然后使用 read() 方法来进行解析和读取，最后通过 items() 方法来获取指定节点下的所有键值对。

>>> from configparser import ConfigParser

>>> cfg = ConfigParser()

>>> cfg.read("/Users/user/db.ini")
['/Users/user/db.ini']

>>> cfg.items("db")
[('host', '127.0.0.1'), ('user', 'root'), ('password', '123456'), ('port', '3306'), ('database', 'mysql')]

需要注意的是，configparser 默认将值以字符串的形式呈现，所以这也就是为什么在 db.ini 文件中没有加引号而是直接将字面量写在上面的原因。

获取到键值对后，其实直接就将其转换成字典，然后通过解包的方式进行传参，保持代码简洁：

# pip install pymysql
import pymysql
from configparser import ConfigParser


cfg = ConfigParser()
cfg.read("/Users/user/db.ini")
db_cfg = dict(cfg.items("db"))
con = pymysql.connect(**db_cfg)

用法详解

模块引入

import configparser

"""
[DEFAULT]
data0 = 0

[db]
; 数据库配置
host     = 127.0.0.1
user     = root
password = 123456
port     = 3306
database = mysql

[cfg]
# 其他配置
data1 = 1
data2 = 2
"""

config = configparser.ConfigParser(comment_prefixes='/', allow_no_value=True)
# 在回写时清除配置文件中的注释的原因是 write 方法根本不处理注释。它只写键/值对。
# 绕过这个问题的最简单方法是使用自定义注释前缀和 allow_no_value=True 初始化配置解析器对象。
# 如果希望在文件中保留默认的 # 和 ; 注释行，可以使用 comment_prefixes='/' 。
# 也就是说，为了保留注释，必须让配置解析器相信这不是注释，这一行是一个没有值的键。
config.read(r'config.ini', encoding='utf-8')

获取节

# 获取所有 Section 名称
section_keys = list(config.keys())
print(section_keys)
# ['DEFAULT', 'db', 'cfg']

# 获取所有 Section 的数据
section_values = list(config.values())
print(section_values)
# [<Section: DEFAULT>, <Section: db>, <Section: cfg>]

# # 输出段落和段落中的字典，不包含DEFAULT的 Section
section_list = config.sections()
print(section_list)
# ['db', 'cfg']

获取键、值

# DEFAULT 段中的键值对
default_dict = config.defaults()
print(default_dict)
# {'data0': '0'}

# 获取指定 Section 的 Key 和 Value
db_info = config.items('db')
print(db_info)
# [('data0', '0'), ('host', '127.0.0.1'), ('user', 'root'), ('password', '123456'), ('port', '3306'), ('database', 'mysql')]
print(dict(db_info))
# {'data0': '0', 'host': '127.0.0.1', 'user': 'root', 'password': '123456', 'port': '3306', 'database': 'mysql'}

# 获取指定 Section 的 Key
db_keys = config.options('db')
print(db_keys)
# ['host', 'user', 'password', 'port', 'database', 'data0']

# 获取指定 Key 的 Value
host_info = config['db']['host']
print(host_info)
# 127.0.0.1

判断节、键、值是否存在

# 判断是否有指定 Section
print(config.has_section("db"))  # 指定的节存在
# True
print(config.has_section("mysql"))  # 指定的节不存在
# False

# 判断指定 Section 下是否指定的 key
print(config.has_option('db', 'host'))  # 指定节下的键存在
# True
print(config.has_option('db', 'ip'))  # 指定节下的键不存在
# False
print(config.has_option('mysql', 'host'))  # 指定的节不存在
# False

获取值类型转换

# 在ini中所有的键值对都默认为字符串，自动转换为数字
port_info = config.get('db', 'port')
print(port_info, type(port_info))
# 3306 <class 'str'>
port_info = config.getint('db', 'port')
print(port_info, type(port_info))
# 3306 <class 'int'>

添加、删除节、键值

# 通过 add_section 添加 Section，也可以通过 add_option 添加指定的键值（不会改变配置文件）
print(config.has_section('new'))
# False
config.add_section('new')
print(config.has_section('new'))
# True

# 通过 remove_section 删除 Section，也可以通过 remove_option 删除指定的键值（不会改变配置文件）
print(config.has_section('cfg'))
# True
config.remove_section('cfg')
print(config.has_section('cfg'))
# False

修改值

# 修改值，Section、Key必须要存在，否则会报错
print(config.get('db', 'host'))
# 127.0.0.1
config.set('db', 'host', '192.168.168.192')
print(config.get('db', 'host'))
# 192.168.168.192

写入配置文件

# 写入ini文件，如要保留注释，则添加 comment_prefixes='/', allow_no_value=True 参数
# 追加写，仅适用于添加不同的节
config.write(open("config.ini", "a", encoding='utf-8'))
# 全部写，将文件由config完全覆盖，会删除原配置文件注释
config.write(open("config.ini", "w", encoding='utf-8'))