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

Posted 2023-02-26

【中文标题】如何配置 ruamel.yaml.dump 输出？

【英文标题】：How to configure ruamel.yaml.dump output?

【发布时间】：2017-01-28 11:30:24

【问题描述】：

有了这个数据结构：

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)))

【参考方案1】：

新的 ruamel.yaml API

您无法使用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à!'

仍然没有简单的方法来抑制序列项之前的空格，因此如果不付出很大的努力，就无法获得[2,3,4] 的[2, 3, 4]。

原答案：

---

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

您喜欢的输出缩进 2 表示***映射的值（键 a、b 等），缩进 4 表示序列元素的值，即 a 键的值（- 被推到 2 个位置。这至少需要映射和序列的缩进级别之间的差异（如果不是针对单个集合），这是不平凡的。 您的序列输出从,（逗号，空格）压缩为“正常”流样式发出的,。 IIRC 这目前不受任何参数的影响，并且由于您在发出集合时几乎没有上下文知识，因此很难“在发出作为键的序列时不包括空格”。 dump() 的附加选项需要更改多个源文件和类。

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

你的元组必须神奇地转换成一个序列来去掉标签!!python/tuple。由于您不想影响所有元组，因此 IMO 最好通过创建 tuple 的子类并将其表示为序列（仅当实际用作键时才将此类元组表示为列表）。您可以为此使用comments.CommentedKeySeq（假设ruamel.yaml>=0.12.14，它在使用ruamel.yaml.round_trip_dump() 时具有适当的表示支持 在发射前测试时，您的密钥不是简单的密钥，因此它会得到一个 '? '（问号，空格）表示一个复杂的映射键。 .您必须更改发射器，以便 SequenceStartEvent 启动一个简单的键（如果它具有流样式而不是块样式）。另一个问题是，这样的 SequenceStartEvent 将被“测试”以具有 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、流样式序列中的额外空格以及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.version_info >= (0, 12, 14) -> (prompted by *** question 39595807 from Nowox)

您的解决方案的最大问题（即使您很好地回答了我的问题）是我无法将常规 Python 字典转换为您的结构。我必须使用CommentedMap 等手动解析我的数据结构才能达到预期的结果。如图所示，这是可行的，但如果 dict 已经存在则不优雅

@nowox 如果元组的键已经存在了很长一段时间，则序列的加载+转换，没有它你将无法加载该 YAML。然而，往返并没有奏效，并且在很长一段时间内一直是一个棘手的问题。你的问题是必要的小推动，所以我不只是为了自己。支持输出的实际更改实际上相对较小。

@nowox 您可以创建一个dump()，通过始终将作为键的元组转换为序列来做到这一点，这样您就失去了转储真实元组的能力。您必须将represent_key() 从普通的倾卸器中更改。但另一个问题（引用Voilà!）仍然存在