Python configparser模块应用过程解析

简介

Python configparser模块是Python标准库中的模块之一，它可以用于读取、修改INI文件中的配置信息。INI文件是一种格式简单的配置文件格式，常用于存储应用程序、操作系统等的配置信息。

模块介绍

configparser模块包含三个类：

1. ConfigParser：主要用于读取、修改INI文件中的配置信息；
2. RawConfigParser：基本与ConfigParser相同，只是在读取时不会进行拆分、解析配置项，而是将其保存为一个整体，适用于保留原有配置格式的情景；
3. SafeConfigParser：基本与ConfigParser相同，但是在设置时，若发现设置错误，则抛出异常，而ConfigParser则返回False。

configparser模块的基本用法

1. 读取INI文件中的配置信息

import configparser

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

# 读取INI文件中的配置信息
conf.read('example.ini')

# 读取[section]中的key对应的值
value = conf.get('section', 'key')

# 将所有的配置信息以字典的形式返回
conf_dict = conf.items('section')

2. 修改现有INI文件中的配置信息

# 修改INI文件中的[section]中的[key]对应的值
conf.set('section', 'key', 'new_value')

# 保存修改
with open('example.ini', 'w') as f:
    conf.write(f)

常用方法介绍

• read(filename)：读取filename指定的INI文件中的配置信息；
• read_string(string)：读取字符串形式表示的INI文件中的配置信息；
• read_dict(dic)：从Python字典对象中读取配置信息；
• write(file_object)：将配置信息写入文件；
• set(section, key, value)：修改指定section下key对应的值为value；
• get(section, key)：获取指定section下key对应的值。

示例1

本示例中，example.ini文件内容如下：

[section1]
key1 = value1
key2 = value2

我们来创建一个read_ini.py的Python文件，代码如下：

import configparser

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

# 读取INI文件中的配置信息
conf.read('example.ini')

# 读取[section1]中的key1对应的值
value1 = conf.get('section1', 'key1')
print(value1)  # 输出：value1

# 将所有的配置信息以字典的形式返回
conf_dict = conf.items('section1')
print(conf_dict)  # 输出：[('key1', 'value1'), ('key2', 'value2')]

执行该Python文件，会输出以下结果：

value1
[('key1', 'value1'), ('key2', 'value2')]

示例2

本示例中，我们来修改example.ini文件中的配置信息，代码如下：

import configparser

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

# 读取INI文件中的配置信息
conf.read('example.ini')

# 修改值
conf.set('section1', 'key1', 'new_value')

# 保存修改
with open('example.ini', 'w') as f:
    conf.write(f)

完成后，example.ini文件内容变为：

[section1]
key1 = new_value
key2 = value2

注意事项

• configparser模块不支持多线程，不要在多线程环境下使用；
• configparser模块在Python 3.5版本以前存在一些bug，建议使用Python 3.5及以上版本。