為什麼要寫設定檔

在開發(fā)過程中，我們常常會用到一些固定參數(shù)或是常數(shù)。對於這些較為固定且常用到的部分，往往會將其寫到一個固定檔案中，避免在不同的模組程式碼中重複出現(xiàn)從而保持核心程式碼整潔。

這個固定文件我們可以直接寫成一個.py 文件，例如settings.py 或config.py，這樣的好處就是能夠在同一工程下直接透過import 來導入當中的部分；但如果我們需要在其他非Python 的平臺進行設定檔共用時，寫成單一.py 就不是一個很好的選擇。

這時我們就應該選擇通用的設定檔類型來作為儲存這些固定的部分。目前常用且流行的設定檔格式類型主要有 ini、json、toml、yaml、xml 等，這些類型的設定檔我們都可以透過標準函式庫或第三方函式庫來進行解析。

ini

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

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

Python 本身內建的configparser 標準庫，我們直接就可以用來對ini 檔進行解析。如我們將上述內容保存在一個名為 db.ini 的檔案中，然後使用 read() 方法來進行解析和讀取，最後透過 items() 方法來取得指定節(jié)點下的所有鍵值對。

>>> 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')]

要注意的是，configparser 預設將值以字串的形式呈現(xiàn)，所以這就是為什麼我們在 db.ini 檔案中沒有加引號而是直接將字面量寫在上面的原因。

取得到鍵值對後，我其實直接就將其轉換成字典，然後透過解包的方式進行穿參，保持程式碼簡潔：

#!pip install pymysql
import pymysql
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read("/Users/Bobot/db.ini")
db_cfg = dict(cfg.items("localdb"))
con = pymysql.connect(**db_cfg)

json

json 格式可以說是我們常見的一種文件形式了，也是目前在網(wǎng)路上較為流行的一種資料交換格式。除此之外，json 有時也是設定檔的一種。

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

和 configparser 一樣，Python 也內建了 json 標準函式庫，可以透過 load() 和 loads() 方法來匯入檔案式和字串的 json 內容。

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

我們將上述內容儲存為 db.json 後進行讀取和解析，json 函式庫讀取 json 檔案相對簡單容易，而且很容易解析成 Python 的字典物件。

>>> 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 檔案配置的缺點就是語法標準嚴格限制，為人所詬病之一的就是無法在當中寫註釋，除非採取json 類型的其他超集作為替代方案（VSCode 中能寫註釋的json 參數(shù)設定檔便是代替方案的一種）；同時存在嵌套過深的問題，容易導致出錯，不宜用來寫過長或複雜的參數(shù)配置資訊。

toml

toml 格式（或 tml 格式）是 Github 共同創(chuàng)辦人 Tom Preston-Werner 所提出的一種設定檔格式。根據(jù)維基百科的資料，toml 最開始提出時是在2013年7月份，距今已有七年時間；它在某些方面也與後面要談到的yaml 文件有些類似，但如果當你知道yaml 的規(guī)範有幾十頁（沒有錯，真的就是幾十頁…）的時候，可能你真的不太願意去寫那麼複雜的配置文件，toml 格式則倒是個不錯的選擇。

toml 格式大致如下：

01-toml樣式

#從這裡可以看出toml 有點類似前面所講的ini文件。但是它比 ini 擴展了更多的內容。

在範例圖片中我們可以看到，除了基本的字串以外，例如時間戳、布林值、陣列等都進一步支持，而且樣式和 Python 的原生寫法十分類似。

當然這裡不會過多介紹 toml 格式的一些規(guī)範說明，有人已經(jīng)對官方的規(guī)範文檔進行了翻譯，有興趣的朋友可以直接查閱。

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

pip install toml

該函式庫的解析方式很簡單，也有點類似json 函式庫的解析用法，即透過load() 或loads() 來進行解析；同理轉換並導出也是同樣類似的用法。

例如我們現(xiàn)在將以下內容寫入到 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"]

緊接著我們就可以通過 toml 庫中的 load() 方法來進行讀?。?/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 文件被間接地轉化成了字典類型，當然這也就是 json 版的寫法（將單引號替換成雙引號即可），方便我們后續(xù)調用或者傳參。

yaml

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

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

在上一節(jié) toml 內容里我曾提到，yaml 的規(guī)范內容可以說是冗長和復雜，足足有80頁之多（斗尊強者，恐怖如斯……）。

02-yaml規(guī)范頁數(shù)

所以感興趣的朋友可以再自行了解相關用法。

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

pip install pyyaml

同 json 庫和 toml 庫一樣，通過 load() 方法來進行加載。

需要注意的是，使用 load() 方法會存在一定的安全隱患，從思科 Talos 的這份報告中我們可以看到，如果加載了未知或不信任的 yaml 文件，那么有可能會存在被攻擊的風險和網(wǎng)絡安全隱患，因為它能夠直接調用相應的 Python 函數(shù)來執(zhí)行為攻擊者所需要的命令，比如說在 yaml 文件中寫入這么一段：

# 使用Linux和macOS的朋友不要輕易嘗試
!!python/object/apply:os.system ["rm -rf /"]

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

這和 Python 內置的 string 標準庫中 Template 類的 substitute() 模板方法一樣存在著同樣的安全隱患，所以使用 safe_substitute() 來替代是一樣的道理。

如我們現(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

然后我們通過 safe_load() 方法進行解析：

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

可以看到最后結果和前面的 toml 庫的解析結果基本一致。

結尾

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

除了這些主流的配置文件類型之外，像一些 .cfg、.properties 等都可以作為配置文件，甚至和開頭提到的那樣，你單獨用一個 .py 文件來書寫各類配置信息作為配置文件進行導入都是沒問題，只是在跨語言共享時可能會有些障礙。因此本文就不過多介紹，感興趣的朋友可以進一步自行了解。

在本文里列舉的配置文件類型其復雜性由上到下依次增加：ini

以上是超全！ Python 中常見的設定檔寫法的詳細內容。更多資訊請關注PHP中文網(wǎng)其他相關文章！