關(guān)于Python，相比大家都不會(huì)陌生吧，那么，其中的一些配置文件是什么呢？有沒(méi)有可能給大家去進(jìn)行做一個(gè)匯總，匯總的內(nèi)容還是比較的多的，包含寫法等一些相關(guān)的知識(shí)，具體的一些相關(guān)匯總，下面給大家詳細(xì)解答下。

　　前言

　　在這篇文章里所提到的環(huán)境變量種類其多元性由上至下到另一個(gè)先后提升：ini為何要寫環(huán)境變量

　　在研發(fā)流程中，很多人都會(huì)使用一些固定不動(dòng)主要參數(shù)或者整型變量。對(duì)于這類相對(duì)固定不動(dòng)且經(jīng)常使用的一部分，通常會(huì)把它提到一種固定不動(dòng)文檔中，防止在不同控制模塊編碼中反復(fù)發(fā)生進(jìn)而維持核心內(nèi)容編碼干凈整潔。

　　這一個(gè)固定不動(dòng)相關(guān)文件大家能直接寫出一種.py文件，比如settings.py或config.py，如此的好處是可以在同一個(gè)工程下先通過(guò)import來(lái)導(dǎo)進(jìn)中的一部分；那如果我們應(yīng)該在其他非Python的平臺(tái)配置文檔共享時(shí)，寫出多帶帶.py也不是一個(gè)好的選擇。這時(shí)候我們就要挑選常用的環(huán)境變量種類來(lái)作存放這些固定一部分?，F(xiàn)階段常見(jiàn)且時(shí)興配置文件類型種類關(guān)鍵有ini、json、toml、yaml、xml等，這些類型的環(huán)境變量大家都可以通過(guò)標(biāo)準(zhǔn)庫(kù)或第三方庫(kù)來(lái)進(jìn)行解析。

　　ini

　　ini即Initialize初始化之意，早期是在Windows上配置文件的存儲(chǔ)格式。ini文件的寫法通俗易懂，往往比較簡(jiǎn)單，通常由節(jié)（Section）、鍵（key）和值（value）組成，就像以下形式：

　　[localdb]
　　host=127.0.0.1
　　user=root
　　password=123456
　　port=3306
　　database=mysql

　　Python本身內(nèi)置的configparser標(biāo)準(zhǔn)庫(kù)，我們直接就可以用來(lái)對(duì)ini文件進(jìn)行解析。如我們將上述內(nèi)容保存在一個(gè)名為db.ini的文件中，然后使用read()方法來(lái)進(jìn)行解析和讀取，最后通過(guò)items()方法來(lái)獲取指定節(jié)點(diǎn)下的所有鍵值對(duì)。

　　>>>from configparser import ConfigParser
　　>>>cfg=ConfigParser()
　　>>>cfg.read("/Users/Bobot/db.ini")
　　['/Users/Bobot/db.ini']
　　>>>cfg.items("localdb")
　　[('host','127.0.0.1'),('user','root'),('password','123456'),('port','3306'),('database','mysql')]

　　json

　　json格式可以說(shuō)是我們常見(jiàn)的一種文件形式了，也是目前在互聯(lián)網(wǎng)較為流行的一種數(shù)據(jù)交換格式。除此之外，json有時(shí)也是配置文件的一種。

　　比如npm（JavaScript包管理工具類似Python的pip）、以及微軟出品的目前被廣泛使用的VSCode編輯器，都使用json編寫配置參數(shù)。

　　和configparser一樣，Python也內(nèi)置了json標(biāo)準(zhǔn)庫(kù)，可以通過(guò)load()和loads()方法來(lái)導(dǎo)入文件式和字符串的json內(nèi)容。

　　{
　　"localdb":{
　　"host":"127.0.0.1",
　　"user":"root",
　　"password":"123456",
　　"port":3306,
　　"database":"mysql"
　　}
　　}

　　我們將上述內(nèi)容保存為db.json后進(jìn)行讀取和解析，json庫(kù)讀取json文件相對(duì)簡(jiǎn)單容易，而且很容易解析成Python的字典對(duì)象。

　　>>>import json
　　>>>from pprint import pprint
　　>>>
　　>>>with open('/Users/Bobot/db.json')as j:
　　...cfg=json.load(j)['localdb']
　　...
　　>>>pprint(cfg)
　　{'database':'mysql',
　　'host':'127.0.0.1',
　　'password':'123456',
　　'port':3306,
　　'user':'root'}

