将 YAML 多行值转换为折叠块标量样式？

Question

使用 ruamel.yaml 我试图获得某种样式的 YAML，更具体地说，单行字符串与 : 在同一行开始，多行字符串使用折叠标量样式(|/|-) 并且行被限制为一定数量的字符（自动换行）。

到目前为止，我的尝试深受 similar function called walk_tree in the sources 的影响：

#!/usr/bin/env python

import ruamel.yaml

from ruamel.yaml.scalarstring import ScalarString, PreservedScalarString

def walk_tree(base):
    from ruamel.yaml.compat import string_types

    if isinstance(base, dict):
        for k in base:
            v = base[k]
            if isinstance(v, string_types):
                v = v.replace('\r\n', '\n').replace('\r', '\n').strip()
                base[k] = ScalarString(v) if '\n' in v else v
            else:
                walk_tree(v)
    elif isinstance(base, list):
        for idx, elem in enumerate(base):
            if isinstance(elem, string_types) and '\n' in elem:
                print(elem) # @Anthon: this print is in the original code as well
                base[idx] = preserve_literal(elem)
            else:
                walk_tree(elem)

with open("input.yaml", "r") as fi:
    inp = fi.read()

loader=ruamel.yaml.RoundTripLoader
data = ruamel.yaml.load(inp, loader)

walk_tree(data)

dumper = ruamel.yaml.RoundTripDumper

with open("output.yaml", "w") as fo:
    ruamel.yaml.dump(data, fo, Dumper=dumper, allow_unicode=True)

但是我得到一个例外：ruamel.yaml.representer.RepresenterError: cannot represent an object: …。如果我将 ScalarString 替换为 PreservedScalarString 我也没有例外，就像原始 walk_tree 代码中的情况一样，但随后我又得到了文字块，这不是我想要的。

那么如何修复我的代码使其正常工作？

Answer 1

class ScalarString 是 LiteralScalarString 的基础 class，正如您所发现的，它没有代表。您应该 make/keep 这是一个 Python 字符串，因为它适当地处理了特殊字符（引用需要引用以符合 YAML 规范的字符串）。

假设您有这样的输入：

- 1
- abc: |
    this is a short string scalar with a newline
    in it
- "there are also a multiline\nsequence element\nin this file\nand it is longer"

您可能想要执行以下操作：

import ruamel.yaml
from ruamel.yaml.scalarstring import LiteralScalarString, preserve_literal


def walk_tree(base):
    from ruamel.yaml.compat import string_types

    def test_wrap(v):
        v = v.replace('\r\n', '\n').replace('\r', '\n').strip()
        return v if len(v) < 72 else preserve_literal(v)

    if isinstance(base, dict):
        for k in base:
            v = base[k]
            if isinstance(v, string_types) and '\n' in v:
                base[k] = test_wrap(v)
            else:
                walk_tree(v)
    elif isinstance(base, list):
        for idx, elem in enumerate(base):
            if isinstance(elem, string_types) and '\n' in elem:
                base[idx] = test_wrap(elem)
            else:
                walk_tree(elem)

yaml = YAML()

with open("input.yaml", "r") as fi:
    data = yaml.load(fi)

walk_tree(data)

with open("output.yaml", "w") as fo:
    yaml.dump(data, fo)

获取输出：

- 1
- abc: "this is a short string scalar with a newline\nin it"
- |-
  there are also a multiline
  sequence element
  in this file
  and it is longer

一些注意事项：

使用 LiteralScalarString 优于 PreservedScalarString。后者命名为唯一保留的字符串类型时的残余。
您可能没有包含字符串的序列元素，因为您没有导入 preserve_literal，尽管它仍在复制的代码中使用。
我将 "wrapping" 代码分解为 test_wrap，用于值和元素换行，其最大行长度设置为 72 个字符。
值 data[1]['abc'] 加载为 LiteralScalarString。如果你想保留现有的文字样式字符串标量，你应该在测试类型 string_types.
我将新的 API 与 YAML()
如果将示例中的 72 增加到默认值 80 以上，您可能必须将 width 属性设置为 1000 之类的值，以防止自动换行。(yaml.width = 1000)

将 YAML 多行值转换为折叠块标量样式？

Convert YAML multi-line values to folded block scalar style?

python

yaml

ruamel.yaml