ConfigParser 模块在Python 3中已经重命名为 configparser.2to3 转换工具会自适应将要导入转成3中所需要包.

注意 该库不能内插或写入值类型前缀，该功能仅能在Windows下扩展注册表的INI语法分析器版本中实现

另请参阅

模块 shlex

支持创建类unix的迷你语言，该语言能为应用配置文件创建交互式的格式

模块 json

该json模式实现了JAVA脚本语法的子集，该子集合能用作配置文件的目的

另请参阅

Module shlex

支持创建类unix的迷你语言，该语言能为应用配置文件创建交互式的格式

  1. RawConfigParser Objects

RawConfigParser 实例有下面的方法：

RawConfigParser.defaults()

返回一个字典包含全实例的默认值

RawConfigParser.sections()

返回一个有效的section的列表，DEFAULT不包含在这个列表中.

RawConfigParser.add_section(section)

增加一个section到实例中.如果给定的章节名已存在的话，会触发DuplicateSectionError异常。如果传递的值为DEFAULT,或任何大小写敏感的变量，会触发一个ValueError异常

RawConfigParser.has_section(section)

显示section名是否已经在配置文件中存在，DEFAULT章节不被接受。

RawConfigParser.options(section)

在专门的section中返回一个有效的section的列表

RawConfigParser.has_option(section, option)

如果已给的section存在并包括已给的option的话，返回 True；否则返回 False

RawConfigParser.read(filenames)

尝试读取并分析一个文件名列表，返回一个成功分析的文件名列表。 如果文件名是一个字符串或Unicode字符串.以单个文件名对待，如果文件不能被打开，则会被忽视。 

import ConfigParser, os

config = ConfigParser.ConfigParser()
config.readfp(open(‘defaults.cfg‘))
config.read([‘site.cfg‘, os.path.expanduser(‘~/.myapp.cfg‘)])

RawConfigParser.readfp(fp[, filename])

从一个文件或者类文件fp对象中读并分析配置文件(仅使用readline()方法)，如果文件名被忽略并且有fp一个name属性，那么就会用作文件名，默认值为:<???>.

RawConfigParser.get(section, option)

从命名的章节中获取选项值.

RawConfigParser.getint(section, option)

一个很方便的方法，专门用来强制转换选项中的值为整数.

RawConfigParser.getfloat(section, option)

一个很方便的方法，专门用来强制转换选项中的值为否点数.

RawConfigParser.getboolean(section, option)

一个很方便的方法，专门用来强制转换选项中的值为布尔值.注意:可接受的值是:

"1", "yes", "true", and "on"=> True

"0", "no", "false", and "off"=> False。

这些字符串值是大小写敏感。任何其他的值会触发ValueError异常。 

RawConfigParser.items(section)

为提供的章节的每个选项返回一个(name, value) 对。

RawConfigParser.set(section, option, value)

如果提供的章节存在，那么设置为专门提供的值，否则会触发NoSectionError异常。

RawConfigParser.write(fileobject)

写配置文件到专门的文件对象。该表示法能被read()方法调用。

RawConfigParser.remove_option(section, option)

从指定的章节中移除可选项，如果章节不存在，则会触发NoSectionError异常。

如果已存在的选项被移除，会返回True,否则返回False.

RawConfigParser.remove_section(section)

从配置文件中移除指定的章节。如果指定的章节的确存在的话，会返回True,否则返回False.

RawConfigParser.optionxform(option)

Transforms the option name option as found in an input file or as passed in by client code to the form that should be used in the internal structures. The default implementation returns a lower-case version of option; subclasses may override this or client code can set an attribute of this name on instances to affect this behavior.

You don’t necessarily need to subclass a ConfigParser to use this method, you can also re-set it on an instance, to a function that takes a string argument. Setting it to str, for example, would make option names case sensitive:

cfgparser = ConfigParser()
...
cfgparser.optionxform = str

Note that when reading configuration files, whitespace around the option names are stripped before optionxform() is called.

  2. ConfigParser Objects

ConfigParser类在RawConfigParser接口的基础上扩展了一些方法，增加了一些可选的参数

ConfigParser.get(section, option[, raw[, vars]])

如果获得一个section下面的option值.如果vars提供，它必须是一个字典.如果vars参数提供的话，选项从section找，并按照默认的顺序.

所有的‘%‘内插都返回扩展值，除非raw参数为真.内插的对应键的值和选项中寻址方式一样.

ConfigParser.items(section[, raw[, vars]])

如果返回一个(name, value)队.选项参数同get()方法具有同样的意思。

  3. SafeConfigParser Objects

SafeConfigParser类实现了的类似ConfigParser接口模块，下面是其增添部分:

SafeConfigParser.set(section, option, value)

如果给定的section存在的话，设置成专门的值；否则触发NoSectionError异常.值必须是个字符型(str或者unicode)，

