使用 Python 解析配置檔案

2022-09-08 09:09:10 字數 3328 閱讀 3872

第一步是選擇配置檔案的格式:ini、json、yaml 或 toml。

有時,程式需要足夠的引數,將它們全部作為命令列引數或環境變數既不讓人愉快也不可行。 在這些情況下,你將需要使用配置檔案。

有幾種流行的配置檔案格式。其中包括古老的(雖然有時定義不明確)ini 格式,雖然流行但有時難以手寫的 json 格式,使用廣泛但有時在細節方面令人意外的 yaml 格式,以及很多人還沒有聽說過的最新出現的 toml。

你的首要任務是選擇一種格式,然後記錄該選擇。解決了這個簡單的部分之後就是時候解析配置了。

有時,在配置中擁有乙個與「抽象「資料相對應的類是乙個不錯的想法。因為這段**不會對配置做任何事情,所以這是展示解析邏輯最簡單的方式。

想象一下檔案處理器的配置:它包括乙個輸入目錄、乙個輸出目錄和要提取的檔案。

配置類的抽象定義可能類似於:

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

為了使特定於格式的**更簡單,你還需要編寫乙個函式來從字典中解析此類。請注意,這假設配置將使用破折號,而不是下劃線。 這種差異並不少見。

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(j**ascript object notation)是一種類似於 j**ascript 的格式。

以下是 json 格式的示例配置:

json_config="""

"files": {

"input-dir": "inputs",

"output-dir": "outputs"

"parameters": {

"patterns": [

"*.txt",

"*.md"

解析邏輯使用 json模組將 json 解析為 python

的內建資料結構(字典、列表、字串),然後從字典中建立類:

import json

def configuration_from_json(data):

parsed=json.loads(data)

return configuration_from_dict(parsed)

iniini 格式,最初只在 windows 上流行,之後成為配置標準格式。

這是與 ini 相同的配置:

ini_config="""

[files]

input-dir=inputs

output-dir=outputs

[parameters]

patterns=['*.txt', '*.md']

python 可以使用內建的 configparser模組解析它。解析器充當類似dict的物件,因此可以直接傳遞給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 的擴充套件,旨在更易於手動編寫。為了實現了這一點,部分原因是有乙個很長的規範。

以下是 yaml 中的相同配置:

yaml_config="""

files:

input-dir: inputs

output-dir: outputs

parameters:

patterns:

- '*.txt'

- '*.md'

要讓 python 解析它,你需要安裝第三方模組。最受歡迎的是pyyaml(pip install pyyaml)。 yaml 解析器還返回可以傳遞給configuration_from_dict的內建 python 資料型別。但是,yaml 解析器需要乙個位元組流,因此你需要將字串轉換為位元組流。

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 的輕量級替代品。其規範比較短,已經在一些地方流行了(比如 rust 的包管理器 cargo 就用它來進行包配置)。

這是與 toml 相同的配置:

toml_config="""

[files]

input-dir="inputs"

output-dir="outputs"

[parameters]

patterns=[ "*.txt", "*.md",]

為了解析 toml,你需要安裝第三方包。最流行的一種被簡單地稱為 toml。 與 yaml 和 json 一樣,它返回基本的 python 資料型別。

import toml

def configuration_from_toml(data):

parsed=toml.loads(data)

return configuration_from_dict(parsed)

總結選擇配置格式是一種微妙的權衡。但是,一旦你做出決定,python 就可以使用少量**來解析大多數流行的格式。

python 解析配置檔案

usr bin env python coding utf 8 上面來顯示中文的。不然中文會出問題 說明 輸入的檔案,開頭的一行預設是注釋符號,這一行不計入處理,其餘的都是有效行,有效行遇到 也結束 import pdb import fileinput pdb.set trace def getn...

使用tinyxml解析XML配置檔案

這是乙個專案過程中所遇到的問題。有多個商品種類,每個商品種類有著不同的基本資訊,現在我們需要對這些基本資訊進行驗證。但是每個種類會有自己獨特的驗證需求 不同種類需要驗證的字段可能不一樣 如果我們使用 來判斷每個種類需要驗證哪些欄位會非常麻煩,而且需求稍一變動就要修改原始碼。所以就想到用配置檔案來設定...

配置檔案解析函式

config.h this file is usred for parsing configure file.e mail yhniejun 163.com 2007.01.25 mr.nie the struct of config file.struct conf info typedef st...