python - 如何在保留注释/样式的同时映射 CommentedMap？

Question

给定一个 ruamel.yaml CommentedMap() 和一些转换函数 f: CommentedMap → Any，我想生成一个新的CommentedMap 具有转换后的键和值，但在其他方面与原始版本尽可能相似。

如果我不关心保留风格，我可以这样做:

result = {
    f(key) : f(value)
    for key, value in my_commented_map.items()
}

如果我不需要转换键(并且我不关心改变原始键)，我可以这样做:

for key, value in my_commented_map.items():
    my_commented_map[key] = f(value)

Answer 1

样式和评论信息分别附在CommentedMap 通过特殊属性。风格可以复制，但是注释部分索引到它们出现在哪一行的关键位置，并且如果您转换该键，您还需要转换该索引评论。

在第一个示例中，您将 f() 应用于键和值，我将使用在我的示例中，单独的功能，全部大写的键，以及将值全部小写(这当然仅适用于字符串类型键和值，所以这是示例的限制，不是解决方案)

import sys
import ruamel.yaml
from ruamel.yaml.comments import CommentedMap as CM
from ruamel.yaml.comments import Format, Comment


yaml_str = """\
# example YAML document
abc: All Strings are Equal  # but some Strings are more Equal then others
klm: Flying Blue
xYz: the End                # for now
"""

def fkey(s):
    return s.upper()

def fval(s):
    return s.lower()

def transform(data, fk, fv):
    d = CM()
    if hasattr(data, Format.attrib):
        setattr(d, Format.attrib, getattr(data, Format.attrib))
    ca = None
    if hasattr(data, Comment.attrib):
        setattr(d, Comment.attrib, getattr(data, Comment.attrib))
        ca = getattr(d, Comment.attrib)
    # as the key mapping could map new keys on old keys, first gather everything
    key_com = {}
    for k in data:
        new_k = fk(k)
        d[new_k] = fv(data[k])
        if ca is not None and k in ca.items:
            key_com[new_k] = ca.items.pop(k)
    if ca is not None:
        assert len(ca.items) == 0
        ca._items = key_com  # the attribute, not the read-only property
    return d

yaml = ruamel.yaml.YAML()
data = yaml.load(yaml_str)

# the following will print any new CommentedMap with curly braces, this just here to check
# if the style attribute copying is working correctly, remove from real code
yaml.default_flow_style = True

data = transform(data, fkey, fval)
yaml.dump(data, sys.stdout)

给出:

# example YAML document
ABC: all strings are equal  # but some Strings are more Equal then others
KLM: flying blue
XYZ: the end                # for now

请注意:

• 上面尝试(并成功)在原文中开始评论列，如果不可能的话，例如当转换后的键或值占用更多空间，因此被进一步推向右侧。

• 如果您有更复杂的数据结构，请递归地遍历树，下降到映射和序列。在这种情况下，存储 (key, value, comment) 元组可能会更容易然后 pop() 所有键并重新插入存储的值(而不是重建树)。