用ruamel YAML保存yaml的结构

Question

我一直在使用ruamel yaml编辑我的YAML文件并将它们转储回来。我需要帮助理解如何保持与原始文件相同的结构，因为我所做的一切就是复制、编辑和重写它。

例如，这是原始文件：

    ElasticLoadBalancingV2Listener:
        Type: "AWS::ElasticLoadBalancingV2::Listener"
        Properties:
            LoadBalancerArn: !Ref ElasticLoadBalancingV2LoadBalancer
            Port: !FindInMap [NLBPorts, Port1, Port]
            Protocol: "TCP"
            DefaultActions:
              -
                Order: 1
                TargetGroupArn: !Ref ElasticLoadBalancingV2TargetGroup1
                Type: "forward"

新文件看起来不一样：

    ElasticLoadBalancingV2Listener:
        Type: "AWS::ElasticLoadBalancingV2::Listener"
        Properties:
            LoadBalancerArn: !Ref ElasticLoadBalancingV2LoadBalancer
            Port: !FindInMap [NLBPorts, Port1, Port]
            Protocol: "TCP"
            DefaultActions:
            -  Order: 1
               TargetGroupArn: !Ref ElasticLoadBalancingV2TargetGroup1
               Type: "forward"

最大的问题是我使用了ruamel的各种技巧来修复这个问题，但每次yaml的一些不同部分都会崩溃。

这是我的函数：

def editEndpointServiceTemplate(endpoint_service_template_path):
    yaml = YAML()
    yaml.preserve_quotes = True
    # yaml.compact(seq_seq=False, seq_map=False)
    # yaml.indent(mapping=4, sequence=3, offset=0)

    #Load yaml file
    with open(endpoint_service_template_path) as fp:
        data = yaml.load(fp)
    
    #Edit the yaml
    data['Description'] = "CloudFormation"

    #Write new yaml file
    with open(endpoint_service_template_path, 'w') as fp:
        yaml.dump(data, fp)

正如你在注释命令中看到的，我修改了一些设置，但找不到最佳的位置。

Answer 1

在这种情况下，很明显你的函数没有产生你所呈现的输出(不同的缩进，缺少单词"CloudFormation")，但通常你应该注意问题这是相同的，并且你的程序是完整的，这样结果可以更容易地被重现。

ruamel.yaml没有针对所有罕见格式的内置函数，但是使用.indent(mapping=4, sequence=4, offset=2)方法和逐行检查转换方法的输出比较接近。

由于使用字符串标量的情况下，序列指示符后面跟着三个空格("- ")的可能性较小(另外，必须进行换行才能成为一行中的第一个非空格)，因此您最好执行.indent(mapping=4, sequence=4, offset=0)转换：

import sys
import ruamel.yaml

yaml_str = """\
ElasticLoadBalancingV2Listener:
    Type: "AWS::ElasticLoadBalancingV2::Listener"
    Properties:
        LoadBalancerArn: !Ref ElasticLoadBalancingV2LoadBalancer
        Port: !FindInMap [NLBPorts, Port1, Port]
        Protocol: "TCP"
        DefaultActions:
          -
            Order: 1
            TargetGroupArn: !Ref ElasticLoadBalancingV2TargetGroup1
            Type: "forward"
"""

yaml = ruamel.yaml.YAML()
yaml.indent(mapping=4, sequence=4, offset=0)
yaml.preserve_quotes = True
data = yaml.load(yaml_str)
data['Description'] = "CloudFormation"

def break_seq(s):
    result = []
    PAT = '-   '
    for line in s.splitlines():
        ls_line = line.lstrip()
        if ls_line.startswith(PAT):
            line = line.replace(PAT, '  - \n' + ' ' * (line.index(PAT) + 4))
        result.append(line)
    return '\n'.join(result)

yaml.dump(data, sys.stdout, transform=break_seq)

这就给出了：

ElasticLoadBalancingV2Listener:
    Type: "AWS::ElasticLoadBalancingV2::Listener"
    Properties:
        LoadBalancerArn: !Ref ElasticLoadBalancingV2LoadBalancer
        Port: !FindInMap [NLBPorts, Port1, Port]
        Protocol: "TCP"
        DefaultActions:
          - 
            Order: 1
            TargetGroupArn: !Ref ElasticLoadBalancingV2TargetGroup1
            Type: "forward"
Description: CloudFormation

上述工作可以通过“space”序列化成序列的例程来完成，但是通常只转换输出更容易，尽管在时间/空间使用上效率不高。

除非使用此输出的程序使用不完整的YAML解析器，否则加载的实际数据结构不会更改，只是对于不习惯这种不常见格式的人来说可读性较差。