使用 ruamel yaml 保留 YAML 的结构答案

【问题标题】：Preserve structure of YAML with ruamel yaml使用 ruamel yaml 保留 YAML 的结构
【发布时间】：2021-02-22 14:39:32
【问题描述】：

我一直在使用 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)

正如您在注释命令中看到的那样，我对设置进行了修改，但找不到最佳位置。

【问题讨论】：

没有简单的方法可以在 ruamel.yaml 中的单独行上获取序列指示符 (-)（并且您不能在此类指示符和序列项之间添加注释，这将相当于对同一件事）。您应该尝试yaml.indent(mapping=4, sequence=4, offset=2) 来获取您的意见，但除此之外。
感谢 Anthon，我一直在关注这个社区中的所有 cmets，希望您能对我的帖子发表评论。糟透了，我对 ruamel 无能为力。您能否提出一种不同的方法来实现我想要做的事情？
@Daniel：Stack Overflow 具有edit 问题帖子的功能。请使用此功能，而不是删除问题（this 和 that）并再次询问同样的问题。

标签： ruamel.yaml

【解决方案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

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

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

【讨论】：