快捷導(dǎo)航

Python3讀寫ini配置文件的示例

更新時間：2020年11月06日 11:33:55 作者：臨淵

這篇文章主要介紹了Python3讀寫ini配置文件的示例，幫助大家更好的理解和使用python，感興趣的朋友可以了解下

ini文件即Initialization File初始化文件，在應(yīng)用程序及框架中常作為配置文件使用，是一種靜態(tài)純文本文件，使用記事本即可編輯。
配置文件的主要功能就是存儲一批變量和變量值，在ini文件中使用[章(Section)]對變量進(jìn)行了分組，基本格式如下。

# 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。
使用配置文件的好處在于，不用修改代碼文件就可以更改使用的用戶、數(shù)據(jù)庫以及日志的配置，避免修改代碼帶來新的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段的數(shù)據(jù)類似于一個字典，可以使用['變量名']或者.get('變量名')獲取對應(yīng)的值，獲取到的是字符串格式。
其他常用的讀取方法如下：

conf.sections(): 獲取所有的section名，結(jié)果['user', 'mysql', 'log']
conf['mysql']['port']: 獲取section端port變量的值，字符串格式
conf['mysql'].get('port'): 同上，字符串格式
conf.get('mysql', 'port'): 同上，字符串格式
conf['mysql'].getint('port'): 獲取對應(yīng)變量的整型值
conf['mysql'].getfloat('port'): 獲取對應(yīng)變量的浮點型值
conf['user'].getboolean('is_admin'): 獲取對應(yīng)變量的布爾值，支持配置為yes/no, on/‘off, true/false 和 1/0，都可以轉(zhuǎn)化為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變量組都有一批相同的重復(fù)變量，如：

[dev]
# 開發(fā)環(huán)境
user=admin
password=123456
base_url=http://localhost:7777

[test]
# 測試環(huán)境
user=admin
password=123456
base_url=http://test.abc.com

[prod]
# 生產(chǎn)環(huán)境
user=admin
password=123456
base_url=http://www.abc.com

對應(yīng)這種，我們可以設(shè)置[DEFAULT]段公用變量，公用變量會自動添加到每一個段中，修改后如下。

[DEFAULT]
user=admin
password=123456

[dev]
# 開發(fā)環(huán)境
base_url=http://localhost:7777

[test]
# 測試環(huán)境
base_url=http://test.abc.com

[prod]
# 生產(chǎn)環(huán)境
base_url=http://www.abc.com

在Python文件中使用conf['test']['user']同樣能獲取到變量的值。

參數(shù)化

在ini文件中我們還可以使用%(變量名)s的占位符進(jìn)行參數(shù)化，這種特性被稱為Interpolation(插值)。
比如一個接口，不同的參數(shù)對應(yīng)不同的場景，示例如下。

[DEFAULT]
url = %(base_url)s/get?a=%(a)s&b=%(b)s
base_url=https://httpbin.org

[dev]
# 開發(fā)環(huán)境
base_url=http://localhost:5555
a=1
b=2

[prod-case1]
# 生成環(huán)境-場景1
a=1
b=2

[prod-case2]
# 生成環(huán)境-場景2
a=kevin
b=male

上例中，我們在[DEFAULT]段設(shè)置了一個參數(shù)化的公用變量url，其中埋設(shè)了三個占位符，%(base_url)s、%(a)s、和%(b)s。
并且我們設(shè)置了base_url變量的默認(rèn)值為https://httpbin.org。
當(dāng)下面的section中沒有覆蓋該變量時，如prod-case1和prod-case2中，是用base_url的默認(rèn)值。

注意：每個section段中，加上默認(rèn)變量base_url，必須提供所有參數(shù)化變量的值，比如此例中每個段最少必須設(shè)置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必須為字符串形式，可以設(shè)置DEFAULT字段的值
conf.remove_option(section, option)：移除指定section下指定變量
conf.remove_section(section)：移除section
conf.write(f)：保存ini文件

動態(tài)組裝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') # 可以設(shè)置DEFAULT段的值
conf.set('DEFAULT', 'base_url', 'https://httpbin.org') # 可以設(shè)置DEFAULT段的值
conf.add_section('dev')
conf.set('dev', 'base_url', '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)

運行打印結(jié)果如下：

http://localhost:5555/get?a=1&b=2
https://httpbin.org/get?a=1&b=2
https://httpbin.org/get?a=kevin&b=male

生成的文件內(nèi)容如下。

[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配置文件的示例的詳細(xì)內(nèi)容，更多關(guān)于python 讀寫ini的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: