Question

我正在使用Ruamel Python库以编程方式更新人工编辑的YAML文件。

我有这样的数据：

---
a:
  b: '1'
  c: "2"

  d: 3
  # Comment.
  e: 4

我事先并不知道评论的位置以及空白行的位置。

我需要将其重置为：

---
a:
  b: '1'   
  c: "2"
  d: 3
  # Comment.
  e: 4

我可以从previous answers看到我如何删除所有评论，但我不知道如何查看CommentToken以查看它是否包含我需要的评论保留

Answer 1

ruamel.yaml的早期版本不会保留空行，但是通过在发出所有注释时传递新行来获取该行为相对容易：Emitter.write_comment()在{ {1}}。幸运的是，包含空格后跟换行符的行已经减少到换行符。从本质上讲，不是在数据中搜索附加的评论并找出如何重写它们，而是让评论来找你。

我添加了一些空的评论行案例来测试功能：

ruamel/yaml/emitter.py

给出：

import sys
import ruamel.yaml

yaml_str = """\
---
a:
  b: '1'
  # comment followed by empty lines


  c: "2"

  d: 3
  # Comment.
  e: 4


  # empty lines followed by comment
  f: 5

  # comment between empty lines

  g: |+
    an empty line within a multi-line literal

    with a trailing empty line that is not stripped

  h: 6

# final top level comment
"""

# rename the comment writer
ruamel.yaml.emitter.Emitter.write_comment_org = ruamel.yaml.emitter.Emitter.write_comment


# define your own comment writer that calls the orginal if the comment is not empty
def strip_empty_lines_write_comment(self, comment):
    # print('{:02d} {:02d} {!r}'.format(self.column, comment.start_mark.column, comment.value))
    comment.value = comment.value.replace('\n', '')
    if comment.value:
        self.write_comment_org(comment)

# install
ruamel.yaml.emitter.Emitter.write_comment = strip_empty_lines_write_comment

data = ruamel.yaml.round_trip_load(yaml_str, preserve_quotes=True)
ruamel.yaml.round_trip_dump(data, sys.stdout)

这将在＆＃34;安装＆＃34;之后影响所有转储数据。 a: b: '1' # comment followed by empty lines c: "2" d: 3 # Comment. e: 4 # empty lines followed by comment f: 5 # comment between empty lines g: |+ an empty line within a multi-line literal with a trailing empty line that is not stripped h: 6 # final top level comment。如果您的程序中还需要使用空行转储数据，那么您需要根据strip_empty_lines_write_comment创建StrippingEmitter子类并生成Emitter（如{使用该子类在StrippingRoundTripDumper中{1}}。

（您当然可以从代码中删除注释掉的调试print语句）

Answer 2

它并没有像我问的那样具体解决问题，但是为了它的价值，我最终得到了这个：

data = ruamel.yaml.round_trip_load(yaml_str, preserve_quotes=True)

space, no_space = map(lambda x:
    [None, None, ruamel.yaml.tokens.CommentToken(x, \
        ruamel.yaml.error.CommentMark(0), None), None], ['\n\n', '\n'])

for key in data['a'].ca.items:
    data['a'].ca.items[key] = no_space

last = data['a'].keys()[-1]
data['a'].ca.items[last] = space

即。我现在只是放弃保留任何非空间评论。

Answer 3

FWIW，我最终得到了类似以下内容的东西。这将删除剥离后为空的任何注释，即仅是空格。包含任何实际内容的评论将保留。

import ruamel.yaml

def monkeypatch_emitter():
    ruamel.yaml.emitter.Emitter.old_write_comment = ruamel.yaml.emitter.Emitter.write_comment

    def write_comment(self, comment, *args, **kwargs):
        if comment.value.strip():
            self.old_write_comment(comment, *args, **kwargs)

    ruamel.yaml.emitter.Emitter.write_comment = write_comment

def main():
    yaml = ruamel.yaml.YAML()
    # do yaml stuff here

if __name__ == '__main__:
    monkeypatch_emitter()
    main()

自从添加以上答案以来，write_comment签名可能已作了一些更改，因为由于偶尔存在'pre'关键字参数而失败了。如果将来再次更改，以上代码应传递任何额外的参数。

删除Ruamel.yaml

3 个答案: