Python configparser标准库简介

Posted 2022-12-09 乐百川

如果你要使用Python处理类似ini这种格式的文件，那么肯定离不开configparser标准库，它使用起来很简单而且非常方便。下面就让我们来看看吧。

简单读写

读写ini文件非常简单，来看看下面的例子就明白了。首先要创建ConfigParser的实例，使用它则非常简单，基本上就和处理字典完全一样。处理完毕之后，调用ConfigParser的write方法并传递一个文件就可以将其保存下来了。读取时候更加简单，直接向read方法传递文件名即可。

import configparser

config_filename = 'config.ini'

config = configparser.ConfigParser()
config['default'] = 'name': '易天', 'age': 30, 'gender': 'male'
config['young'] = 'name': 'yitian', 'age': 20

with open(config_filename, 'w', encoding='utf8')as file:
    config.write(file)

config2 = configparser.ConfigParser()
config2.read(config_filename, encoding='utf8')
for section in config2.sections():
    print(f'[section]')
    for key in config2[section]:
        print(f'key = config2[section][key]')

'''
[default]
name = 易天
age = 30
gender = male
[young]
name = yitian
age = 20
'''

另外还有几个read函数，用于从其他地方读取配置。

• read_file，从文件读取配置，参数是一个已经打开的文件
• read_string，从字符串读取配置，参数是一个配置字符串
• read_dict，从字典读取配置，参数是一个字典

处理数据类型

所有的数据类型都是字符串类型，如果你需要使用其他数据类型，需要自己手动转换。不过你也可以使用getXXX函数来直接获取某种类型的数据，这样的函数有getint、getfloat、getbooloean，如果你需要的话，还可以自己添加自定义数据类型的处理函数。

print(type(config['default']['age']))
print(type(int(config['default']['age'])))
print(type(config['default'].getint('age')))
'''
<class 'str'>
<class 'int'>
<class 'int'>
'''

默认值和备用值

在获取值的时候，假如没有这个值，我们可以给get参数添加第二个值来获得一个备用值，这种方法对于getint、getfloat、getboolean方法等同样适用。

但是如果配置文件中存在DEFAULT章节，而且默认章节设置了某个值的话，就会用这里的默认值取代备用值，因此在使用的时候大家要注意一下。

字符串插入

配置文件中可以引用其他选项，可以通过在ConfigParser构造函数中传入interpolation参数来进行控制。

c = configparser.ConfigParser(
    interpolation=configparser.ExtendedInterpolation())
c.read_string(s)
print(c['young']['age'])

默认的插入是configparser.BasicInterpolation()，可以处理%(value)s格式的选项。这里的第二个age的值会是yitian2.

[DEFAULT]
name = yitian
age = 25
[young]
name = yitian2
age = %(name)s

还有一种是configparser.ExtendedInterpolation()，功能更强，可以引用其他章节的选项。它的格式是$value。这里的第二个age会是yitian，如果要引用本章节的选项，可以省去section:章节，只保留变量名。

[DEFAULT]
name = yitian
age = 25
[young]
name = yitian2
age = $DEFAULT:name

如果不需要任何插入和转换，可以直接将interpolation指定为None，这样ConfigParser就会原样读取字符串。

c = configparser.ConfigParser(interpolation=None)

实用函数

ConfigParser还包含了一些使用函数，在我们处理配置文件的时候非常有用。

函数名	作用
sections()	返回所有章节组成的列表，不包括默认章节
add_section(section)	添加一个新的章节
has_section(section)	判断该章节是否存在
options(section)	返回该章节下的所有选项列表
has_options(section,option)	判断给定章节下是否存在某选项
remove_options(section,option)	删除给定章节下的某个选项
remove_section(section)	删除某个章节

还有一些函数不太常用，这里我就不介绍了。对于大部分情况，其实上面这些已经足够用了。