Python ruamel.yaml转储带引号的标签

Question

我正在尝试使用ruamel.yaml使用python动态修改AWS CloudFormation模板。 我添加了以下代码，以使safe_load与CloudFormation函数一起使用，例如!Ref 。 但是，当我将它们转储出来时，那些带有！Ref（或任何其他函数）的值将被引号括起来。 CloudFormation无法识别出来。

见下面的例子：

import sys, json, io, boto3
import ruamel.yaml

def funcparse(loader, node):
  node.value = {
      ruamel.yaml.ScalarNode:   loader.construct_scalar,
      ruamel.yaml.SequenceNode: loader.construct_sequence,
      ruamel.yaml.MappingNode:  loader.construct_mapping,
  }[type(node)](node)
  node.tag = node.tag.replace(u'!Ref', 'Ref').replace(u'!', u'Fn::')
  return dict([ (node.tag, node.value) ])

funcnames = [ 'Ref', 'Base64', 'FindInMap', 'GetAtt', 'GetAZs', 'ImportValue',
              'Join', 'Select', 'Split', 'Split', 'Sub', 'And', 'Equals', 'If',
              'Not', 'Or' ]

for func in funcnames:
    ruamel.yaml.SafeLoader.add_constructor(u'!' + func, funcparse)

txt = open("/space/tmp/a.template","r")
base = ruamel.yaml.safe_load(txt)
base["foo"] = {
    "name": "abc",
    "Resources": {
        "RouteTableId" : "!Ref aaa",
        "VpcPeeringConnectionId" : "!Ref bbb",
        "yourname": "dfw"
    }
}

ruamel.yaml.safe_dump(
    base,
    sys.stdout,
    default_flow_style=False
)

输入文件是这样的：

foo:
  bar: !Ref barr
  aa: !Ref bb

输出是这样的：

foo:
  Resources:
    RouteTableId: '!Ref aaa'
    VpcPeeringConnectionId: '!Ref bbb'
    yourname: dfw
  name: abc

注意'！Ref VpcRouteTable'被单引号括起来。 CloudFormation不会识别这一点。 有没有办法配置转储器，以便输出如下：

foo:
  Resources:
    RouteTableId: !Ref aaa
    VpcPeeringConnectionId: !Ref bbb
    yourname: dfw
  name: abc

我试过的其他事情：

• pyyaml库，工作原理相同
• 使用Ref ::而不是！Ref，也一样

Answer 1

本质上，你调整加载器，加载标记（标量）对象，就像它们是映射一样，标记为键，值为标量。 但是你没有做任何事情来区分从这样的映射加载的dict和从正常映射加载的其他dicts，也没有任何特定的代码来表示这样的映射“获取标记”。

当您尝试使用标记“创建”标量时，您只需创建一个以感叹号开头的字符串，并且需要转储引号以将其与实际标记的节点区分开来。