　　使用json文件配置的缺點(diǎn)就是語(yǔ)法標(biāo)準(zhǔn)嚴(yán)格限制，為人所詬病之一的就是無(wú)法在當(dāng)中寫注釋，除非采取json類型的其他超集作為替代方案（VSCode中能寫注釋的json參數(shù)配置文件便是代替方案的一種）；同時(shí)存在嵌套過(guò)深的問(wèn)題，容易導(dǎo)致出錯(cuò)，不宜用來(lái)寫過(guò)長(zhǎng)或復(fù)雜的參數(shù)配置信息。

　　toml

　　toml格式（或tml格式）是Github聯(lián)合創(chuàng)始人Tom Preston-Werner所提出的一種配置文件格式。根據(jù)維基百科的資料，toml最開始提出時(shí)是在2013年7月份，距今已有七年時(shí)間；它在某些方面也與后面要談到的yaml文件有些類似，但如果當(dāng)你知道yaml的規(guī)范有幾十頁(yè)（沒(méi)有錯(cuò)，真的就是幾十頁(yè)……）的時(shí)候，可能你真的就不太愿意去寫那么復(fù)雜的配置文件，toml格式則倒是個(gè)不錯(cuò)的選擇。

　　toml格式大致如下：

　　從這里可以看出toml有點(diǎn)類似于前面所講的ini文件。但是它比ini擴(kuò)展了更多的內(nèi)容。

　　在樣例圖片中我們可以看到，除了基本的字符串以外，例如時(shí)間戳、布爾值、數(shù)組等都進(jìn)一步支持，而且樣式和Python的原生寫法十分類似。

　　當(dāng)然這里不會(huì)過(guò)多介紹toml格式的一些規(guī)范說(shuō)明，有人已經(jīng)對(duì)官方的規(guī)范文檔進(jìn)行了翻譯，有興趣的朋友可以直接查閱。

　　這么契合Python方式的配置文件類型已經(jīng)有開發(fā)者造出了相應(yīng)的「輪子」，目前在Github上Stars數(shù)最多的是則是uiri/toml的版本，不過(guò)該版本僅通過(guò)了v0.5版本toml規(guī)范，但在使用上還是蠻簡(jiǎn)潔的，我們可以通過(guò)pip命令進(jìn)行安裝

　　pip install toml

　　該庫(kù)的解析方式很簡(jiǎn)單，也有點(diǎn)類似于json庫(kù)的解析用法，即通過(guò)load()或loads()來(lái)進(jìn)行解析；同理轉(zhuǎn)換并導(dǎo)出也是同樣類似的用法。

　　比如我們現(xiàn)在將以下內(nèi)容寫入到config.toml中：

　　[mysql]
　　host="127.0.0.1"
　　user="root"
　　port=3306
　　database="test"
　　[mysql.parameters]
　　pool_size=5
　　charset="utf8"
　　[mysql.fields]
　　pandas_cols=["id","name","age","date"]

　　緊接著我們就可以通過(guò)toml庫(kù)中的load()方法來(lái)進(jìn)行讀?。?/p>

　　>>>import toml
　　>>>import os
　　>>>from pprint import pprint
　　>>>cfg=toml.load(os.path.expanduser("~/Desktop/config.toml"))
　　>>>pprint(cfg)
　　{'mysql':{'database':'test',
　　'fields':{'pandas_cols':['id','name','age','date']},
　　'host':'127.0.0.1',
　　'parameters':{'charset':'utf8','pool_size':5},
　　'port':3306,
　　'user':'root'}}

　　可以看到toml文件被間接地轉(zhuǎn)化成了字典類型，當(dāng)然這也就是json版的寫法（將單引號(hào)替換成雙引號(hào)即可），方便我們后續(xù)調(diào)用或者傳參。

　　yaml

　　yaml格式（或yml格式）是目前較為流行的一種配置文件，它早在2001由一個(gè)名為Clark Evans的人提出；同時(shí)它也是目前被廣泛使用的配置文件類型，典型的就是Docker容器里的docker-compose.yml配置文件，如果經(jīng)常使用Docker進(jìn)行部署的人對(duì)此不會(huì)陌生。

　　yaml文件的設(shè)計(jì)從Python、XML等地方獲取靈感，所以在使用時(shí)能很清楚地看到這些部分的影子。

