51工具盒子configparser 简介 {#configparser-简介}
configparser 是 Pyhton 标准库中用来解析配置文件的模块，并且内置方法和字典非常接近。Python2.x 中名为 ConfigParser，3.x 已更名小写，并加入了一些新功能。
配置文件的格式如下：
|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 12 | hljs makefile [DEFAULT] ServerAliveInterval = 45 Compression = yes CompressionLevel = 9 ForwardX11 = yes [bitbucket.org] User = Tom [topsecret.com] Port: 50022 ForwardX11: no |
"[ ]"包含的为 section，section 下面为类似于 key - value 的配置内容；
configparser 默认支持 '=' '：' 两种分隔。
configparser 常用方法 {#configparser-常用方法}
初始化实例 {#初始化实例}
使用 configparser 首先需要初始化实例，并读取配置文件：
|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 | hljs python >>> import configparser >>> config = configparser.ConfigParser() # 注意大小写 >>> config.read("config.ini") # 配置文件的路径 ["config.ini"] |
或者可以直接读字典
|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 10 11 | hljs python >>> parser = configparser.ConfigParser() >>> parser.read_dict({'section1': {'key1': 'value1', ... 'key2': 'value2', ... 'key3': 'value3'}, ... 'section2': {'keyA': 'valueA', ... 'keyB': 'valueB', ... 'keyC': 'valueC'}, ... 'section3': {'foo': 'x', ... 'bar': 'y', ... 'baz': 'z'} ... }) |
获取所有 sections {#获取所有-sections}
|-------------|--------------------------------------------------------------------------------------------------|
| 1 2 | hljs python >>> config.sections() ['bitbucket.org', 'topsecret.com'] # 注意会过滤掉[DEFAULT] |
获取指定 section 的 keys & values {#获取指定-section-的-keys-amp-values}
|-------------|-------------------------------------------------------------------------------------------------------------------------------|
| 1 2 | hljs python >>> config.items('topsecret.com') >>> [('port', '50022'), ('forwardx11', 'no')] # 注意items()返回的字符串会全变成小写 |
获取指定 section 的 keys {#获取指定-section-的-keys}
|-------------|-------------------------------------------------------------------------------|
| 1 2 | hljs python >>> config.options('topsecret.com') ['Port', 'ForwardX11'] |
|-----------------|-----------------------------------------------------------------------------------------------------|
| 1 2 3 4 | hljs python >>> for option in config['topsecret.com']: ... print(option) Port ForwardX11 |
获取指定 key 的 value {#获取指定-key-的-value}
|-------------|--------------------------------------------------------------|
| 1 2 | hljs python >>> config['bitbucket.org']['User'] 'Tom' |
|-----------------|-------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 | hljs python >>> config.get('bitbucket.org', 'User') 'Tom' >>> config.getint('topsecret.com', 'Port') 50022 |
检查 {#检查}
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 | hljs python >>> 'DEFAULT' in config True >>> 'test' in config['section_test'] False >>> 'Tom' in config['bitbucket.org']['User'] True |
|-----------------|---------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 | hljs python >>> config.has_section('bitbucket.org') True >>> config.has_option('section_test', 'test') False |
添加 {#添加}
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 | hljs python >>> config.add_section('Section_1') >>> config.set('Section_1', 'key_1', 'value_1') # 注意键值是用set()方法 >>> config.write(open('config.ini', 'w')) # 一定要写入才生效 |
删除 {#删除}
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 | hljs python >>> config.remove_option('Section_1', 'key_1') True >>> config.remove_section('Section_1') True >>> config.clear() # 清空除[DEFAULT]之外所有内容 >>> config.write(open('config.ini', 'w')) |
关于 [DEFAULT] {#关于-default}
[DEFAULT] 一般包含 ini 格式配置文件的默认项，所以 configparser 部分方法会自动跳过这个 section 。
前面已经提到 sections() 是获取不到的，还有删除方法对 [DEFAULT] 也无效：
|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 6 7 8 9 | hljs python-repl >>> config.remove_section('DEFAULT') False >>> config.clear() >>> 'DEFAULT' in config True >>> 'ForwardX11' in config['DEFAULT'] True >>> config.sections() [] |
但指定删除和修改 [DEFAULT] 里的 keys & values 是可以的：
|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 1 2 3 4 5 | hljs python-repl >>> config.remove_option('DEFAULT', 'ForwardX11') True >>> config.set('DEFAULT', 'ForwardX11','no') >>> config['DEFAULT']['ForwardX11'] 'no' |
还有个特殊的是，has_section() 也无效，可以和 in 区别使用
|-----------------|-----------------------------------------------------------------------------------------|
| 1 2 3 4 | hljs python >>> config.has_section('DEFAULT') False >>> 'DEFAULT' in config True |
更多用法请看官方文档：
<https://docs.python.org/3.6/library/configparser.html
