使用 Python 解析配置文件格式

第一步是選擇配置文件的格式：INI、JSON、YAML 或 TOML。

有時(shí)，程序需要足夠的參數(shù)，將它們?nèi)孔鳛槊钚袇?shù)或環(huán)境變量既不讓人愉快也不可行。 在這些情況下，你將需要使用配置文件。

有幾種流行的配置文件格式。其中包括古老的（雖然有時(shí)定義不明確）INI 格式，雖然流行但有時(shí)難以手寫(xiě)的 JSON 格式，使用廣泛但有時(shí)在細(xì)節(jié)方面令人意外的 YAML 格式，以及很多人還沒(méi)有聽(tīng)說(shuō)過(guò)的最新出現(xiàn)的 TOML。

你的首要任務(wù)是選擇一種格式，然后記錄該選擇。解決了這個(gè)簡(jiǎn)單的部分之后就是時(shí)候解析配置了。

有時(shí)，在配置中擁有一個(gè)與“抽象“數(shù)據(jù)相對(duì)應(yīng)的類是一個(gè)不錯(cuò)的想法。因?yàn)檫@段代碼不會(huì)對(duì)配置做任何事情，所以這是展示解析邏輯最簡(jiǎn)單的方式。

想象一下文件處理器的配置：它包括一個(gè)輸入目錄、一個(gè)輸出目錄和要提取的文件。

配置類的抽象定義可能類似于：

from__future__import annotations

import attr
 
@attr.frozen
class Configuration:
 @attr.frozen
 class Files:
input_dir:str
output_dir:str
files: Files
 @attr.frozen
 class Parameters:
patterns: List[str]
parameters: Parameters

為了使特定于格式的代碼更簡(jiǎn)單，你還需要編寫(xiě)一個(gè)函數(shù)來(lái)從字典中解析此類。請(qǐng)注意，這假設(shè)配置將使用破折號(hào)，而不是下劃線。 這種差異并不少見(jiàn)。

def configuration_from_dict(details):
    files = Configuration.Files(
        input_dir=details["files"]["input-dir"],
        output_dir=details["files"]["output-dir"],
    )
    parameters = Configuration.Paraneters(
        patterns=details["parameters"]["patterns"]
    )
    return Configuration(
        files=files,
        parameters=parameters,
    )

JSON

JSON（JavaScript Object Notation）是一種類似于 JavaScript 的格式。

以下是 JSON 格式的示例配置：

json_config = """
{
    "files": {
        "input-dir": "inputs",
        "output-dir": "outputs"
    },
    "parameters": {
        "patterns": [
            "*.txt",
            "*.md"
        ]
    }
}
"""

解析邏輯使用 json 模塊將 JSON 解析為 Python 的內(nèi)置數(shù)據(jù)結(jié)構(gòu)（字典、列表、字符串），然后從字典中創(chuàng)建類：

import json
def configuration_from_json(data):
    parsed = json.loads(data)
    return configuration_from_dict(parsed)

INI

INI 格式，最初只在 Windows 上流行，之后成為配置標(biāo)準(zhǔn)格式。

這是與 INI 相同的配置：

ini_config="""
[files]
input-dir = inputs
output-dir = outputs
 
[parameters]
patterns = ['*.txt', '*.md']
"""

Python 可以使用內(nèi)置的 configparser 模塊解析它。解析器充當(dāng)類似  dict 的對(duì)象，因此可以直接傳遞給  configuration_from_dict ：

import configparser
 
def configuration_from_ini(data):
parser=configparser.ConfigParser()
parser.read_string(data)
 return configuration_from_dict(parser)

YAML

YAML（Yet Another Markup Language）是 JSON 的擴(kuò)展，旨在更易于手動(dòng)編寫(xiě)。為了實(shí)現(xiàn)了這一點(diǎn)，部分原因是有一個(gè)很長(zhǎng)的規(guī)范。

以下是 YAML 中的相同配置：

yaml_config = """
files:
  input-dir: inputs
  output-dir: outputs
parameters:
  patterns:
  - '*.txt'
  - '*.md'
"""

要讓 Python 解析它，你需要安裝第三方模塊。最受歡迎的是 PyYAML （ pip install pyyaml ）。 YAML 解析器還返回可以傳遞給  configuration_from_dict 的內(nèi)置 Python 數(shù)據(jù)類型。但是，YAML 解析器需要一個(gè)字節(jié)流，因此你需要將字符串轉(zhuǎn)換為字節(jié)流。

import io
import yaml
def configuration_from_yaml(data):
    fp = io.StringIO(data)
    parsed = yaml.safe_load(fp)
    return configuration_from_dict(parsed)

TOML

TOML（Tom's Own Markup Language）旨在成為 YAML 的輕量級(jí)替代品。其規(guī)范比較短，已經(jīng)在一些地方流行了（比如 Rust 的包管理器 Cargo 就用它來(lái)進(jìn)行包配置）。

這是與 TOML 相同的配置：

toml_config= """
[files]
input-dir = "inputs"
output-dir = "outputs"
 
[parameters]
patterns = [ "*.txt", "*.md",]
"""

為了解析 TOML，你需要安裝第三方包。最流行的一種被簡(jiǎn)單地稱為 toml 。 與 YAML 和 JSON 一樣，它返回基本的 Python 數(shù)據(jù)類型。

import toml
def configuration_from_toml(data):
    parsed = toml.loads(data)
    return configuration_from_dict(parsed)

總結(jié)

選擇配置格式是一種微妙的權(quán)衡。但是，一旦你做出決定，Python 就可以使用少量代碼來(lái)解析大多數(shù)流行的格式。

到此這篇關(guān)于使用 Python 解析配置文件格式的文章就介紹到這了,更多相關(guān)Python 解析配置文件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！