Question

我有一个像这样的结构，我希望使用ruamel.yaml添加注释行：

xyz:
  a: 1    # comment 1
  b: 2

test1:
  test2:
    test3: 3

现在，我想插入注释行（而不是eol_comments），使它看起来像这样：

xyz:
  a: 1    # comment 1
  b: 2

# before test1 (top level)
test1:
  # before test2
  test2:
    # after test2
    test3: 3

我知道，我可以使用ruamel.yaml添加eol_comments，但我找不到添加整个注释行的方法。

Answer 1

在ruamel.yaml<=0.12.18中确实没有函数在键之前的行上插入注释，但是有一个函数可以在结构的开头设置注释：.yaml_set_start_comment。有了它，您可以设置要添加的三个注释中的两个：

import sys
import ruamel.yaml

yaml_str = """\
xyz:
  a: 1    # comment 1
  b: 2

test1:
  test2:
    test3: 3
"""

data = ruamel.yaml.round_trip_load(yaml_str)
data['test1'].yaml_set_start_comment('before test2', indent=2)
data['test1']['test2'].yaml_set_start_comment('after test2', indent=4)
ruamel.yaml.round_trip_dump(data, sys.stdout)

给出：

xyz:
  a: 1    # comment 1
  b: 2

test1:
  # before test2
  test2:
    # after test2
    test3: 3

xyz和test1的值之间实际上有一个“注释”构成空行，但如果您将注释附加到该结构，然后在{{1}之前插入新密钥事情没有按你的意愿出现。因此，要做的是在键test1之前显式插入注释。您可以往返加载预期输出，以查看内部test1应该是什么样的：

Comment

给出（包装它以便于查看）：

yaml_str_out = """\
xyz:
  a: 1    # comment 1
  b: 2

# before test1 (top level)
test1:
  # before test2
  test2:
    # before test3
    test3: 3
"""
test = ruamel.yaml.round_trip_load(yaml_str_out)
print(test.ca)

如您所见，Comment(comment=None, items={'test1': [None, [CommentToken(value='# before test1 (top level)\n')], None, [CommentToken(value='# before test2\n')]]})被认为是关键后的评论。做# before test2会与test['test1'].yaml_set_start_comment('xxxxx', indent=2)否决相关的评论没有任何效果，并且test1 将在转储中显示。

通过这些信息和一些背景知识，我调整了# xxxxx中的一些代码（假设原始导入和yaml_set_start_comment()）：

yaml_str

并获得：

def yscbak(self, key, before=None, indent=0, after=None, after_indent=None):
    """
    expects comment (before/after) to be without `#` and possible have multiple lines
    """
    from ruamel.yaml.error import Mark
    from ruamel.yaml.tokens import CommentToken

    def comment_token(s, mark):
        # handle empty lines as having no comment
        return CommentToken(('# ' if s else '') + s + '\n', mark, None)

    if after_indent is None:
        after_indent = indent + 2
    if before and before[-1] == '\n':
        before = before[:-1]  # strip final newline if there
    if after and after[-1] == '\n':
        after = after[:-1]  # strip final newline if there
    start_mark = Mark(None, None, None, indent, None, None)
    c = self.ca.items.setdefault(key, [None, [], None, None])
    if before:
        for com in before.split('\n'):
            c[1].append(comment_token(com, start_mark))
    if after:
        start_mark = Mark(None, None, None, after_indent, None, None)
        if c[3] is None:
            c[3] = []
        for com in after.split('\n'):
            c[3].append(comment_token(com, start_mark))

if not hasattr(ruamel.yaml.comments.CommentedMap, 
               'yaml_set_comment_before_after_key'):
    ruamel.yaml.comments.CommentedMap.yaml_set_comment_before_after_key = yscbak


data = ruamel.yaml.round_trip_load(yaml_str)
data.yaml_set_comment_before_after_key('test1', 'before test1 (top level)',
                                       after='before test2', after_indent=2)
data['test1']['test2'].yaml_set_start_comment('after test2', indent=4)
ruamel.yaml.round_trip_dump(data, sys.stdout)

使用xyz: a: 1 # comment 1 b: 2 # before test1 (top level) test1: # before test2 test2: # after test2 test3: 3进行的测试是为了确保在将此功能添加到hasattr时不会覆盖此功能

BTW：所有评论都是YAML中的行尾评论，在其中一些评论之前可能只有有效的YAML。

如何使用ruamel.yaml在Python中向YAML插入注释行？

1 个答案: