如何在Python中使用ruamel.yaml从YAML文件中获取注释?

时间:2016-07-07 18:12:07

标签: python comments yaml ruamel.yaml

我想从我使用ruamel.yaml加载的YAML文件中获取评论字符串。 project documentation缺少API参考,我找不到相关的示例。访问评论的正确方法是什么?

import ruamel.yaml

yaml = """\
%YAML 1.2
---
# C1
a: # C2
  # C3
  # C4
  b: 1 # C5
  c: # A comment here will not be parsed properly by ruamel.yaml v0.11.14
  - abc # C6
  - xyz # C7
  # C8
# C9
"""

loaded = ruamel.yaml.round_trip_load(yaml)

# Now what?

1 个答案:

答案 0 :(得分:3)

图书馆作者在an issue on BitBucket(2016年5月9日)中对此进行了评论:

  

评论保存尚未稳定,例如如果映射的键和值不在同一行并且键(或键和值)都有注释,我需要做一些事情。我最初的目标是保留现有的评论,而不是操纵。

通过一些实验,我确定了上述问题中提供的示例代码的以下工作:

print('Comment 1: ' + loaded.ca.comment[1][0].value)
print('Comment 2: ' + loaded.ca.items['a'][2].value)
print('Comment 3: ' + loaded.ca.items['a'][3][0].value)
print('Comment 4: ' + loaded.ca.items['a'][3][1].value)
print('Comment 5: ' + loaded['a'].ca.items['b'][2].value)
print('Comment 6: ' + loaded['a']['c'].ca.items[0][0].value)
print('Comment 7: ' + loaded['a']['c'].ca.items[1][0].value)
print('Comment 8: ' + loaded['a']['c'].ca.end[0].value)
print('Comment 9: ' + loaded['a']['c'].ca.end[1].value)