使用 Python 替换 YAML 中的字符串

Question

我有以下 YAML：

instance:
  name: test
  flavor: x-large
  image: centos7

tasks:
  centos-7-prepare:
    priority: 1
    details::
      ha: 0
      args:
        template: &startup
          name: startup-centos-7
          version: 1.2
        timeout: 1800

  centos-7-crawl:
    priority: 5
    details::
      ha: 1
      args:
        template: *startup
        timeout: 0

第一个任务定义模板名称和版本，然后由其他任务使用。模板定义不应更改，但其他尤其是任务名称会更改。

在 Python 中更改模板名称和版本的最佳方法是什么？

我有以下用于匹配的正则表达式（使用 re.DOTALL）：

template:.*name: (.*?)version: (.*?)\s

但是到目前为止还没有弄清楚 re.sub 的使用情况。或者有没有更方便的方法来做到这一点？

Answer 1

对于这种 YAML 的往返（加载-修改-转储），您应该使用 ruamel.yaml（免责声明：我是该软件包的作者）。

如果您输入的是input.yaml，那么您可以相对容易地找到 name 和 version 在 template 键下并更新它们：

import sys
import ruamel.yaml

def find_template(d):
    if isinstance(d, list):
        for elem in d:
            x = find_template(elem)
            if x is not None:
                return x
    elif isinstance(d, dict):
        for k in d:
            v = d[k]
            if k == 'template':
                if 'name' in v and 'version' in v:
                    return v
            x = find_template(v)
            if x is not None:
                return x
    return None


yaml = ruamel.yaml.YAML()
# yaml.indent(mapping=4, sequence=4, offset=2)
yaml.preserve_quotes = True

with open('input.yaml') as ifp:
    data = yaml.load(ifp)
template = find_template(data)
template['name'] = 'startup-centos-8'
template['version'] = '1.3'

yaml.dump(data, sys.stdout)

给出：

instance:
  name: test
  flavor: x-large
  image: centos7

tasks:
  centos-7-prepare:
    priority: 1
    'details:':
      ha: 0
      args:
        template: &startup
          name: startup-centos-8
          version: '1.3'
        timeout: 1800

  centos-7-crawl:
    priority: 5
    'details:':
      ha: 1
      args:
        template: *startup
        timeout: 0

请注意，我在输入中插入的（多余的）引号，以及注释和别名的名称都被保留了。

Answer 2

我会将 yaml 文件解析成字典，然后编辑字段并将字典写回 yaml。

有关在 python How can I parse a YAML file in Python 中解析 yaml 的讨论，请参阅此问题，但我认为您最终会得到类似的结果。

from ruamel.yaml import YAML
from io import StringIO

yaml=YAML(typ='safe')
yaml.default_flow_style = False

#Parse from string
myConfig = yaml.load(doc)
#Example replacement code
for task in myConfig["tasks"]:
    if myConfig["tasks"][task]["details"]["args"]["template"]["name"] == "&startup":
        myConfig["tasks"][task]["details"]["args"]["template"]["name"] = "new value"
#Convert back to string
buf = StringIO()
yaml.dump(myConfig, buf)
updatedYml = buf.getvalue()