如何配置 ruamel.yaml.dump 输出？

Question

使用这个数据结构：

d = {
    (2,3,4): {
        'a': [1,2], 
        'b': 'Hello World!',
        'c': 'Voilà!'
    }
}

我想要这个 YAML：

%YAML 1.2
---
[2,3,4]:
  a:
    - 1
    - 2
  b: Hello World!
  c: 'Voilà!'

不幸的是我得到了这种格式：

$ print ruamel.yaml.dump(d, default_flow_style=False, line_break=1, explicit_start=True, version=(1,2))
%YAML 1.2
---
? !!python/tuple
- 2
- 3
- 4
: a:
  - 1
  - 2
  b: Hello World!
  c: !!python/str 'Voilà!'

即使使用 safe_dump，我也无法配置我想要的输出。如果不对输出进行手动正则表达式处理，我该怎么做？

我发现的唯一丑陋的解决方案是这样的：

def rep(x):
    return repr([int(y) for y in re.findall('^\??\s*-\s*(\d+)', x.group(0), re.M)]) + ":\n"
print re.sub('\?(\s*-\s*(\w+))+\s*:', rep, 
    ruamel.yaml.dump(d, default_flow_style=False, line_break=1, explicit_start=True, version=(1,2)))

Answer 1

新建ruamel.yamlAPI

您无法使用 ruamel.yaml.dump() 获得所需的内容，但使用新的 API，它具有再多几个控件，你就可以很接近了。

import sys
import ruamel.yaml


d = {
    (2,3,4): {
        'a': [1,2], 
        'b': 'Hello World!',
        'c': 'Voilà!'
    }
}

def prep(d):
    if isinstance(d, dict):
        needs_restocking = False
        for idx, k in enumerate(d):
            if isinstance(k, tuple):
                needs_restocking = True
            try:
                if 'à' in d[k]:
                    d[k] = ruamel.yaml.scalarstring.SingleQuotedScalarString(d[k])
            except TypeError:
                pass
            prep(d[k])
        if not needs_restocking:
            return
        items = list(d.items())
        for (k, v) in items:
            d.pop(k)
        for (k, v) in items:
            if isinstance(k, tuple):
                k = ruamel.yaml.comments.CommentedKeySeq(k)
            d[k] = v
    elif isinstance(d, list):
        for item in d:
            prep(item)

yaml = ruamel.yaml.YAML()
yaml.indent(mapping=2, sequence=4, offset=2)
yaml.version = (1, 2)
data = prep(d)
yaml.dump(d, sys.stdout)

给出：

%YAML 1.2
---
[2, 3, 4]:
  a:
    - 1
    - 2
  b: Hello World!
  c: 'Voilà!'

仍然没有简单的方法来抑制序列项之前的 space，因此如果不付出一些努力就无法将 [2,3,4] 替换为 [2, 3, 4]。

原回答：

如果不对内部进行重大返工，使用 ruamel.yaml.dump() 无法准确获得您想要的输出。

您喜欢的输出对顶级映射（键 a、b 等）的值缩进 2，对作为值的序列元素缩进 4对于 a 键（将 - 推到 2 个位置。这至少需要区分映射和序列的缩进级别（如果不是针对单个集合），这是非常重要的。
您的序列输出从 ,（逗号，space）压缩为 "normal" 流样式发出的 ,。 IIRC 这目前不受任何参数的影响，并且由于您在发出集合时几乎没有上下文知识，因此很难 "not include the spaces when emitting a sequence that is a key"。 dump() 的附加选项需要更改几个源文件和类.

难度较低的问题，并提供解决方案：

您的元组必须神奇地转换为序列才能摆脱标签 !!python/tuple。由于您不想影响所有元组，因此 IMO 最好通过创建 tuple 的子类并将其表示为序列（仅当实际用作键时才可选择将此类元组表示为列表）。您可以为此使用 comments.CommentedKeySeq（假设 ruamel.yaml>=0.12.14，它在使用 ruamel.yaml.round_trip_dump()
您的密钥在发射前经过测试，不是一个简单的密钥，因此它得到一个 '? '（问号，space）表示一个复杂的映射键。 .您将不得不更改发射器，以便 SequenceStartEvent 启动一个简单的键（如果它具有流动样式而不是块样式）。另一个问题是这样的 SequenceStartEvent 然后将 "tested" 具有 style 属性（这可能表明明确需要 '?' 在键上）。这需要更改 emitter.py:Emitter.check_simple_key() 和 emitter.py:Emitter.expect_block_mapping_key().
c 的标量字符串值有引号，而 b 的标量字符串值没有。您只能通过使它们成为不同的类型来在 ruamel.yaml 中获得这种输出差异。例如。通过使其键入 scalarstring.SingleQuotedScalarString()（并使用 round_trip_dump()）。

如果你这样做：

import sys
import ruamel.yaml
from ruamel.yaml.comments import CommentedMap, CommentedKeySeq
assert ruamel.yaml.version_info >= (0, 12, 14)

data = CommentedMap()
data[CommentedKeySeq((2, 3, 4))] = cm = CommentedMap()
cm['a'] = [1, 2]
cm['b'] = 'Hello World!'
cm['c'] = ruamel.yaml.scalarstring.SingleQuotedScalarString('Voilà!')

ruamel.yaml.round_trip_dump(data, sys.stdout, explicit_start=True, version=(1, 2))

您将获得：

%YAML 1.2
---
[2, 3, 4]:
  a:
  - 1
  - 2
  b: Hello World!
  c: 'Voilà!'

除了现在一致的缩进级别 2 之外，流样式序列中的额外 spaces 以及所需的 round_trip_dump 将使您尽可能接近什么你想要没有重大返工。

上面的代码是否也丑陋当然是个人喜好问题。

当使用 ruamel.yaml.round_trip_load(preserve_quotes=True).

加载时，输出将无意外地正确往返

如果不需要控制引号，映射键的顺序也不重要，那么您也可以修补普通的转储程序：

def my_key_repr(self, data):
    if isinstance(data, tuple):
        print('data', data)
        return self.represent_sequence(u'tag:yaml.org,2002:seq', data,
                                       flow_style=True)
    return ruamel.yaml.representer.SafeRepresenter.represent_key(self, data)

ruamel.yaml.representer.Representer.represent_key = my_key_repr

那么你可以使用一个正常的顺序：

data = {}
data[(2, 3, 4)] = cm = {}
cm['a'] = [1, 2]
cm['b'] = 'Hello World!'
cm['c'] = 'Voilà!'

ruamel.yaml.dump(data, sys.stdout, allow_unicode=True, explicit_start=True, version=(1, 2))

会给你：

%YAML 1.2
---
[2, 3, 4]:
  a: [1, 2]
  b: Hello World!
  c: Voilà!

请注意，您需要使用 allow_unicode=True 在输出中明确允许 unicode（默认为 round_trip_dump()）。

¹ _{免责声明：我是 ruamel.yaml.}

的作者

如何配置 ruamel.yaml.dump 输出？

How to configure ruamel.yaml.dump output?

python

yaml

ruamel.yaml

新建ruamel.yamlAPI

原回答：