Python使用configparser管理配置文件

news2024/9/21 14:47:04

前言

在 Python 项目开发中，配置文件通常用于存储配置信息，例如数据库连接参数、日志设置、应用程序行为等。这些信息可以与代码分离，使得应用程序更易于维护和管理。Python 的标准库中提供了一个非常有用的模块——configparser，专门用于处理配置文件，通常是 .ini 格式的文件。

官网

https://docs.python.org/zh-cn/3.12/library/configparser.html#configparser.ConfigParser

什么是.ini文件

.ini 文件是一种简单的文本文件格式，用于存储配置信息。它由一个或多个 section 组成，每个 section 下包含一个或多个 option。每个 option 都有一个对应的值。其基本结构如下：

[section_name]
option_name1 = value1
option_name2 = value2

例如，假设我们有一个名为 config.ini 的配置文件，用于存储数据库连接信息：

[settings]
debug = true
log_level = info
output_file = /path/to/output

[database]
host = localhost
port = 5432
username = user
password = pass

使用configparser读取配置文件

首先，我们需要创建一个 ConfigParser 对象，并使用 read() 方法读取配置文件。接下来，可以通过 section 和 option 名字来获取对应的值：

import configparser

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

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

# 获取指定 section 下的 option 值
host = config['database']['host']
port = config['database']['port']
username = config['database']['username']
password = config['database']['password']

print(f"Database connection info: {host}:{port}, User: {username}")

configparser 处理的所有值都是字符串。如果你需要存储其他数据类型（如整数、布尔值等），可以使用转换函数：

import configparser

def read_config(file_path):
    # 创建ConfigParser对象
    config = configparser.ConfigParser()

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

    # 获取数据库配置
    db_host = config.get('database', 'host')
    db_port = config.getint('database', 'port')
    db_username = config.get('database', 'username')
    db_password = config.get('database', 'password')

    # 打印读取到的配置
    print(f"Database Host: {db_host}")
    print(f"Database Port: {db_port}")
    print(f"Database Username: {db_username}")
    print(f"Database Password: {db_password}")


if __name__ == "__main__":
    read_config('config.ini')

在这里插入图片描述

修改配置文件

configparser还允许我们修改配置文件中的数据，然后将修改后的内容写回文件：

# 修改数据库用户名
config['database']['username'] = 'new_user'

# 将修改后的配置写回文件
with open('config.ini', 'w') as configfile:
    config.write(configfile)

添加新的Section和Option

如果你需要在配置文件中添加新的 section 和 option，可以直接使用字典方式进行赋值：

# 添加新的 section 和 option
config['new_section'] = {}
config['new_section']['new_option'] = 'new_value'

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

配置文件的默认值

configparser 还支持设置默认值，这些默认值在特定 section 中找不到对应 option 时会被使用。默认值可以在创建 ConfigParser 对象时传递：

defaults = {'host': '127.0.0.1', 'port': '3306'}
config = configparser.ConfigParser(defaults=defaults)
config.read('config.ini')

# 如果 config.ini 中没有指定 host 和 port，将使用默认值
host = config['database'].get('host')
port = config['database'].get('port')

print(f"Using defaults - Host: {host}, Port: {port}")