Python3讀寫ini配置檔案的示例
ini檔案即Initialization File初始化檔案,在應用程式及框架中常作為配置檔案使用,是一種靜態純文字檔案,使用記事本即可編輯。
配置檔案的主要功能就是儲存一批變數和變數值,在ini檔案中使用[章(Section)]對變數進行了分組,基本格式如下。
# filename: config.ini [user] name=admin password=123456 is_admin=true [mysql] host=10.10.10.10 port=3306 db=apitest user=root password=123456 [log] file=run.log level=info
以上檔案中,有3個Section段,分別user、mysql和log。
使用配置檔案的好處在於,不用修改程式碼檔案就可以更改使用的使用者、資料庫以及日誌的配置,避免修改程式碼帶來新的bug,或需要重新打包(如Java專案中)。
ini檔案中使用#或者;添加註釋,最好獨佔一行,不能寫在變數後面
讀取
讀取ini配置檔案需要使用Python3自帶的configparser庫,使用示例如下
from configparser import ConfigParser # Python2中是from ConfigParser import ConfigParser conf = ConfigParser() # 需要例項化一個ConfigParser物件 conf.read('config.ini') # 需要新增上config.ini的路徑,不需要open開啟,直接給檔案路徑就讀取,也可以指定encoding='utf-8' print(conf['user']['name']) # 讀取user段的name變數的值,字串格式
conf物件每個section段的資料類似於一個字典,可以使用['變數名']或者.get('變數名')獲取對應的值,獲取到的是字串格式。
其他常用的讀取方法如下:
- conf.sections(): 獲取所有的section名,結果['user','mysql','log']
- conf['mysql']['port']: 獲取section端port變數的值,字串格式
- conf['mysql'].get('port'): 同上,字串格式
- conf.get('mysql','port'): 同上,字串格式
- conf['mysql'].getint('port'): 獲取對應變數的整型值
- conf['mysql'].getfloat('port'): 獲取對應變數的浮點型值
- conf['user'].getboolean('is_admin'): 獲取對應變數的布林值,支援配置為yes/no,on/‘off,true/false 和 1/0,都可以轉化為Python中的True/False
- conf.has_section(section):檢查是否有該section
- conf.options(section):輸出section中所有的變數名
- conf.has_option(section,option):檢查指定section下是否有該變數值
如果想遍歷一個section所有的變數和值,可以像遍歷字典意義操作,示例如下。
for key,value in conf['mysql'].items(): print(key,value)
注意:ini檔案中的變數名是大小寫不敏感的,而Section名是大小寫敏感的。
公共變數
假如我們每個Section變數組都有一批相同的重複變數,如:
[dev] # 開發環境 user=admin password=123456 base_url=http://localhost:7777 [test] # 測試環境 user=admin password=123456 base_url=http://test.abc.com [prod] # 生產環境 user=admin password=123456 base_url=http://www.abc.com
對應這種,我們可以設定[DEFAULT]段公用變數,公用變數會自動新增到每一個段中,修改後如下。
[DEFAULT] user=admin password=123456 [dev] # 開發環境 base_url=http://localhost:7777 [test] # 測試環境 base_url=http://test.abc.com [prod] # 生產環境 base_url=http://www.abc.com
在Python檔案中使用conf['test']['user']同樣能獲取到變數的值。
引數化
在ini檔案中我們還可以使用%(變數名)s的佔位符進行引數化,這種特性被稱為Interpolation(插值)。
比如一個介面,不同的引數對應不同的場景,示例如下。
[DEFAULT] url = %(base_url)s/get?a=%(a)s&b=%(b)s base_url=https://httpbin.org [dev] # 開發環境 base_url=http://localhost:5555 a=1 b=2 [prod-case1] # 生成環境-場景1 a=1 b=2 [prod-case2] # 生成環境-場景2 a=kevin b=male
上例中,我們在[DEFAULT]段設定了一個引數化的公用變數url,其中埋設了三個佔位符,%(base_url)s、%(a)s、和%(b)s。
並且我們設定了base_url變數的預設值為https://httpbin.org。
當下面的section中沒有覆蓋該變數時,如prod-case1和prod-case2中,是用base_url的預設值。
注意:每個section段中,加上預設變數base_url,必須提供所有引數化變數的值,比如此例中每個段最少必須設定a和b的值,否則會報錯。
在Python指令碼中列印conf['prod-case2']['url'],可以得到組裝後的url。
https://httpbin.org/get?a=kevin&b=male
修改儲存
conf物件常用的修改如下:
- conf.add_section(section):新增section
- conf.set(section,option,value): 在指定section中新增變數和變數值,section必須存在或已新增,value必須為字串形式,可以設定DEFAULT欄位的值
- conf.remove_option(section,option):移除指定section下指定變數
- conf.remove_section(section):移除section
- conf.write(f):儲存ini檔案
動態組裝conf檔案,示例如下。
from configparser import ConfigParser from configparser import ConfigParser conf = ConfigParser() # conf.read('httpbin.ini',encoding='utf-8') # 如果新建的話就不需要read,如果修改則需要使用read開啟 conf.set('DEFAULT','url','%(base_url)s/get?a=%(a)s&b=%(b)s') # 可以設定DEFAULT段的值 conf.set('DEFAULT','base_url','https://httpbin.org') # 可以設定DEFAULT段的值 conf.add_section('dev') conf.set('dev','http://localhost:5555') conf.set('dev','a','1') # 值必須是字串 conf.set('dev','b','2') conf['prod-case1'] = {'a': 1,'b': 2} # 直接使用字典新增多個變數 conf['prod-case2'] = {'a': 'kevin','b': 'male'} print(conf.get('dev','url')) print(conf.get('prod-case1','url')) print(conf.get('prod-case2','url')) # 儲存csv with open('httpbin.ini','w',encoding='utf-8') as f: conf.write(f)
執行列印結果如下:
http://localhost:5555/get?a=1&b=2 https://httpbin.org/get?a=1&b=2 https://httpbin.org/get?a=kevin&b=male
生成的檔案內容如下。
[DEFAULT] url = %(base_url)s/get?a=%(a)s&b=%(b)s base_url = https://httpbin.org [dev] base_url = http://localhost:5555 a = 1 b = 2 [prod-case1] a = 1 b = 2 [prod-case2] a = kevin b = male
以上就是Python3讀寫ini配置檔案的示例的詳細內容,更多關於python 讀寫ini的資料請關注我們其它相關文章!