INI配置文件读写实例

INI配置文件格式

ini配置文件是一种使用比较广泛的程序配置文件，格式很简单，最基本的有下面几条

• 三个概念：section、option、value
• 配置文件中可以包含多个section，每个section下面可以有多个option
• section以[]括起来；除了[DEFAULT]其他section名称可以自定义

  注意，名称字符串前后如果有空格，则对应section名称是包含空格的

• option/value类似dict的key/value对，以=或者:分隔
• 默认情况下，section名称区分大小写，但option不区分大小写
• 注释以#或者;开头

例如：

[DEFAULT]
Port = 8080
Ip = 127.0.0.1

[topsecret.server.com]
Port = 50022
ForwardX11 = no

一个实例

import configparser

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

print([item for item in config.items()])

default = config['DEFAULT']

try:
    config['default']    # section区分大小写，这里就会报错，找不到'default'这个section
except KeyError as err:
    print('key err: ' + str(err))

print(default.get('port'))
print(default.get('PORT'))    # option不区分大小写

default['port']='8081'   # 修改option的值的方法一
print(default.get('port'))

config.set('DEFAULT', 'port', '8082')  # 修改option的值的方法二
print(default.get('port'))

with open('test.ini', 'w') as fd:
    config.write(fd)    # 将config中存储的最终结果写入到文件

执行结果

[('DEFAULT', <Section: DEFAULT>), ('topsecret.server.com', <Section: topsecret.server.com>)]
key err: 'default'
8080
8080
8081
8082

configparser模块

python的configparser模块对大范围的可用 INI 样式提供支持，并且对更多的用法也进行了扩展，并且支持用户自行扩展实现

ConfigParser类

此类是configparser模块操作INI配置文件的最基本也是最常用的实现
此类提供以下几类方法，使用这些方法完全可以满足大部分需求

• 输入/输出

  接口	说明
  read(filenames, encoding=None)	通过ini文件名读取配置信息
  read_file(f, source=None)	通过ini文件句柄读取配置信息
  read_string(string, source='<string>')	通过字符串读取配置信息
  read_dict(dictionary, source='<dict>')	从任意一个提供了类似于字典的 items() 方法的对象加载配置
  write(fileobject, space_around_delimiters=True)	将配置的表示形式写入指定的 file object，该对象必须以文本模式打开（接受字符串）

• 查询类

  接口	说明
  defaults()	获取DEFAULT这个section的详细信息
  sections()	获取当前配置信息中所有section的列表
  options(section)	以反序形式返回对应section的所有option信息

• 操作类

  接口	说明
  get(section, option, *, raw=False, vars=None[, fallback])	获取对应section下option的值，如果提供了 vars（参数中的'*'），则它必须为一个字典。option 的查找顺序为 vars（如果有提供）、section 以及 DEFAULTSECT。 如果未找到该键并且提供了 fallback，则它会被用作回退值。
  getint(section, option, *, raw=False, vars=None[, fallback])	将在指定 section 中的 option 强制转换为整数返回。参数定义同get接口
  getfloat(section, option, *, raw=False, vars=None[, fallback])	将在指定 section 中的 option 强制转换为浮点数返回。参数定义同get接口
  getboolean(section, option, *, raw=False, vars=None[, fallback])	将在指定 section 中的 option 强制转换为布尔值返回，默认'1', 'yes', 'true' 和 'on'返回True; '0', 'no', 'false' 和 'off'返回False。参数定义同get接口
  set(section, option, value)	如果给定的节存在，则将所给出的选项设为指定的值；在其他情况下将引发 NoSectionError。 option 和 value 必须为字符串；如果不是则将引发 TypeError。
  add_section(section)	向实例添加一个名为 section 的节。 如果给定名称的节已存在，将会引发 DuplicateSectionError。 如果传入了 default section 名称，则会引发 ValueError。 节名称必须为字符串；如果不是则会引发 TypeError。
  remove_option(section, option)	将指定的 option 从指定的 section 中移除。 如果指定的节不存在则会引发 NoSectionError。 如果要移除的选项存在则返回 True；在其他情况下将返回 False。
  remove_section(section)	将指定的 section 移除。如果要移除的section存在则返回 True；在其他情况下将返回 False。

  说明：

  • get接口还可以使用类似数组下标的访问方式，例如config['section']或者config['section']['option']
  • getboolean接口，可以通过设置ConfigParser.BOOLEAN_STATES来自定义哪些可以返回True，哪些值可以返回False

• 判断类

  接口	说明
  has_section(section)	判断 section 是否存在于配置中。 default section 不包含在内。
  has_option(section, option)	如果给定的 section 存在并且包含给定的 option 则返回 True；否则返回 False。 如果指定的 section 为 None 或空字符串，则会使用 DEFAULT。

BasicInterpolation类

此类在基本的ini格式中，满足用户可以通过在同一个section中使用$(option)s类似变量形式来访问已经定义好的option，例如

[Paths]
home_dir: /Users
my_dir: %(home_dir)s/lumberjack   # 等同于/Users/lumberjack

ExtendedInterpolation类

此类在基本的ini格式中，满足用户可以通过在任意一个section中使用${section:option}类似变量形式来访问已经定义好的option(如果在同一个section时可以使用${option})，例如：

[Paths]
home_dir: /Users
my_dir: %(home_dir)s/lumberjack   # 等同于/Users/lumberjack

[TempPath]
tmp: ${Path:home_dir}/tmp

自定义扩展

参考官方文档：定制解析器行为

异常

常用的异常有以下几个

• configparser.NoSectionError：当找不到指定节时引发的异常。
• configparser.DuplicateSectionError：当调用 add_section() 时传入已存在的节名称，或者在严格解析器中当单个输入文件、字符串或字典内出现重复的节时引发的异常。
• configparser.NoOptionError、configparser.DuplicateOptionError：与上面两个类似，这里是option有问题时报错
• configparser.ParsingError：当尝试解析一个文件而发生错误时引发的异常。

参考官方文档：异常