python - 如何在 Python 中向 YAML 文件添加注释

Question

我正在使用 https://pypi.python.org/pypi/ruamel.yaml 编写 YAML 文件

代码是这样的:

import ruamel.yaml
from ruamel.yaml.comments import CommentedSeq

d = {}
for m in ['B1', 'B2', 'B3']:
    d2 = {}
    for f in ['A1', 'A2', 'A3']:
        d2[f] = CommentedSeq(['test', 'test2'])
        if f != 'A2':
            d2[f].fa.set_flow_style()
    d[m] = d2

    with open('test.yml', "w") as f:
        ruamel.yaml.dump(
            d, f, Dumper=ruamel.yaml.RoundTripDumper,
            default_flow_style=False, width=50, indent=8)

我只想在顶部添加评论，例如:

# Data for Class A

在 YAML 数据之前。

Answer 1

在您的with block 中，您可以向文件写入任何内容。由于您只需要在顶部添加注释，因此在调用 ruamel 之前添加对 f.write() 的调用:

with open('test.yml', "w") as f:
    f.write('# Data for Class A\n')
    ruamel.yaml.dump(
        d, f, Dumper=ruamel.yaml.RoundTripDumper,
        default_flow_style=False, width=50, indent=8)