Python中configparser模块的基本用法

configparser是Python 标准库中的一个模块，用于处理配置文件。配置文件通常用于存储应用程序的配置信息，如数据库连接参数、日志级别设置等。configparser模块支持读取、写入和修改配置文件，这些文件通常采用类似INI格式的结构。

配置文件格式

配置文件一般以 ' .ini ' 作为扩展名，包含多个节（sections），每个节内有多个键值对。典型的INI文件格式如下：

[SectionName]
key1 = value1
key2 = value2

[AnotherSection]
keyA = valueA
keyB = valueB

可以通过节名和键值对名获取对用参数。configparser模块就是实现针对配置文件进行操作的工具。

主要功能

1. 创建配置解析器

ConfigParser()：创建一个配置解析器对象。

在使用该模块对配置文件进行操作之前，需要先创建一个配置解析器，通过配置解析器来实现文件的操作。

import configparser

# 创建配置解析器 
# 创建 ConfigParser 对象命名为 config ，后面直接通过该对象来操作配置文件
config = configparser.ConfigParser()

 2. 检查节和键的存在性

 has_section('SectionName')：检查节是否存在。

has_option('SectionName', 'key1')：检查键是否存在。

import configparser

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

# 检查节是否存在
if config.has_section('SectionName'):
    print('Section exists')

# 检查键是否存在
if config.has_option('SectionName', 'key1'):
    print('Key exists')

3. 读取配置文件 

read(filename)：从指定文件中读取配置。

get(section, option)：获取指定节中的某个选项的值，返回类型为字符串。

getint(section, option)：获取指定节中的某个选项的整数值。

getboolean(section, option)：获取指定节中的某个选项的布尔值。

以上函数用于加载或读取配置文件中的数据。

import configparser

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

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

# 获取某个选项的值
value = config.get('SectionName', 'key1')
print(value)  # 输出 key1 的值 value

# 获取整数或布尔值
int_value = config.getint('SectionName', 'key1')
bool_value = config.getboolean('SectionName', 'key2')

4. 配置文件的增删改

文件的操作

当需要写入指定文件时，使用with语句打开ini文件，'w' 进入写入模式。如果文件不存在，会自动创建。在确保代码块执行完成后自动关闭文件，即使在过程中发生异常也会安全地关闭文件。

使用write()函数将config对象中的所有配置信息写入到打开的configfile文件中。

键的操作

set(section, option, value)：设置指定节中的某个选项的值，用于修改和新增。

remove_option(section, key)：删除指定节中的某个键。

import configparser

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

# 检查是否存在该节和键
section = 'SectionName'
key1 = 'KeyName1'
key2 = 'KeyName2'

if config.has_section(section) and config.has_option(section, key1):
    # 删除键
    config.remove_option(section, key1)

    # 将修改后的配置写回文件
    with open('config.ini', 'w') as configfile:
        config.write(configfile)
        print(f"已删除 {section} 节中的 {key} 键。")
else:
    print(f"{section} 节或 {key1} 键不存在。")

if config.has_section(section):
    # 设置键的值（如果键不存在，则会创建；如果键存在，则会更新）
    config.set(section, key2, 'value2')

    # 将修改后的配置写回文件
    with open('config.ini', 'w') as configfile:
        config.write(configfile)
        print(f"{section} 节中的键 {key2} 已设置为 {value2}")
else:
    print(f"{section} 节不存在。")

节的操作

add_section(section)：添加一个新的节。

remove_section(section)：删除指定的节。

import configparser

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

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

section = 'SectionName'  # 替换为你的节名称

# 检查是否存在该节
if config.has_section(section):
    # 删除该节
    config.remove_section(section)
    print(f"已删除节: {section}")
else:
    # 插入该节
    config.add_section(section)
    print(f"已插入节: {section}")


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

当需要对节名进行修改时需要新建一个新命名的节，将原来的键值插入新节中，然后删除旧的节，具体代码如下：

import configparser

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

old_section = 'OldSectionName'  # 替换为你要修改的旧节名称
new_section = 'NewSectionName'  # 替换为你想要的新节名称

# 检查旧节是否存在
if config.has_section(old_section):
    # 获取旧节中的所有键值对
    items = config.items(old_section)
    
    # 添加新节并将旧节的键值对复制过去
    config.add_section(new_section)
    for key, value in items:
        config.set(new_section, key, value)
    
    # 删除旧节
    config.remove_section(old_section)
    print(f"已将节名从 '{old_section}' 修改为 '{new_section}'。")
else:
    print(f"节 '{old_section}' 不存在，无法修改。")

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

 总结

configparser模块是处理配置文件的一个简单而强大的工具，特别适合在应用程序中管理配置信息。它提供了一个高层次的 API 来读取和写入类似 INI 的配置文件，能够轻松处理字符串、整数、布尔值等多种数据类型，并且支持动态修改配置文件内容。