Python 如何根据预定义的模板重新排序YAML键并维护注释

您可以通过编写一个程序来解决这个问题，使用键的顺序以模板的顺序重新插入示例的键. 您可以使用CommentedMap()实例上可用的.insert()方法，即 用于使用模板中的逆键顺序加载在位置0处插入的YAML映射.但是你 也可以用正常的按键顺序和弹出分配，那会得到后面的第一个键，然后跟着 直到第一把 keys 放在前面.

要执行该操作，您可以使用保存路径的函数来查找对应的 示例中对应的数据 struct ，或并行递归.

import sys
from pathlib import Path
import ruamel.yaml

yaml = ruamel.yaml.YAML()
yaml.indent(mapping=2, sequence=4, offset=2)
yaml.preserve_quotes = True
template = yaml.load(Path('template.yaml'))
data = yaml.load(Path('example.yaml'))

def reorder(t, d):
    if isinstance(t, dict):
        for k, v in t.items():
            try:
                dv = d.pop(k)
            except:
                # this handles e.g. the key 'region' that is missing from the example
                continue  
            d[k] = dv
            reorder(v, dv)
    elif isinstance(t, list):
        # assume the template has one element, the example multiple
        for idx, elem in enumerate(d):
            reorder(t[0], elem)

reorder(template, data)
yaml.dump(data, sys.stdout)

这提供了:

name: MyApp
origin: internal
description: My wonderful application
go_live_date: 2024-01-01


status: in production
governance:
  business_owner:
    am:
      - John Carpenter # to be updated

    eu:
      - Audrey Dalton
  technical_owner:
    am:
      - Nico Ferrell
    eu:
      - Frances Case

    ap:
      - Benedict Berger
      - Elsie Parsons
architecture:
  platforms: [python_3_10, java_16]
  protocol: [TCP]
environments:
  - name: EU Prod
    description: production environment for EMEA
    tier: production
    locations: [ABC, XYZ]
  - name: EU UAT
    description: UAT environment for EMEA
    tier: uat
# further environmental details to be added
    locations: [LMN]

这将按模板的顺序获取密钥，但不处理空行. 那 是故意的，因为我们只递归到模板数据 struct 和后面的换行符 "John Carpenter"是序列的一部分，而不是模板的一部分. (你可以拨打print(data['governance']['business_owner']['am'].ca)查询) 由于ruamel.yaml当前处理注释的方式，将它们附加到最后一个完全解析的 node ，即注释# further.. 与关键的‘层’相关联，并通过重新排序来适当地改变位置(尽管这可能不是你想要的).

由于ruamel.yaml被认为是更新现有YAML(配置)文件中的值 尽可能多地保留(键顺序，注释，空行)， 当然，没有做任何接近这一点，你会有一些工作，做其他步骤.

我会先浏览一下结果示例数据，然后打印你找到的注释:

def remove_empty_lines(d):
    if isinstance(d, dict):
        for k, v in d.items():
            if d.ca.comment:
                print('comment', d.ca.comment)
            if (itemc := d.ca.items.get(k)) is not None:
                print('itemc', v, itemc)
            remove_empty_lines(v)
    elif isinstance(d, list):
        for idx, elem in enumerate(d):
            if d.ca.comment:
                print('lcomment', d.ca.comment)
            if (itemc := d.ca.items.get(idx)) is not None:
                print('litemc', elem, itemc)
            remove_empty_lines(elem)

remove_empty_lines(data)

这提供了:

itemc in production [None, [CommentToken('\n\n', line: 22, col: 0)], None, None]
litemc John Carpenter [CommentToken('# to be updated\n\n', line: 17, col: 23), None, None, None]
litemc Frances Case [CommentToken('\n\n', line: 11, col: 8), None, None, None]
itemc uat [None, None, CommentToken('\n# further environmental details to be added\n', line: 35, col: 0), None]

因此，您将需要判断这些项目，并更新CommentToken.例如，通过使用

print(dir(data['governance']['business_owner']['am'].ca.items[0][0]))
print(data['governance']['business_owner']['am'].ca.items[0][0].value)

你会看到.value属性包含了实际的注释， 你可以go 掉虚假的换行符.

完成后，再次遍历模板和数据，判断模板 用于注释，并插入/更新示例.确保创建新的CommentTokens Do not从模板中复制它们.你可以找到here个这样的例子