如果不是的话，会触发TypeError错误.

  4. Examples

下面是如何写一个配置文件的例子:

import ConfigParser

config = ConfigParser.RawConfigParser()

# When adding sections or items, add them in the reverse order of
# how you want them to be displayed in the actual file.
# In addition, please note that using RawConfigParser‘s and the raw
# mode of ConfigParser‘s respective set functions, you can assign
# non-string values to keys internally, but will receive an error
# when attempting to write to a file or when you get it in non-raw
# mode. SafeConfigParser does not allow such assignments to take place.
config.add_section(‘Section1‘)
config.set(‘Section1‘, ‘an_int‘, ‘15‘)
config.set(‘Section1‘, ‘a_bool‘, ‘true‘)
config.set(‘Section1‘, ‘a_float‘, ‘3.1415‘)
config.set(‘Section1‘, ‘baz‘, ‘fun‘)
config.set(‘Section1‘, ‘bar‘, ‘Python‘)
config.set(‘Section1‘, ‘foo‘, ‘%(bar)s is %(baz)s!‘)

# 写我们的配置文件到‘example.cfg‘中
with open(‘example.cfg‘, ‘wb‘) as configfile:
    config.write(configfile)

下面是如何再次读取配置文件的例子:

import ConfigParser

config = ConfigParser.RawConfigParser()
config.read(‘example.cfg‘)

# getfloat()函数会触发一个异常如果值不是浮点型
# getint()函数 和 getboolean()函数也会触发各自类型的异常错误
a_float = config.getfloat(‘Section1‘, ‘a_float‘)
an_int = config.getint(‘Section1‘, ‘an_int‘)
print a_float + an_int

# 注意下面的输出结果不会内插‘%(bar)s‘ 或者 ‘%(baz)s‘.
# 这是因为我们在用RawConfigParser()函数
if config.getboolean(‘Section1‘, ‘a_bool‘):
    print config.get(‘Section1‘, ‘foo‘)

要想内插，需要使用ConfigParser类或者改类的方法SafeConfigParser:

import ConfigParser

config = ConfigParser.ConfigParser()
config.read(‘example.cfg‘)

# 设置第三可选参数为1如果你想使用原始的模式
print config.get(‘Section1‘, ‘foo‘, 0) # -> "Python is fun!"
print config.get(‘Section1‘, ‘foo‘, 1) # -> "%(bar)s is %(baz)s!"

# 第四可选项是一个字典，里面的成员在内插时可优先处理
print config.get(‘Section1‘, ‘foo‘, 0, {‘bar‘: ‘Documentation‘,
                                        ‘baz‘: ‘evil‘})

一般来说:在三种ConfigParser类型都是使用默认值。他们用于插入如果选项没有在其他地方定义的话。

import ConfigParser

# 新实例用‘bar‘ 和 ‘baz‘ 默认用 ‘Life‘ 和 ‘hard‘取代
config = ConfigParser.SafeConfigParser({‘bar‘: ‘Life‘, ‘baz‘: ‘hard‘})
config.read(‘example.cfg‘)

print config.get(‘Section1‘, ‘foo‘)      #"Python is fun!"
config.remove_option(‘Section1‘, ‘bar‘)
config.remove_option(‘Section1‘, ‘baz‘)
print config.get(‘Section1‘, ‘foo‘)      #"Life is hard!"

下面的opt_move函数能用于移除章节之间的选项:

def opt_move(config, section1, section2, option):
    try:
        config.set(section2, option, config.get(section1, option, 1))
    except ConfigParser.NoSectionError:
        # 创建不存在的章节section2
        config.add_section(section2)
        opt_move(config, section1, section2, option)
    else:
        config.remove_option(section1, option)

一些配置文件无值设置其实早就为人所知，但是另外一方面讲也符合ConfigParser模块的支持。构造器允许无值参数暗示无值也是支持的。

>>> import ConfigParser
>>> import io

>>> sample_config = """
... [mysqld]
... user = mysql
... pid-file = /var/run/mysqld/mysqld.pid
... skip-external-locking
... old_passwords = 1
... skip-bdb
... skip-innodb
... """
>>> config = ConfigParser.RawConfigParser(allow_no_value=True)
>>> config.readfp(io.BytesIO(sample_config))

>>> # 如果选项中的值存在的话，则获取定义的值:
>>> config.get("mysqld", "user")
‘mysql‘

>>> # 如果选项中的值不存在的话，则获取默认值:None
>>> config.get("mysqld", "skip-bdb")

>>> # 如果选项本身都不存在的话，则会触发一个异常:
>>> config.get("mysqld", "does-not-exist")
Traceback (most recent call last):
  ...
ConfigParser.NoOptionError: No option ‘does-not-exist‘ in section: ‘mysqld‘