如何使用显式引用转储YAML?

时间:2016-09-16 14:34:48

标签: python yaml pyyaml ruamel.yaml

递归引用在ruamel.yamlpyyaml

中效果很好
$ ruamel.yaml.dump(ruamel.yaml.load('&A [ *A ]'))
'&id001
- *id001'

然而,它(显然)不适用于普通参考:

$ ruamel.yaml.dump(ruamel.yaml.load("foo: &foo { a: 42 }\nbar: { <<: *foo }"))
bar: {a: 42}
foo: {a: 42}

我想明确创建一个引用:

data = {}
data['foo'] = {'foo': {'a': 42}}
data['bar'] = { '<<': data['foo'], 'b': 43 }

$ ruamel.yaml.dump(data, magic=True)
foo: &foo
    a: 42
bar: 
    <<: *foo
    b: 43

这对于生成具有许多公共密钥的大型数据结构的YAML输出非常有用

如果没有对输出有争议的re.replace怎么可能呢?

实际上ruamel.yaml.dump(data)的结果是

bar:
  '<<': &id001
    foo:
      a: 42
  b: 43
foo: *id001

因此,我需要将'<<'替换为<<,并将id001替换为foo

1 个答案:

答案 0 :(得分:3)

如果你想创建类似的东西,至少在ruamel.yaml¹中,你应该使用往返模式,这也保留了合并。以下内容不会引发断言错误:

import ruamel.yaml

yaml_str = """\
foo: &xyz
  a: 42
bar:
  <<: *xyz
"""

data = ruamel.yaml.round_trip_load(yaml_str)
assert ruamel.yaml.round_trip_dump(data) == yaml_str

这意味着data有足够的信息来重新创建输出中的合并。然而,在实践中,在往返模式中,合并永远不会发生。而是检索值data['foo']['bar']['a']意味着'bar'中没有真正的密钥data['foo'],但随后在附加的“合并映射”中查找该密钥。

没有公共接口(因此可能会发生变化),但通过分析data并查看ruamel.yaml.comments.CommentedMap(),您会发现有merge_attrib(当前是字符串) _yaml_merge)并且有一个方法add_yaml_merge()更有用。后者采用(int,CommentedMap())元组的列表。

baz = ruamel.yaml.comments.CommentedMap()
baz['b'] = 196
baz.yaml_set_anchor('klm')
data.insert(1, 'baz', baz)

您需要在'baz'数据键之前插入'bar'键,否则映射将反转。在data['bar']的合并中插入新结构后:

data['bar'].add_yaml_merge([(0, baz)])
ruamel.yaml.round_trip_dump(data, sys.stdout)

给出:

foo: &xyz
  a: 42
baz: &klm
  b: 196
bar:
  <<: [*xyz, *klm]

(如果您想查看add_yaml_merge插入

的内容
print(getattr(data['bar'], ruamel.yaml.comments.merge_attrib))

来电之前和之后)

如果你想从头开始,你可以这样做:

data = ruamel.yaml.comments.CommentedMap([
    ('foo', ruamel.yaml.comments.CommentedMap([('a', 42)])),
    ])
data['foo'].yaml_set_anchor('xyz')
data['bar'] = bar = ruamel.yaml.comments.CommentedMap()
bar.add_yaml_merge([(0, data['foo'])])

而不是data = ruamel.yaml.round_trip_load(yaml_str)

¹免责声明:我是该套餐的作者。