【问题标题】:Unwished indent and dash added in first line of yaml file with ruamel.yaml使用 ruamel.yaml 在 yaml 文件的第一行添加了不希望的缩进和破折号
【发布时间】:2021-09-21 03:18:43
【问题描述】:

我目前正在使用以下代码加载单文档模板 YAML 文件,稍微更改它,并生成(即转储)不同的新部署文件。代码如下所示:

import yaml
import copy
import ruamel.yaml
from ruamel.yaml.scalarstring import (DoubleQuotedScalarString as dq, 
                                      SingleQuotedScalarString as sq)
#As requested, below a summary of the functionality of the function define_exp_parameters
def define_exp_parameters(experiment_template, deployments):
    deployment_list = []
    for duration in range(30, 71, 1):
        for cpu_cores in range(1, 4):
                        
            exp_doc[0]['spec']['annotationCheck'] = 'true'
            deployment_list.append(copy.deepcopy(exp_doc)) 
    return deployment_list   
        
testyaml = ruamel.yaml.YAML()
    
with open(template_dir, 'r') as read_file:

    deployments = testyaml.load_all(read_file)
    deployments = list(deployments)
    # define_exp_parameters is used to generate different YAML deployments, each of which are added to a list, which is returned. The list basically consists of x YAML deployment definitions which are later dumped in seperate files.
    deployments = define_exp_parameters(experiment_template, deployments)
            
i = 1
for deployment in deployments:
    with open(save_dir) as created_file:
            
        testyaml.default_flow_style = False
            
        testyaml.dump(deployment, created_file)
            
    i += 1

模板如下所示:

apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
  name: teastore-chaos
  namespace: default
spec:
  annotationCheck: 'false'
  engineState: active
  appinfo:
    appns: default
    applabel: app=teastore
    appkind: deployment
  chaosServiceAccount: litmus-admin
  components:
    runner:
      runnerAnnotations:
        sidecar.istio.io/inject: 'false'
  jobCleanUpPolicy: delete
  experiments:
  - name: pod-cpu-hog

这会产生具有以下结构的文件:

- apiVersion: litmuschaos.io/v1alpha1
  kind: ChaosEngine
  metadata:
    name: teastore-chaos
    namespace: default
  spec:
    annotationCheck: 'false'
    engineState: active
    appinfo:
      appns: default
      applabel: app=teastore
      appkind: deployment
    chaosServiceAccount: litmus-admin
    components:
      runner:
        runnerAnnotations:
          sidecar.istio.io/inject: 'false'
    jobCleanUpPolicy: delete
    experiments:
    - name: pod-cpu-hog

但是,我想要的结构如下(即与模板相同):

apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
  name: teastore-chaos
  namespace: default
spec:
  annotationCheck: 'false'
  engineState: active
  appinfo:
    appns: default
    applabel: app=teastore
    appkind: deployment
  chaosServiceAccount: litmus-admin
  components:
    runner:
      runnerAnnotations:
        sidecar.istio.io/inject: 'false'
  jobCleanUpPolicy: delete
  experiments:
  - name: pod-cpu-hog

基本上,第一行不应该有破折号(由于某种原因,它是自动生成/添加的,因为它不在原始模板文件中)并且不应该有额外的第一个缩进整个结构(我认为与破折号一起出现)。我正在使用 ruamel.yaml 进行转储,因为它保留了字符串中的显式单引号(使用导入的包)。我曾尝试寻找类似的案例和ruamel.yaml 文档,但找不到原因/解决方案。

【问题讨论】:

  • 缩进确实与破折号一起出现。

标签: python yaml ruamel.yaml


【解决方案1】:

如果没有define_exp_parameters() 的来源,就不可能准确描述出了什么问题。但在调用 deployments 是一个 list 之前,它包含一个 dict 元素(带有键 apiVersionkind 等)。之后调用deployments 是一个单元素列表(哪些元素是前面提到的字典)。您遍历“外部”列表并转储单个元素列表,该列表以块样式为您提供-,它是块序列元素指示器。

如果您无法修复 define_exp_parameters() 以再次返回每个元素都是 dict 的列表,您可以转储 deployment 的第一个元素:

testyaml.dump(deployment[0], created_file)

【讨论】:

  • 感谢您的回复!根据要求,我在代码部分添加了 define_exp_parameters() 的功能。基本上,它只是编辑一些值。我尝试了你的解决方案,它奏效了。非常感谢!
  • 您在该函数中有exp_doc[0] 表明exp_doc 是一个列表,然后您将其附加到要返回的值。您可以在那里执行deployment_list.append(copy.deepcopy(exp_doc[0])) 之类的操作,而不是我在回答中给出的解决方案。
  • 是的,但它在计算方面重要吗?感谢您抽出宝贵时间!我很感激。
  • IMO 唯一重要的是了解数据中额外列表层的来源导致- 和缩进。是否应该首先添加额外的层,或者在程序中删除它的位置,取决于您对数据的使用,在其他情况下对例程的潜在重用等。这取决于您,计算上只有一个具有额外层的微小开销。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2021-12-11
  • 1970-01-01
  • 1970-01-01
  • 2017-06-29
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多