使用 Python 更改 yaml 文件中的值

Question

我有一個 .yaml 文件，我想用 Python 代碼更新。 假設它看起來像這樣：

  state: 'present'

我想要一個更改狀態並保存文件的代碼。 我正在嘗試這樣的事情但失敗了：

def set_state(state):
    with open("file_to_edit.yaml", 'rw') as f:
        doc = yaml.load(f)
    doc['state'] = state
    yaml.dump(f)

我正在使用 Python 的“yaml”包。

Answer 1

問題是yaml.dump(doc)實際上並沒有寫入文件。 相反，它將修改后的 YAML 作為字符串返回，除非您也將文件描述符作為參數傳遞，這允許您直接寫入文件。

以下應該工作：

def set_state(state):
    with open('file_to_edit.yaml') as f:
        doc = yaml.load(f)

    doc['state'] = state

    with open('file_to_edit.yaml', 'w') as f:
        yaml.dump(doc, f)

Answer 2

最重要的是：如果你不需要，永遠不要使用yaml.load() ，因為這樣做原則上是不安全的。 對於這種簡單的結構（沒有標簽），您應該使用yaml.safe_load() （以及相應的safe_dump() ，如果您的數據在轉儲后無法安全加載，則會抱怨）。

yaml.dump()具有以下簽名：

def dump(documents, stream=None, Dumper=Dumper,
         default_style=None, default_flow_style=None,
         canonical=None, indent=None, width=None,
         allow_unicode=None, line_break=None,
         encoding='utf-8', explicit_start=None, explicit_end=None,
         version=None, tags=None)

其中只需要給出第一個，那應該是您的doc變量。 如果您不指定流，則dump()將數據結構寫入內存文件對象（如 StringIO），並在寫入后以字符串形式返回值。

所以雖然你可以這樣做：

with open("file_to_edit.yaml", 'w') as f:
    f.write(yaml.safe_dump(doc))

這是低效的，並且對yaml.safe_dump()工作原理yaml.safe_dump() 。

如果要打開文件進行讀寫，必須確保重置文件中的索引並截斷其內容。 這通常不值得付出努力，因此重新打開文件進行寫入會更安全：

def set_state(state):
    file_name = "file_to_edit.yaml"
    with open(file_name) as f:
        doc = yaml.safe_load(f)
    doc['state'] = state
    with open(file_name, 'w') as f:
        yaml.safe_dump(doc, f, default_flow_style=False)

（當然，當您想確保覆蓋原始文件時，您可以將文件名設為變量，這樣您就不會輸入錯誤）。

如果您不指定default_flow_style=False ，您的輸出將如下所示：

{state: deleted}

輸出將不包括輸入中present的多余引號。 您也可以指定default_style="'" ，但這也會在state周圍加上引號。
如果丟失引號是一個問題並且您確實希望輸出看起來像輸入，則您應該使用ruamel.yaml （免責聲明我是該包的作者），它可以保留單個字符串上的引號，處理 YAML 1.2（而不是 YAML 1.1），並且還會在您的文件中保留注釋。

Answer 3

我的猜測是你沒有正確縮進，因為你的函數在當前狀態下似乎沒有做任何事情。 Python確實關心縮進。

試試這個：

    def set_state(state):
        with open("file_to_edit.yaml", 'rw') as f:
            doc = yaml.load(f)
        doc['state'] = state
        yaml.dump(f)

Answer 4

您可以嘗試以下操作（它會創建一個新文件來存儲結果）：

with open("output_file", 'a') as out:
    with open("input_file", 'r') as f:
        for line in f:
            line = re.sub(r"state: present", "state: installed", line)
            out.write(line)