如何在ruamel.yaml中显式编写两个引用

时间:2018-10-17 09:09:18

标签: ruamel.yaml

如果我有多个引用,并且使用Python的ruaml.yaml将它们写入YAML文件,则会得到:

  <<: [*name-name, *help-name]

但是我宁愿拥有

<<: *name-name
<<: *help-name

在写入文件时是否可以实现此目的?

更新

descriptions:
  - &description-one-ref
    description: >

helptexts:
  - &help-one
    help_text: |

questions:
  - &question-one
    title: "title test"
    reference: "question-one-ref"
    field: "ChoiceField"
    choices:
      - "Yes"
      - "No"
    required: true
    <<: *description-one-ref
    <<: *help-one
    riskvalue_max: 10
    calculations:
      - conditions:
          - comparator: "equal"
            value: "Yes"
        actions:
          - riskvalue: 0
      - conditions:
          - comparator: "equal"
            value: "No"
        actions:
          - riskvalue: 10

目前,我正在读取此类文件并在python中修改特定值,然后再将其写回。在撰写本文时,我遇到的问题是引用是按列表而不是概述的。

这意味着工作流程如下:我正在通过

阅读文档
yaml = ruamel.yaml.YAML()
with open('test.yaml') as f:
    data = yaml.load(f)

for k in data.keys():
    if k == 'questions':
        q = data.get(k)
        for i in range(0, len(q)):
            q[i]['title'] = "my new title"

f.close()
g = open('new_file.yaml', 'w')
yaml(data)
g.close()

1 个答案:

答案 0 :(得分:1)

不,没有这样的选项,因为它会导致无效的YAML文件。

<<是一个映射键,为其解释值 特别是假设解析器实现到language independent merge key specification。并且映射键必须是唯一的 根据{{​​3}}:

  

映射节点的内容是一组无序的键:value节点     对,但每个键都是唯一的。

ruamel.yaml(<0.15.75)不会对此类错误 重复键是YAML specification。在重复的普通键上,ruamel.yaml 确实抛出错误。该错误是从PyYAML继承的(不是 符合规范,即使在 重复的普通键。


但是,只需进行一些预处理和后处理,就可以 容易实现。技巧是在解析之前使YAML有效 通过使有问题的重复<<键唯一(但可以识别) 然后,在将YAML写回到文件中时,将其替换 再次使用<<: *的唯一键。在下面的第一次出现 <<: *替换为[<<, 0]:,第二个替换为[<<, 1]:等。

*应该是替换的一部分,因为其中没有锚 这些别名的文档。

import sys
import subprocess
import ruamel.yaml

yaml = ruamel.yaml.YAML()
yaml.preserve_quotes = True
yaml.indent(sequence=4, offset=2)

class DoubleMergeKeyEnabler(object):
    def __init__(self):
        self.pat = '<<: '  # could be at the root level mapping, so no leading space
        self.r_pat = '[<<, {}]: '   # probably not using sequences as keys
        self.pat_nr = -1

    def convert(self, doc):
        while self.pat in doc:
            self.pat_nr += 1
            doc = doc.replace(self.pat, self.r_pat.format(self.pat_nr), 1)
        return doc

    def revert(self, doc):
        while self.pat_nr >= 0:
            doc = doc.replace(self.r_pat.format(self.pat_nr), self.pat, 1)
            self.pat_nr -= 1
        return doc


dmke = DoubleMergeKeyEnabler()

with open('test.yaml') as fp:
  # we don't do this line by line, that would not work well on flow style mappings
  orgdoc = fp.read()
  doc = dmke.convert(orgdoc)

data = yaml.load(doc)
data['questions'][0].anchor.always_dump = True
#######################################
# >>>> do your thing on data here <<< #
#######################################

with open('output.yaml', 'w') as fp:
    yaml.dump(data, fp, transform=dmke.revert)

res = subprocess.check_output(['diff', '-u', 'test.yaml', 'output.yaml']).decode('utf-8')
print('diff says:', res)

给出:

diff says:

,这意味着往返文件是相同的(只要您不 在转储之前进行任何更改)。

preserve_quotes实例上设置ident()并调用YAML对 请保留您多余的报价。保持缩进。

由于锚点question-one没有别名,因此您需要通过以下方式显式启用转储 将该属性上的always_dump设置为True。如有必要,您可以递归 在data时走过anchor.always_dump = True并设置.anchor.value is not None