Python+requests 之封裝yaml配置檔案的讀寫

簡介

YAML語言的設計目标，是友善人類讀寫。實質上是一種通用的資料串行化格式。它的基本文法規則如下：

• 大小寫敏感
• 使用縮進表示層級關系
• 縮進時不允許使用Tab鍵，隻允許使用空格。
• 縮進的空格數目不重要，隻要相同層級的元素左側對齊即可
• '#'表示注釋, 會被解析器忽略

YAML 支援的資料結構有三種

• 對象：鍵值對的集合，又稱為映射（mapping）/ 哈希（hashes） / 字典（dictionary）
• 數組：一組按次序排列的值，又稱為序列（sequence） / 清單（list）
• 純量（scalars）：單個的、不可再分的值

open函數

open() 函數用于打開一個檔案，建立一個 file 對象，相關的方法才可以調用它進行讀寫

函數文法：

open(name[, mode[, buffering]])
           

參數說明：

• name : 一個包含了你要通路的檔案名稱的字元串值。
• mode : mode 決定了打開檔案的模式：隻讀，寫入，追加等。所有可取值見如下的完全清單。這個參數是非強制的，預設檔案通路模式為隻讀(r)。
• buffering : 如果 buffering 的值被設為 0，就不會有寄存。如果 buffering 的值取 1，通路檔案時會寄存行。如果将 buffering 的值設為大于 1 的整數，表明了這就是的寄存區的緩沖大小。如果取負值，寄存區的緩沖大小則為系統預設

不同模式打開檔案的完全清單：

模式	描述
r	以隻讀方式打開檔案。檔案的指針将會放在檔案的開頭。這是預設模式
rb	以二進制格式打開一個檔案用于隻讀。檔案指針将會放在檔案的開頭。這是預設模式
r+	打開一個檔案用于讀寫。檔案指針将會放在檔案的開頭
rb+	以二進制格式打開一個檔案用于讀寫。檔案指針将會放在檔案的開頭
w	打開一個檔案隻用于寫入。如果該檔案已存在則打開檔案，并從開頭開始編輯，即原有内容會被删除。如果該檔案不存在，建立新檔案
wb	以二進制格式打開一個檔案隻用于寫入。如果該檔案已存在則打開檔案，并從開頭開始編輯，即原有内容會被删除。如果該檔案不存在，建立新檔案
w+	打開一個檔案用于讀寫。如果該檔案已存在則打開檔案，并從開頭開始編輯，即原有内容會被删除。如果該檔案不存在，建立新檔案
wb+	以二進制格式打開一個檔案用于讀寫。如果該檔案已存在則打開檔案，并從開頭開始編輯，即原有内容會被删除。如果該檔案不存在，建立新檔案
a	打開一個檔案用于追加。如果該檔案已存在，檔案指針将會放在檔案的結尾。也就是說，新的内容将會被寫入到已有内容之後。如果該檔案不存在，建立新檔案進行寫入
ab	以二進制格式打開一個檔案用于追加。如果該檔案已存在，檔案指針将會放在檔案的結尾。也就是說，新的内容将會被寫入到已有内容之後。如果該檔案不存在，建立新檔案進行寫入
a+	打開一個檔案用于讀寫。如果該檔案已存在，檔案指針将會放在檔案的結尾。檔案打開時會是追加模式。如果該檔案不存在，建立新檔案用于讀寫
ab+	以二進制格式打開一個檔案用于追加。如果該檔案已存在，檔案指針将會放在檔案的結尾。如果該檔案不存在，建立新檔案用于讀寫

環境配置：

安裝pyyaml：python -m pip install pyyaml

Read

import yaml

# 讀取yaml檔案
class Getyaml():
    def __init__(self, path, param=None):
        self.path = path                                # 檔案路徑
        self.param = param                              # 讀取資訊的key,不傳預設擷取所有資料

    # 擷取yaml檔案中的資料
    def get_data(self):
        with open(self.path, 'rb') as y:
            cont = y.read()                             # 擷取yaml檔案中的所有資訊
        yaml.warnings({'YAMLLoadWarning': False})       # 禁用加載器warnings報警
        cf = yaml.load(cont)                            # 将bytes格式轉成dict格式
        y.close()                                       # 關閉檔案
        if self.param == None:
            return cf                                   # 傳回所有資料
        else:
            return cf.get(self.param)                   # 擷取鍵為param的值

if __name__ == "__main__":
    p = "Z:\\readwrite.yaml"
    print(Getyaml(path=p, param="key").get_data())
           

# 注： 若yaml檔案中存在重複的key, 讀取時則會讀取最新寫入的

Write

import yaml

# 寫入yaml檔案
class Writeyaml():
    def __init__(self, path, message):
        self.path = path
        self.message = message

    def echo_data(self):
        with open(self.path, "a+", encoding="utf-8") as f:    
        # 注：此模式為追加模式,若想直接重寫則将open函數中的模式'a+'改為'w'
            yaml.dump(self.message, f)
        f.close()

if __name__ == "__main__":
    m = {"key1": "value1", "key2": "value2", "dict_1": {"dict_2": {"dict_3": ["test1", "test2", "test3"]}}}
    p = "Z:\\readwrite.yaml"
    Writeyaml(path=p, message=m).echo_data()
           

多次追加的結果如下：

# 除使用pyyaml庫外，還可以通過ruamel子產品操作yaml檔案，pip安裝方法：python -m pip install ruamel.yaml