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

时间:2016-09-20 13:44:06

标签: python yaml ruamel.yaml

使用此数据结构:

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 个答案:

答案 0 :(得分:7)

新的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()获得您想要的输出结果。

  • 您喜欢的输出对于顶级映射(键ab等)的值具有缩进2,并且对于序列的元素的缩进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à!

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

¹免责声明:我是ruamel.yaml的作者。