在 ruamel.yaml 的列表元素中添加注释

我使用 Python 在 YAML 文件的列表中动态添加元素，并且我想在我添加的每个元素旁边添加注释。以下是所有所需的格式：

flow_style_example:
  - [a, b, c] # first list
  - [d, e] # second list

block_style_example:
  - - a  # first list side comment
    - b
    - c
  # second list top comment
  - - d
    - e

list_of_elements_side_comment:
  - a # foo
  - b # bar

list_of_elements_top_comment:
  # comment 1
  - a
  # comment 2
  - b

对于上述任何一个，我还没有弄清楚如何正确创建各自的CommentToken条目，尤其是涉及标记时（如何确定刚刚添加的内容的行和列？）

我怎样才能实现any上述功能？

与其在问题中写下您会欣赏的内容，否则会更有用 查看您的程序，确定您做错了什么。

因为您混合并匹配了缩进样式，所以您无法获得准确的缩进。 想要在一个垃圾场。

import sys
import ruamel.yaml
CS = ruamel.yaml.comments.CommentedSeq  # defaults to block style
CM = ruamel.yaml.comments.CommentedMap  # defaults to block style

def FS(x):  # flow style list
   res = CS(x)
   res.fa.set_flow_style()
   return res


yaml = ruamel.yaml.YAML()
yaml.indent(sequence=4, offset=2)

lst = CS()
lst.append(FS(['a', 'b', 'c']))
lst.append(FS(['d', 'e']))
lst.yaml_add_eol_comment("first list", 0, 0)
lst.yaml_add_eol_comment("second list\n\n", 1)
data = CM(flow_style_example=lst)

lst = CS()
data['block_style_example'] = lst
lst.append(CS(['a', 'b', 'c']))
lst[0].yaml_add_eol_comment("first list side comment", 0, 0)
lst.append(CS(['d', 'e']))
lst.yaml_set_comment_before_after_key(1, "second list top comment", 2)

lst = CS(['a', 'b'])
lst.yaml_add_eol_comment("foo", 0, 0)
lst.yaml_add_eol_comment("bar\n\n", 1)
data["list_of_elements_side_comment"] = lst
data.yaml_set_comment_before_after_key("list_of_elements_side_comment", "\n")

lst = CS(['a', 'b'])
lst.yaml_set_comment_before_after_key(0, "comment 1", 2)
lst.yaml_set_comment_before_after_key(1, "comment 2", 2)
data["list_of_elements_top_comment"] = lst


yaml.dump(data, sys.stdout)

这使：

flow_style_example:
  - [a, b, c] # first list
  - [d, e] # second list

block_style_example:
  -   - a # first list side comment
      - b
      - c
  # second list top comment
  -   - d
      - e

list_of_elements_side_comment:
  - a # foo
  - b # bar

list_of_elements_top_comment:
  # comment 1
  - a
  # comment 2
  - b

评论处理为CommentedSeq与以下非常相似CommentedMap：评论当前存储为字典，其中 序列索引与映射键具有相同的功能，因此 指某东西的用途yaml_set_comment_before_after_key在序列/列表上。

上面使用了 ruamel.yaml 的内部结构，它可能会在没有变化的情况下发生变化 请注意cq。有通知，但你没有注意到。因此（做好准备 ）修复您安装的 ruamel.yaml 的版本号。