python - 如何在 ruamel 中保留评论

Question

我需要对带有注释的 YAML 文件进行排序。我正在使用 ruamel.yaml 库来保留 YAML 中的注释，但是当我对项目进行排序时，注释被放置在错误的位置。

people = """\
# manager of project
- title: manager

# owner of company
- title: owner
"""

import ruamel.yaml, sys

yaml = ruamel.yaml.YAML()
arr = yaml.load(people)
arr  = sorted(arr, key=lambda x: x['title'])
yaml.dump(arr, sys.stdout)

通过这段代码，我得到以下输出:

- title: manager

# owner of company
- title: owner

在排序期间，第一个元素的注释消失了。我如何保留列表的第一条评论？

Answer 1

您在文档开头的第一条评论没有前一个节点并在 arr 对象上获得一个特殊位置(即类型为ruamel.yaml.comments.CommentedSeq)。您可以通过以下方式检查这一点直接执行 print(arr.ca) (ca 表示注释属性)正在加载。

加载后，字典上附加了第二个注释属性就像由映射 arr[0] 和第三个注释构造的对象附加到由 arr[1] 构造的类似字典的对象的属性(在与将第一条评论附加到 arr 的方式大致相同)。

排序操作没有就地完成，因此只有与已排序元素关联的注释保留在原处。这赋值后的arr(一个简单的list)，结果为sorted() 甚至与从 YAML 加载的 arr 不是同一类型(aCommentedSeq)，当然没有与之相关的注释。

所以你需要做的就是保存评论信息，使适当类型的排序结果，然后分配保留的该对象的信息。幸运的是这只需要改变一个并向您的代码添加一行:

import sys
import ruamel.yaml

people = """\
# manager of project
- title: manager

# owner of company
- title: owner
"""

yaml = ruamel.yaml.YAML()
arr = yaml.load(people)
root_comment = arr.ca
arr  = ruamel.yaml.comments.CommentedSeq(sorted(arr, key=lambda x: x['title']))
arr._yaml_comment = root_comment
yaml.dump(arr, sys.stdout)

给出:

# manager of project
- title: manager

# owner of company
- title: owner

但是一般来说，这种广泛的操作会让你陷入麻烦。尝试使用就地排序可能会更好。