python中的configparser模块操作ini文件详解

configparser 模块提供的方法比较多，这里列出所有方法，并给出简单的示例。

首先是 ConfigParser 类的方法：

read(filenames, encoding=None)：从指定的文件（或列表中的文件）中读取配置数据，如果文件不存在则不会发生任何事情。filenames 参数可以是一个字符串或一个字符串列表，表示要读取的文件名或文件名列表。encoding 参数用于指定文件的编码格式，默认为 None，表示使用系统默认编码。

import configparser

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

read_file(f, source=None)：从指定的文件对象 f 中读取配置数据。如果 source 参数被提供，它将被用作文件名，以便在错误消息中引用

import configparser

with open('config.ini') as f:
    config = configparser.ConfigParser()
    config.read_file(f)

read_string(string, source='<string>')：从指定的字符串 string 中读取配置数据，并可选地提供一个 source 参数，用于在错误消息中引用。

import configparser

config = configparser.ConfigParser()
config.read_string("""
[general]
log_level = INFO
""")

read_dict(dictionary, source='<dict>')：从指定的字典 dictionary 中读取配置数据，并可选地提供一个 source 参数，用于在错误消息中引用。

import configparser

config = configparser.ConfigParser()
config.read_dict({
    'general': {
        'log_level': 'INFO',
    }
})

sections()：返回配置文件中所有节的名称列表。

import configparser

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

has_section(section)：如果存在一个名为 section 的节，则返回 True，否则返回 False。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
has_section = config.has_section('general')
print(has_section)

options(section)：返回指定节中所有选项（键）的名称列表。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
options = config.options('general')
print(options)

has_option(section, option)：如果存在一个名为 option 的选项（键）在 section 节中，则返回 True，否则返回 False。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
has_option = config.has_option('general', 'log_level')
print(has_option)

get(section, option, *, raw=False, vars=None, fallback=_UNSET)：返回 section 节中 option 选项（键）的值。如果 option 不存在，则抛出 NoOptionError 异常。raw 参数指定是否对返回值进行插值处理。vars 参数指定一个字典，用于替换值中的变量。fallback 参数指定一个默认值，用于在选项不存在时返回。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
log_level = config.get('general', 'log_level')
print(log_level)

getint(section, option, *, raw=False, vars=None, fallback=_UNSET)：获取指定 section 节中 option 选项（键）的整数值。如果 option 不存在或无法转换为整数，则抛出 NoOptionError 或 ValueError 异常。raw、vars、fallback 参数与 get() 方法相同。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
timeout = config.getint('general', 'timeout')
print(timeout)

getfloat(section, option, *, raw=False, vars=None, fallback=_UNSET)：获取指定 section 节中 option 选项（键）的浮点数值。如果 option 不存在或无法转换为浮点数，则抛出 NoOptionError 或 ValueError 异常。raw、vars、fallback 参数与 get() 方法相同。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
timeout = config.getfloat('general', 'timeout')
print(timeout)

getboolean(section, option, *, raw=False, vars=None, fallback=_UNSET)：获取指定 section 节中 option 选项（键）的布尔值。如果 option 不存在或无法转换为布尔值，则抛出 NoOptionError 或 ValueError 异常。raw、vars、fallback 参数与 get() 方法相同。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
log_level_enabled = config.getboolean('general', 'log_level_enabled')
print(log_level_enabled)

set(section, option, value)：设置 section 节中 option 选项（键）的值为 value。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
config.set('general', 'timeout', '120')

write(fileobject, space_around_delimiters=True)：将配置数据写入指定的文件对象 fileobject 中。如果 space_around_delimiters 参数为 True，则会在等号前后添加空格。

import configparser

config = configparser.ConfigParser()
config.read('config.ini')
with open('new_config.ini', 'w') as f:
    config.write(f)

optionxform(optionstr)：将选项名称转换为内部格式的方法。默认情况下，选项名称是不区分大小写的，但可以通过覆盖此方法来更改这一行为。

import configparser

class MyConfigParser(configparser.ConfigParser):
    def optionxform(self, optionstr):
        return optionstr.upper()

config = MyConfigParser()
config.read_string("""
[general]
log_level = INFO
""")
log_level = config.get('general', 'LOG_LEVEL')
print(log_level)

下面是 ConfigParser 类的属性：

DEFAULTSECT：表示默认节的名称，默认为 'DEFAULT'。

import configparser

config = configparser.ConfigParser()
print(config.DEFAULTSECT)

default_section：表示默认节的名称，等同于 DEFAULTSECT 属性。

import configparser

config = configparser.ConfigParser()
print(config.default_section)

sections()：返回配置文件中所有节的名称列表。

import configparser

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

optionxform：将选项名称转换为内部格式的方法，默认为小写。可以通过覆盖此方法来更改这一行为。

import configparser

class MyConfigParser(configparser.ConfigParser):
    def optionxform(self, optionstr):
        return optionstr.upper()

config = MyConfigParser()
config.read_string("""
[general]
log_level = INFO
""")
log_level = config.get('general', 'LOG_LEVEL')
print(log_level)

最后是 ConfigParser 类的一些私有方法和属性，这些方法和属性不建议在用户代码中使用：

_interpolate(section, option, rawval, vars)：用变量替换选项（键）中的占位符。

_interpolate_some(parser, option, accum, rest, section, map, depth)：支持 _interpolate() 方法的辅助方法。

_get_conv(self, section, option)：获取选项（键）值的转换器。

_get(self, section, conv, option, **kwargs)：获取选项（键）的值。

_get_default(self, section, conv, option, **kwargs)：获取默认值。

_read(self, fp, fpname)：从文件中读取配置数据，是 read()、read_file()、read_string() 和 read_dict() 方法的底层实现。

_parse_section(self, section_name, section_body)：解析节并返回一个字典。

_parse_ini(self, content)：解析 INI 文件并返回一个字典。