Python3中常見組態檔寫法彙總

2022-08-11 14:02:09

1、引言

小魚：小屌絲，走啊，出去擼串啊，

小屌絲：沒時間啊，魚哥

小魚：嗯？？？啥事情讓你忙的擼串都不去了

小屌絲：我的BOSS讓我寫一個自動化平臺，但是我不知道這些引數放在**.py檔案裡面，還是放在組態檔**裡面。

小魚：就因為這個？

小屌絲：對啊，

小魚：唉…我還以為啥事呢，放在組態檔裡。

小屌絲：但是，我對組態檔寫法不太熟(尷尬的一批)…

小魚：… 每次都上當，噹噹不一樣。

小屌絲：嘿嘿… 這不是要向你學習嘛。

小魚：… 為了擼串，認了。

2、組態檔寫法

關於組態檔的寫法，常用的大致有：

- ini

- json

- toml

- yaml

接下來，我們就詳細聊一聊這四種常用組態檔的寫法。

2.1 ini

ini 即 Initialize ，最早是在 Windows 上組態檔的儲存格式。

ini 檔案的寫法通俗易懂，往往比較簡單，通常由節（Section）、鍵（key）和值（value）組成，就像以下形式

localdb.ini

[localdb]
Host  = 127.0.0.1
user   = root
password = 888888
port   = 3306
database = mysql

Python 本身內建的 configparser 標準庫，我們直接就可以用來對 ini 檔案進行解析。

如我們將上述內容儲存在一個名為 test1.ini 的檔案中，然後使用 read() 方法來進行解析和讀取，最後通過 items() 方法來獲取指定節點下的所有鍵值對。

程式碼範例：

# -*- coding:utf-8 -*-
# @Time   : 2022-08-04
# @Author : Carl_DJ

from configparser import ConfigParser
cfg = ConfigParser()

db_path= cfg.read("D:ProjectProjectlocaldb.ini")
#組態檔路徑
print(f"組態檔路徑:{db_path}")

db_msg = cfg.items("localdb")
#組態檔內容
print(f"組態檔內容:{db_msg}")

執行結果

組態檔路徑:['D:\Project\Project\localdb.ini']
組態檔內容:{'host': '127.0.0.1', 'user': 'root', 'password': '888888', 'port': '3306', 'database': 'mysql'}

注意點

configparser 預設將值以字串的形式呈現。

上面程式碼，獲取到鍵值對後，我們再來轉換成字典，然後再進行傳參。

程式碼範例

# -*- coding:utf-8 -*-
# @Time   : 2022-08-04
# @Author : Carl_DJ

from configparser import ConfigParser
import pymysql

cfg = ConfigParser()

db_path= cfg.read("D:ProjectProjectlocaldb.ini")
#組態檔路徑
#print(f"組態檔路徑:{db_path}")

#對內容轉換成字典
db_msg = dict(cfg.items("localdb"))
#連結資料庫
con = pymysql.connect(**db_msg)

2.2 json

看到json，不要驚訝，因為json也可以以組態檔存在的。

例如：

npm（JavaScript 包管理工具類似 Python 的 pip）、
微軟出品的目前被廣泛使用的 VSCode 編輯器

都使用 json 編寫設定引數。

當然 json也是python標準庫。

我們通過load() 和loads()方法來匯入檔案式和字串的 json 內容。

localdb.json

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

程式碼範例

# -*- coding:utf-8 -*-
# @Time   : 2022-08-04
# @Author : Carl_DJ

import json
from pprint import pprint

with open("D:ProjectProjectlocaldb.json") as js:
    cfg = json.load(js)['localdb']
    #以json格式輸出
    pprint(cfg)

執行結果：

{'database': 'mysql',
'host': '127.0.0.1',
'password': '888888',
'port': 3306,
'user': 'root'}

2.3 toml

toml 格式（或 tml 格式）是 Github 聯合創始人 Tom Preston-Werner 所提出的一種組態檔格式。

toml 格式：

從樣例中可以看出，toml 有點類似於前面所講的 ini 檔案。但是它比 ini 擴充套件了更多的內容。

當然，如果要使用toml，就需要先安裝。

老規矩：

pip install toml

其它安裝方式，直接看這兩篇:

Python3自動安裝第三方庫,跟pip說再見

Python:一行程式碼,匯入Python所有庫

localdb.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"]

程式碼範例

# -*- coding:utf-8 -*-
# @Time   : 2022-08-04
# @Author : Carl_DJ

import toml,os
from pprint import pprint

cfg = toml.load(os.path.expanduser("D:ProjectProjectlocaldb.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 檔案被間接地轉化成了字典型別。

2.4 yaml

yaml 格式（或 yml 格式）是目前較為流行的一種組態檔，它早在 2001 由一個名為 Clark Evans 的人提出；

同時它也是目前被廣泛使用的組態檔型別，典型的就是 Docker 容器裡的 docker-compose.yml 組態檔。

YAML 官方早已經提供了相應的 Python 庫進行支援，即 PyYAML，

所以，第一步，需要安裝

pip install pyyaml

用法：

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

但是，考慮到安全性，所以，最好是使用 safe_load() 來代替 load() 方法

localdb.yaml

mysql:
  host: "127.0.0.1"
  port: 3306
  user: "root"
  password: "888888"
  database: "test"

  parameter:
    pool_size: 5
    charset: "utf8"

  fields:
    pandas_cols: 
      - id
      - name
      - age
      - date

程式碼範例：

# -*- coding:utf-8 -*-
# @Time   : 2022-08-04
# @Author : Carl_DJ

import os
from pprint import pprint

with open("D:ProjectProjectlocaldb.json") as ya:
	cfg = yaml.safe_load(ya)
	pprint(cfg)

執行結果：

{'mysql': {'database': 'test',
'fields': {'pandas_cols': ['id', 'name', 'age', 'date']},
'host': '127.0.0.1',
'parameter': {'charset': 'utf8', 'pool_size': 5},
'password': '888888',
'port': 3306,
'user': 'root'}}

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