对话实录

小白：（得意的样子）专家！我今天学习了Python自带的configparser模块，用来解析ini配置文件，超好用！

专家：（举起大拇指）很赞！你已经不是当年的小白了，以后要拜你为师了！

一、ini文件基础：认识配置文件的 “模样”

ini文件是一种常见的配置文件，由节（section）、键值对（key-value） 组成，格式清晰，便于阅读和编辑。典型的 ini 文件长这样：

[database]
host = 127.0.0.1
port = 3306
username = root
password = 123456

[server]
address = 0.0.0.0
port = 8080
debug = False

核心结构：

• 节：用方括号[]包裹，如[database]、[server]，用于分类配置。
• 键值对：每个节下包含多个键值对，如host = 127.0.0.1，通过等号=连接。

二、Python解析ini文件：configparser模块的魔法

1. 读取ini文件

使用configparser模块读取 ini 文件，分三步：创建解析器、读取文件、获取配置。

import configparser
# 创建解析器对象
config = configparser.ConfigParser()

# 读取ini文件
config.read('config.ini')

详细参数与使用技巧：

configparser.ConfigParser()的参数介绍：

• allow_no_value=True参数，允许ini文件中存在没有值的键（如[section]下仅有key,没有value），默认allow_no_value=False 。
• interpolation=None可禁用插值功能。插值功能指ini中某个值可以引用其他已定义的值，例如[test]节下value1 = 10，value2 = %(value1)s，若不禁用插值，读取value2时会得到10；禁用后value2就是%(value1)s。

config.read()：支持同时读取多个 ini 文件，如config.read(['config1.ini', 'config2.ini'])，后面文件的配置会覆盖前面文件相同的配置项。若文件不存在，不会抛出异常，而是返回空列表，可通过config.sections()检查是否成功读取到节来判断文件读取情况。

1）获取section

sections = config.sections() #返回列表
print(sections)
结果：
['database', 'server']

2）获取每个section的option列表

db_options = config.options('database')
print(db_options)
timeout_options = config.options('server')
print(timeout_options)
结果：
['host', 'port', 'username', 'password']
['address', 'port', 'debug']

3）获取section的option对应的值

类型转换函数：config.get(section, key)，config.getint(section, key)、config.getfloat(section, key)、config.getboolean(section, key)，分别得到原始值，整形，浮点型和布尔型的值。

# 获取database节的host和port
host = config.get('database', 'host')
port = config.getint('database', 'port')
print(f"数据库地址：{host}:{port}")
# 获取server节的debug值（自动转换为布尔类型）
debug = config.getboolean('server', 'debug')
print(f"调试模式：{debug}")

#输出为：
数据库地址：127.0.0.1:3306
调试模式：False

4）获取某个section的全部内容，返回嵌套元组的列表

使用config.items(section)函数获取section的全部内容。

items = config.items('database')
print(items)
结果：
[('host', '127.0.0.1'), ('port', '3306'), ('username', 'root'), ('password', '123456')]

2. 修改 ini 文件

修改ini文件同样简单，先读取，再修改，最后保存。除了修改和添加键值对，configparser还提供了删除键值对和section、添加section的功能。

import configparser
config = configparser.ConfigParser()
config.read('config.ini')

添加section和健值对

• 使用config.has_option(section, key)判断键值对是否存在。
• 使用config.add_section(section)添加section。
• 使用config.add_section(section, key,value)添加键值对。
• 修改后要保存请使用config.write()进行保存。

#添加section
new_section_name = "new_section"
if not config.has_section(new_section_name):
    config.add_section(new_section_name)
    print(f"成功添加 {new_section_name} 节")
    # 在新节中添加键值对
    config.set(new_section_name, "key1", "value1")
    config.set(new_section_name, "key2", "value2")
else:
    print(f"{new_section_name} 节已存在")

# 将修改保存回文件
with open('config.ini', 'w') as f:
    config.write(f)

删除section和健值对

• config.remove_option(section, key)：用于删除指定section下的某个键值对。在删除前，可使用config.has_option(section, key)判断键值对是否存在，避免因键值对不存在而报错 。
• config.remove_section(section)：用于删除整个section，包括该section下的所有键值对。同样，删除前可通过config.has_section(section)判断section是否存在。
• 删除后需调用config.write()保存修改 。

# 删除键值对：删除database节的password键值对
if config.has_option('database', 'password'):
    config.remove_option('database', 'password')
    print("已成功删除database节的password键值对")
else:
    print("database节中不存在password键值对")

# 删除section：删除server节
if config.has_section('server'):
    config.remove_section('server')
    print("已成功删除server节")
else:
    print("config.ini中不存在server节")

# 将修改保存回文件
with open('config.ini', 'w') as f:
    config.write(f)

3. 写入新的ini文件

如果要创建全新的 ini 文件，直接构建节和键值对即可。

import configparser
config = configparser.ConfigParser()
# 添加节和键值对
config['user'] = {
'name': 'Alice',
'age': '25',
'email': 'alice@example.com'
}
#继续添加键值对
config.set('user', 'phone', '13800138000') 

# 写入文件
with open('config.ini', 'w') as f:
	config.write(f)

三、 闭坑指南

文件编码问题

• 错误操作：ini文件编码与Python读取时的编码不匹配，导致乱码或读取失败。
• 解决方法：明确ini文件编码（如UTF8），在config.read()中指定编码，例如config.read('config.ini', encoding='utf8')。

节或键不存在

• 错误操作：获取、修改或删除不存在的节或键，会抛出NoSectionError或NoOptionError；在判断时使用错误的方法也会导致逻辑错误。
• 解决方法：读取、修改或删除前，可使用config.has_section(section)判断section是否存在，使用config.has_option(section, key)判断键值是否存在。

类型转换失败

• 错误操作：使用getint、getboolean等方法时，值无法转换为对应类型（如getint传入非数字字符串）。
• 解决方法：确保值的格式正确，或增加异常处理：

写入覆盖问题

• 错误操作：直接调用config.write()会覆盖原文件内容，若误操作可能丢失数据。
• 解决方法：写入前备份文件，或使用版本控制工具（如 Git）管理配置文件。

附录、configparser模块常用函数汇总