一般用来调整配置档,配置档一般是ini文件或者conf文件
配置文件一般是一个一个section,每个 section下有很多组数值,一般是一一对应,不能存在数组的
# database source
[db]
host = 127.0.0.1
port = 3306
user = root
pass = root
# ssh
[ssh]
host = 192.168.1.101
user = huey
pass = huey123
host = 192.168.1.101
ConfigParser 的基本操作
a) 实例化 ConfigParser 并加载配置文件
cp = ConfigParser.SafeConfigParser()
cp.read('myapp.conf')
b) 获取 section 列表、option 键列表和 option 键值元组列表
print 'all sections:', cp.sections() # sections: ['db', 'ssh']
print 'options of [db]:', cp.options('db') # options of [db]: ['host', 'port', 'user', 'pass']
print 'items of [ssh]:', cp.items('ssh') # items of [ssh]: [('host', '192.168.1.101'), ('user', 'huey'), ('pass', 'huey')]
c) 读取指定的配置信息
print 'host of db:', cp.get('db', 'host') # host of db: 127.0.0.1
print 'host of ssh:', cp.get('ssh', 'host') # host of ssh: 192.168.1.101
d) 按类型读取配置信息:getint、 getfloat 和 getboolean
print type(cp.getint('db', 'port')) # <type 'int'>
e) 判断 option 是否存在
print cp.has_option('db', 'host') # True
f) 设置 option
cp.set('db', 'host','192.168.1.102')
g) 删除 option
cp.remove_option('db', 'host')
h) 判断 section 是否存在
print cp.has_section('db') # True
i) 添加 section
cp.add_section('new_sect')
j) 删除 section
cp.remove_section('db')
k) 保存配置,set、 remove_option、 add_section 和 remove_section 等操作并不会修改配置文件,write 方法可以将 ConfigParser 对象的配置写到文件中
cp.write(open('myapp.conf', 'w'))
cp.write(sys.stdout)
Unicode 编码的配置
配置文件如果包含 Unicode 编码的数据,需要使用 codecs 模块以合适的编码打开配置文件。
myapp.conf
[msg]
hello = 你好
config_parser_unicode.py
import ConfigParser
import codecs
cp = ConfigParser.SafeConfigParser()
with codecs.open('myapp.conf', 'r', encoding='utf-8') as f:
cp.readfp(f)
print cp.get('msg', 'hello')
allow_no_value
通常情况下, option 是一个键值对。但是,当 SafeConfigParser 的参数 allow_no_value 设置成 True 时,它允许 option 不设置值而只是作为一个标识。
allow_no_value.conf
# option as Flag
[flag]
flag_opt
allow_no_value.py
import ConfigParser
cp = ConfigParser.SafeConfigParser(allow_no_value = True)
cp.read('myapp.conf')
print cp.get('flag', 'flag_opt'); # None
allow_no_value 默认设置成 False,此时如果配置文件中存在没有设置值的 option,在读取配置文件时将抛出异常 ConfigParser.ParsingError。当 allow_no_value 设置成 True 时,如果一个 option 没有设置值,has_option 方法会返回 True,get 方法会返回 None。