什么模糊这一切，是你的例子通过分配base["foo"]来覆盖加载的数据所以你可以从safe_load和你之前的所有代码中得到的唯一的东西是它不会抛出异常。 即如果你省略以base["foo"] = {开头的行base["foo"] = {你的输出将如下所示：

foo:
  aa:
    Ref: bb
  bar:
    Ref: barr

并且在那个Ref: bb与正常倾销的dict无法区分。 如果你想探索这个路径，那么你应该创建一个子类TagDict(dict) ，并让funcparse返回该子类， 并为该子类添加一个representer ，从该键重新创建标记，然后转储该值 。 一旦有效（往返等于输入），您可以：

     "RouteTableId" : TagDict('Ref', 'aaa')

如果这样做，除了删除未使用的库之外，还应该更改代码以关闭代码中的文件指针txt ，因为这可能会导致问题。 您可以使用with语句优雅地执行此操作：

with open("/space/tmp/a.template","r") as txt:
    base = ruamel.yaml.safe_load(txt)

（我也会省略"r" （或在它之前加一个空格）;并用一个更合适的变量名替换txt ，表明这是一个（输入）文件指针）。

您的funcnames也有两次'Split'条目，这是多余的。

---

通过使用匹配任何标记并具有三种基本类型的multi-constructor来覆盖标量，映射和序列，可以实现更通用的解决方案。

import sys
import ruamel.yaml

yaml_str = """\
foo:
  scalar: !Ref barr
  mapping: !Select
    a: !Ref 1
    b: !Base64 A413
  sequence: !Split
  - !Ref baz
  - !Split Multi word scalar
"""

class Generic:
    def __init__(self, tag, value, style=None):
        self._value = value
        self._tag = tag
        self._style = style


class GenericScalar(Generic):
    @classmethod
    def to_yaml(self, representer, node):
        return representer.represent_scalar(node._tag, node._value)

    @staticmethod
    def construct(constructor, node):
        return constructor.construct_scalar(node)


class GenericMapping(Generic):
    @classmethod
    def to_yaml(self, representer, node):
        return representer.represent_mapping(node._tag, node._value)

    @staticmethod
    def construct(constructor, node):
        return constructor.construct_mapping(node, deep=True)


class GenericSequence(Generic):
    @classmethod
    def to_yaml(self, representer, node):
        return representer.represent_sequence(node._tag, node._value)

    @staticmethod
    def construct(constructor, node):
        return constructor.construct_sequence(node, deep=True)


def default_constructor(constructor, tag_suffix, node):
    generic = {
        ruamel.yaml.ScalarNode: GenericScalar,
        ruamel.yaml.MappingNode: GenericMapping,
        ruamel.yaml.SequenceNode: GenericSequence,
    }.get(type(node))
    if generic is None:
        raise NotImplementedError('Node: ' + str(type(node)))
    style = getattr(node, 'style', None)
    instance = generic.__new__(generic)
    yield instance
    state = generic.construct(constructor, node)
    instance.__init__(tag_suffix, state, style=style)


ruamel.yaml.add_multi_constructor('', default_constructor, Loader=ruamel.yaml.SafeLoader)


yaml = ruamel.yaml.YAML(typ='safe', pure=True)
yaml.default_flow_style = False
yaml.register_class(GenericScalar)
yaml.register_class(GenericMapping)
yaml.register_class(GenericSequence)

base = yaml.load(yaml_str)
base['bar'] = {
    'name': 'abc',
    'Resources': {
        'RouteTableId' : GenericScalar('!Ref', 'aaa'),
        'VpcPeeringConnectionId' : GenericScalar('!Ref', 'bbb'),
        'yourname': 'dfw',
        's' : GenericSequence('!Split', ['a', GenericScalar('!Not', 'b'), 'c']),
    }
}
yaml.dump(base, sys.stdout)

哪个输出：

bar:
  Resources:
    RouteTableId: !Ref aaa
    VpcPeeringConnectionId: !Ref bbb
    s: !Split
    - a
    - !Not b
    - c
    yourname: dfw
  name: abc
foo:
  mapping: !Select
    a: !Ref 1
    b: !Base64 A413
  scalar: !Ref barr
  sequence: !Split
  - !Ref baz
  - !Split Multi word scalar

请注意，序列和映射处理正确，也可以创建它们。 但是没有检查：

• 您提供的标签实际上是有效的
• 与标记关联的值是该标记名称的正确类型（标量，映射，序列）
• 如果你希望GenericMapping表现得更像dict ，那么你可能想要它是dict的子类（而不是Generic ）并提供相应的__init__ （ GenericSequence / list idem）

当作业更改为更接近您的作业时：

base["foo"] = {
    "name": "abc",
    "Resources": {
        "RouteTableId" : GenericScalar('!Ref', 'aaa'),
        "VpcPeeringConnectionId" : GenericScalar('!Ref', 'bbb'),
        "yourname": "dfw"
    }
}

输出是：

foo:
  Resources:
    RouteTableId: !Ref aaa
    VpcPeeringConnectionId: !Ref bbb
    yourname: dfw
  name: abc

这正是你想要的输出。

Answer 2

除了Anthon上面的详细解答，针对CloudFormation模板方面的具体问题，我发现了另一个非常快速和甜蜜的解决方法。

仍然使用构造函数代码段来加载YAML。

def funcparse(loader, node):
  node.value = {
      ruamel.yaml.ScalarNode:   loader.construct_scalar,
      ruamel.yaml.SequenceNode: loader.construct_sequence,
      ruamel.yaml.MappingNode:  loader.construct_mapping,
  }[type(node)](node)
  node.tag = node.tag.replace(u'!Ref', 'Ref').replace(u'!', u'Fn::')
  return dict([ (node.tag, node.value) ])

funcnames = [ 'Ref', 'Base64', 'FindInMap', 'GetAtt', 'GetAZs', 'ImportValue',
              'Join', 'Select', 'Split', 'Split', 'Sub', 'And', 'Equals', 'If',
              'Not', 'Or' ]

for func in funcnames:
    ruamel.yaml.SafeLoader.add_constructor(u'!' + func, funcparse)

当我们操纵数据时，而不是做

base["foo"] = {
    "name": "abc",
    "Resources": {
        "RouteTableId" : "!Ref aaa",
        "VpcPeeringConnectionId" : "!Ref bbb",
        "yourname": "dfw"
    }
}

这将包装值!Ref aaa带引号，我们可以简单地做：

base["foo"] = {
    "name": "abc",
    "Resources": {
        "RouteTableId" : {
            "Ref" : "aaa"
        },
        "VpcPeeringConnectionId" : {
            "Ref" : "bbb
         },
        "yourname": "dfw"
    }
}

类似地，对于CloudFormation中的其他函数，例如！GetAtt，我们应该使用它们的长格式Fn::GetAtt并将它们用作JSON对象的键。 问题很容易解决。