Python配置文件管理之ini和yaml文件讀取的實現

更新時間：2023年02月28日 08:54:47 作者：趙卓不凡

本文主要介紹了Python配置文件管理之ini和yaml文件讀取，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

1. 引言

當我們設計軟件時，我們通常會花費大量精力來編寫高質量的代碼。但這往往還不夠，一個好的軟件還應該考慮其整個系統，如測試、部署、網絡等。其中最重要的一個方面是配置管理。

良好的配置管理應允許在任何環(huán)境中執(zhí)行軟件而不更改代碼。最常見的配置包括數據庫認證配置、部署服務器的主機名、動態(tài)參數等。在本文中，我想與大家分享一些配置管理的良好實踐，以及如何在Python中實現它們。

閑話少說，我們直接開始吧！

2. 如何選擇配置文件的格式

事實上，只要代碼能夠讀取和解析配置文件的內容，那么配置文件的格式就沒有任何限制。但是，業(yè)內有一些好的做法。最常見和標準化的格式是YAML、JSON、TOML和INI。

一個好的配置文件一般需要滿足以下三個標準：

易于閱讀和編輯：它應該以文本為基礎，以易于理解的方式進行構建。即使是非開發(fā)人員也應該能夠閱讀。
允許注釋：配置文件不是只有開發(fā)人員才能讀取的文件。當非開發(fā)人員試圖理解代碼行為時，注釋就顯得很重要。編寫注釋是快速解釋某些事情的一種方式，從而使配置文件更具表現力。
易于部署：所有操作系統和環(huán)境都應接受該配置文件。

如果你仍然不知道哪一個更好，但是在Python中，我推薦的答案將是YAML或INI。這是由于YAML和INI被大多數Python程序和包所接受。

3. INI文件示例

INI文件通常是最簡單的解決方案，由于它只有一個層次結構。然而，INI文件中沒有數據類型，所有內容都被編碼為字符串。
示例如下：

[APP]
ENVIRONMENT = test
DEBUG = True
# Only accept True or False

[DATABASE]
USERNAME = xiaoxu
PASSWORD = xiaoxu
HOST = 127.0.0.1
PORT = 5432
DB = xiaoxu_database

4. YAML文件示例

使用YAML針對上述示例的相同配置如下所示。如下所示，YAML文件支持嵌套結構。此外，YAML也支持一些常見的數據類型，如字符串、整數、雙精度、布爾值、列表、字典等。

APP:
? ENVIRONMENT: test
? DEBUG: True
? # Only accept True or False

DATABASE:
? USERNAME: xiaoxu
? PASSWORD: xiaoxu
? HOST: 127.0.0.1
? PORT: 5432
? DB: xiaoxu_database

5. 使用Cofigureparser讀取ini文件

首先，我們來介紹Python專門為配置管理而設計的包，我們從內置的配置包Configureparser開始。

Configureparser主要用于讀取和寫入INI文件，但它也同樣支持字典和可迭代文件對象作為輸入。每個INI文件由多個部分組成，其中有多個鍵、值對。

下面是上述ini文件讀取的示例：

import configparser

def read_ini(file_path, config_json):
? ? config = configparser.ConfigParser()
? ? config.read(file_path)
? ? for section in config.sections():
? ? ? ? for key in config[section]:
? ? ? ? ? ? print((key, config[section][key]))
?
read_ini("source/data/sample.ini", config_json)
# ('environment', 'test')
# ('debug', 'True')
# ('username', 'xiaoxu')
# ('password', 'xiaoxu')
# ('host', '127.0.0.1')
# ('port', '5432')
# ('db', 'xiaoxu_database')

Configureparser并不會猜測配置文件中的數據類型，因此每個配置項都被存儲為字符串。但它提供了一些將字符串轉換為正確數據類型的方法。這里面最有趣的是布爾類型，因為它能夠識別諸如yes/no、on/off、true/false和1/0的布爾值。

6. yaml文件讀取示例

Python有專門的內置包來解析yaml文件。由于安全性問題，建議使用yaml.safe_load()而不是yaml.load()來進行yaml文件的讀取。
示例代碼如下：

import yaml

def read_yaml(file_path):
? ? with open(file_path, "r") as f:
? ? ? ? return yaml.safe_load(f)
data = read_yaml("data/sample.yaml")
print(data)