Python3 中 configparser 模組解析配置的用法詳解

戴德滿發表於2019-02-28
Python

configparser 簡介

configparser 是 Pyhton 標準庫中用來解析配置檔案的模組，並且內建方法和字典非常接近。Python2.x 中名為 ConfigParser，3.x 已更名小寫，並加入了一些新功能。 配置檔案的格式如下：

[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 首先需要初始化例項，並讀取配置檔案：

>>> import configparser
>>> config = configparser.ConfigParser()	# 注意大小寫
>>> config.read("config.ini")	# 配置檔案的路徑
["config.ini"]
複製程式碼

或者可以直接讀字典

>>> 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

>>> config.sections()
['bitbucket.org', 'topsecret.com']    # 注意會過濾掉[DEFAULT]
複製程式碼

####獲取指定 section 的 keys & values

>>> config.items('topsecret.com')
>>>> [('port', '50022'), ('forwardx11', 'no')]    # 注意items()返回的字串會全變成小寫
複製程式碼

####獲取指定 section 的 keys

>>> config.options('topsecret.com')
['Port', 'ForwardX11']
複製程式碼
>>> for option in config['topsecret.com']:
...	    print(option)
Port
ForwardX11
複製程式碼

####獲取指定 key 的 value

>>> config['bitbucket.org']['User']
'Tom'
複製程式碼
>>> config.get('bitbucket.org', 'User')
'Tom'
>>> config.getint('topsecret.com', 'Port')
50022
複製程式碼

檢查

>>> 'DEFAULT' in config
True
>>> 'test' in config['section_test']
False
>>> 'Tom' in config['bitbucket.org']['User']
True
複製程式碼
>>> config.has_section('bitbucket.org')
True
>>> config.has_option('section_test', 'test')
False
複製程式碼

新增

>>> config.add_section('Section_1')
>>> config.set('Section_1', 'key_1', 'value_1')    # 注意鍵值是用set()方法
>>> config.write(open('config.ini', 'w'))    # 一定要寫入才生效
複製程式碼

####刪除

>>> 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] 一般包含 ini 格式配置檔案的預設項，所以 configparser 部分方法會自動跳過這個 section 。 前面已經提到 sections() 是獲取不到的，還有刪除方法對 [DEFAULT] 也無效：

>>> config.remove_section('DEFAULT')
False
>>> config.clear()
>>> 'DEFAULT' in config
True
>>> 'ForwardX11' in config['DEFAULT']
True
>>> config.sections()
[]
複製程式碼

但指定刪除和修改 [DEFAULT] 裡的 keys & values 是可以的：

>>> config.remove_option('DEFAULT', 'ForwardX11')
True
>>> config.set('DEFAULT', 'ForwardX11','no')
>>> config['DEFAULT']['ForwardX11']
'no'
複製程式碼

還有個特殊的是，has_section() 也無效，可以和 in 區別使用

>>> config.has_section('DEFAULT')
False
>>> 'DEFAULT' in config
True
複製程式碼

更多用法請看官方文件： docs.python.org/3.6/library…


微信公眾號

Python3 中 configparser 模組解析配置的用法詳解
新開了微信公眾號：面向人生程式設計
程式設計思維不應只存留在程式碼之中，更應伴隨於整個人生旅途，所以公眾號裡不只聊技術，還會聊產品/網際網路/經濟學等廣泛話題，所以也歡迎非程式設計師關注。

相關文章