Python-配置模块configparser使用指南

configparser 是 Python 标准库中的模块，用于处理配置文件（如 .ini 文件）。它适合管理程序的配置信息，比如数据库连接参数、应用程序设置等。

1. 配置文件的基本结构

配置文件通常是 .ini 格式，由 节（Section） 和 键值对（Key-Value Pairs） 组成：

[DEFAULT]
AppName = MyApp
Version = 1.0

[Database]
Host = localhost
Port = 5432
User = admin
Password = secret

[Logging]
Level = DEBUG
FilePath = /var/log/myapp.log

2. 安装 configparser

configparser 是 Python 内置模块，无需安装。直接导入即可：

import configparser

3. 读取配置文件

ConfigParser 对象可用于读取和操作配置文件。

示例：读取配置文件

import configparser


# 创建 ConfigParser 对象
config = configparser.ConfigParser()

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

# 访问 DEFAULT 节中的键值
app_name = config['DEFAULT']['AppName']
version = config['DEFAULT']['Version']

print(f"App Name: {app_name}, Version: {version}")

# 访问 Database 节中的键值
db_host = config['Database']['Host']
db_port = config['Database']['Port']

print(f"Database Host: {db_host}, Port: {db_port}")

# 使用 get 方法访问数据（带类型转换）
db_port = config.getint('Database', 'Port')  

# 转换为整数
print(f"Database Port (as int): {db_port}")

4. 检查配置文件内容

可以检查某些节或键是否存在：

# 检查某个节是否存在
if 'Database' in config:
    print("Database section exists.")

# 检查某个键是否存在
if 'User' in config['Database']:
    print("User key exists in Database section.")

5. 修改配置文件

可以直接修改 ConfigParser 对象的内容，然后将其写入文件。

示例：修改和保存配置文件

# 修改配置项
config['Database']['Host'] = '127.0.0.1'
config['Database']['User'] = 'new_user'

# 添加新的节和配置
config['NewSection'] = {
    'Key1': 'Value1',

    'Key2': 'Value2'
}

# 保存到文件
with open('config.ini', 'w') as configfile:
    config.write(configfile)

6. 删除配置

可以删除整个节或某个键。

示例：删除节和键

# 删除某个键
config.remove_option('Database', 'Password')

# 删除某个节
config.remove_section('Logging')

# 保存修改
with open('config.ini', 'w') as configfile:
    config.write(configfile)

7. 使用默认值

DEFAULT 节用于设置默认值，其他节可以继承这些默认值。

示例：默认值的继承

[DEFAULT]
Timeout = 30

[Service1]
Host = service1.local

[Service2]
Host = service2.local

# 获取 Service1 和 Service2 的 Timeout 值
timeout_service1 = config['Service1']['Timeout']  

# DEFAULT 节的值
timeout_service2 = config['Service2']['Timeout']

print(f"Service1 Timeout: {timeout_service1}, Service2 Timeout: {timeout_service2}")

8. 支持的数据类型

configparser 支持以下常见类型的解析和转换：

示例：读取不同数据类型

timeout = config.getint('DEFAULT', 'Timeout')

is_debug = config.getboolean('Logging', 'Level')
print(f"Timeout: {timeout}, Is Debug Mode: {is_debug}")

9. 动态创建配置文件

可以从头开始创建一个新的配置文件。

示例：动态生成配置文件

# 创建新的 ConfigParser 对象
new_config = configparser.ConfigParser()

# 添加节和配置
new_config['DEFAULT'] = {'AppName': 'NewApp', 'Version': '2.0'}

new_config['UserSettings'] = {'Theme': 'Dark', 'FontSize': '12'}

new_config['Database'] = {
    'Host': 'db.local',

    'Port': '3306',

    'User': 'admin',

    'Password': 'password123'
}

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

10. 处理带注释的配置文件

configparser 会忽略 # 和 ; 开头的注释。

示例：带注释的配置文件

[DEFAULT]

# 这是一个注释
AppName = MyApp

; 内联注释
Version = 1.0
# 解析时会自动忽略注释：

app_name = config['DEFAULT']['AppName']
print(app_name)  # 输出：MyApp

11. 扩展功能：自定义解析器

你可以继承 ConfigParser 类，重写方法以实现自定义行为。

示例：忽略大小写的键

class CustomConfigParser(configparser.ConfigParser):
    def optionxform(self, optionstr):

        return optionstr.lower()  # 转为小写

custom_config = CustomConfigParser()

custom_config.read('config.ini')

# 无论大小写，均可访问
print(custom_config['Database']['HOST'])  
# 等同于 custom_config['Database']['host']

12. 异常处理

使用 configparser 时可能会遇到异常，例如文件缺失或键不存在。

常见异常：

示例：捕获异常

try:
    value = config['NonExistentSection']['Key']
except configparser.NoSectionError:

    print("Section does not exist!")

except configparser.NoOptionError:

    print("Key does not exist!")

configparser 模块非常适合管理简单的配置文件，提供了灵活的 API 支持读取、修改和保存配置文件。在复杂应用中，它可以作为配置管理工具的一部分。

作者：网络风云