　　在上一節(jié)toml內(nèi)容里我曾提到，yaml的規(guī)范內(nèi)容可以說(shuō)是冗長(zhǎng)和復(fù)雜，足足有80頁(yè)之多（斗尊強(qiáng)者，恐怖如斯……）。

　　yaml規(guī)范頁(yè)數(shù)：

　　所以感興趣的朋友可以再自行了解相關(guān)用法。

　　YAML官方早已經(jīng)提供了相應(yīng)的Python庫(kù)進(jìn)行支持，即PyYAML；當(dāng)然也同樣需要我們事先進(jìn)行安裝：

　　pip install pyyaml

　　同json庫(kù)和toml庫(kù)一樣，通過(guò)load()方法來(lái)進(jìn)行加載。

　　需要注意的是，使用load()方法會(huì)存在一定的安全隱患，從思科Talos的這份報(bào)告中我們可以看到，如果加載了未知或不信任的yaml文件，那么有可能會(huì)存在被攻擊的風(fēng)險(xiǎn)和網(wǎng)絡(luò)安全隱患，因?yàn)樗軌蛑苯诱{(diào)用相應(yīng)的Python函數(shù)來(lái)執(zhí)行為攻擊者所需要的命令，比如說(shuō)在yaml文件中寫入這么一段：

　　#使用Linux和macOS的朋友不要輕易嘗試

　　!!python/object/apply:os.system["rm-rf/"]

　　因此最好是使用safe_load()來(lái)代替load()方法。

　　這和Python內(nèi)置的string標(biāo)準(zhǔn)庫(kù)中Template類的substitute()模板方法一樣存在著同樣的安全隱患，所以使用safe_substitute()來(lái)替代是一樣的道理。

　　如我們現(xiàn)在將之前的一些配置信息寫入config.yaml文件中：

　　mysql:
　　host:"127.0.0.1"
　　port:3306
　　user:"root"
　　password:"123456"
　　database:"test"
　　parameter:
　　pool_size:5
　　charset:"utf8"
　　fields:
　　pandas_cols:
　　-id
　　-name
　　-age
　　-date
　　然后我們通過(guò)safe_load()方法進(jìn)行解析：
　　>>>import os
　　>>>from pprint import pprint
　　>>>
　　>>>with open(os.path.expanduser("~/config.yaml"),"r")as config:
　　...cfg=yaml.safe_load(config)
　　...
　　>>>pprint(cfg)
　　{'mysql':{'database':'test',
　　'fields':{'pandas_cols':['id','name','age','date']},
　　'host':'127.0.0.1',
　　'parameter':{'charset':'utf8','pool_size':5},
　　'password':'123456',
　　'port':3306,
　　'user':'root'}}

　　可以看到最后結(jié)果和前面的toml庫(kù)的解析結(jié)果基本一致。

　　結(jié)尾

　　本文列舉了一些主流且常見(jiàn)的配置文件類型及其Python的讀取方法，可能有的讀者會(huì)發(fā)現(xiàn)當(dāng)中沒(méi)有xml格式類型的內(nèi)容。對(duì)于xml配置文件可能與Java系語(yǔ)言打交道的朋友遇見(jiàn)得會(huì)多一些，但xml文件的可讀性實(shí)在是讓人望而生畏；對(duì)xml文件不了解的朋友可以使用Chrome瀏覽器隨便進(jìn)入一個(gè)網(wǎng)站然后按下F12進(jìn)入開發(fā)者后查看那密密麻麻的html元素便是.xml的縮影。

　　除了這些主流的配置文件類型之外，像一些.cfg、.properties等都可以作為配置文件，甚至和開頭提到的那樣，你多帶帶用一個(gè).py文件來(lái)書寫各類配置信息作為配置文件進(jìn)行導(dǎo)入都是沒(méi)問(wèn)題，只是在跨語(yǔ)言共享時(shí)可能會(huì)有些障礙。因此本文就不過(guò)多介紹，感興趣的朋友可以進(jìn)一步自行了解。

　　在本文里列舉的配置文件類型其復(fù)雜性由上到下依次增加：ini<json≈toml<yaml，它們之間各有優(yōu)劣，可以根據(jù)自己實(shí)際的需求和團(tuán)隊(duì)協(xié)作要求來(lái)具體選擇。