Python“ yaml”模块从JSON格式转换意外的YAML

Question

我正在尝试将JSON数据转换为YAML格式，但是得到了意外的YAML输出

使用在线工具将JSON转换为YAML，从而提供预期的YAML输出。 但是，当以下Python代码中使用相同的JSON时，会得到意外的不同结果。

import yaml                                                                     

job_template = [                                                                
  {                                                                             
    "job-template": {                                                           
      "name": "{name}_job",                                                     
      "description": "job description",                                         
      "project-type": "multibranch",                                            
      "number-to-keep": 30,                                                     
      "days-to-keep": 30,                                                       
      "scm": [                                                                  
        {                                                                       
          "git": {                                                              
            "url": "{git_url}"                                                  
          }                                                                     
        }                                                                       
      ]                                                                         
    }                                                                           
  }                                                                             
]                                                                               

yaml.dump(job_template, open("job_template.yaml", "w"))   

预期低于YAML数据：

- job-template:
    name: "{name}_job"
    description: job description
    project-type: multibranch
    number-to-keep: 30
    days-to-keep: 30
    scm:
    - git:
        url: "{git_url}"

取得以下YAML格式：

 - job-template:
     days-to-keep: 30
     description: job description
     name: '{name}_job'
     number-to-keep: 30
     project-type: multibranch
     scm:
     - git: {url: '{git_url}'}

Answer 1

使用default_flow_style=False

例如：

import yaml                                                                     

job_template = [                                                                
  {                                                                             
    "job-template": {                                                           
      "name": "{name}_job",                                                     
      "description": "job description",                                         
      "project-type": "multibranch",                                            
      "number-to-keep": 30,                                                     
      "days-to-keep": 30,                                                       
      "scm": [                                                                  
        {                                                                       
          "git": {                                                              
            "url": "{git_url}"                                                  
          }                                                                     
        }                                                                       
      ]                                                                         
    }                                                                           
  }                                                                             
]                                                                               

yaml.dump(job_template, open("job_template.yaml", "w"), default_flow_style=False)  

Answer 2

问题出在Python代码中： dict是一个无序的容器。 pprint只是给出了yaml输出的相同顺序：

>>> pprint.pprint(job_template)
[{'job-template': {'days-to-keep': 30,
                   'description': 'job description',
                   'name': '{name}_job',
                   'number-to-keep': 30,
                   'project-type': 'multibranch',
                   'scm': [{'git': {'url': '{git_url}'}}]}}]

如果问题是关于最后一级字典{"url": "{git_url}"} ，则答案已由@Rakesh给出。

Answer 3

PyYAML中顺序的更改阻碍了对YAML文件的双向编辑，并且许多其他解析器都试图解决该问题。

值得一看的是Ruamel.yaml ，它在其概述页面上显示 ：

block style and key ordering are kept, so you can diff the round-tripped source

作者提供的代码示例演示了这一点：

import sys
import ruamel.yaml as yaml

yaml_str = """\
3: abc
conf:
    10: def
    3: gij     # h is missing
more:
- what
- else
"""

data = yaml.load(yaml_str, Loader=yaml.RoundTripLoader)
data['conf'][10] = 'klm'
data['conf'][3] = 'jig'
yaml.dump(data, sys.stdout, Dumper=yaml.RoundTripDumper)
will give you:

3: abc
conf:
  10: klm
  3: jig       # h is missing
more:
- what
- else

这是更充分的讨论在这里 。 它被描述为是PyYAML的直接替代品，因此应该易于在您的环境中进行试验。

Answer 4

首先，您只需要将作业模板保留在JSON文件中，例如input.json ：

[                                                                
  {                                                                             
    "job-template": {                                                           
      "name": "{name}_job",                                                     
      "description": "job description",                                         
      "project-type": "multibranch",                                            
      "number-to-keep": 30,                                                     
      "days-to-keep": 30,                                                       
      "scm": [                                                                  
        {                                                                       
          "git": {                                                              
            "url": "{git_url}"                                                  
          }                                                                     
        }                                                                       
      ]                                                                         
    }                                                                           
  }                                                                             
]

这样，您可以更轻松地调整脚本来处理不同的文件。 这样做还保证了JSON对象中的键是有序的，当您在代码中包含JSON作为dicts和list时，这是不能保证的，至少对于所有当前版本的Python而言，这都不是保证的

然后，由于YAML 1.2（规范于2009年发布）是YAML的超集，因此您可以使用YAML 1.2库，该库在加载转储时保留键顺序以将其转换为所需的格式。 由于PyYAML仍然停留在2005年发布的YAML 1.1规范中，因此您不能使用它，但是可以使用ruamel.yaml （免责声明，我是该软件包的作者）。

唯一的“问题”是ruamel.yaml还将保留输入中的（流）样式。 那正是您不想要的。

因此，您必须递归遍历数据结构并更改包含该信息的属性：

import sys
import ruamel.yaml

def block_style(d):
    if isinstance(d, dict):
        d.fa.set_block_style()
        for key, value in d. items():
            try:
                if '{' in value:
                    d[key] = ruamel.yaml.scalarstring.DoubleQuotedScalarString(value)
            except TypeError:
                pass
            block_style(value)
    elif isinstance(d, list):
        d.fa.set_block_style()
        for elem in d:
            block_style(elem)

yaml = ruamel.yaml.YAML()

with open('input.json') as fp:
    data = yaml.load(fp)

block_style(data)

yaml.dump(data, sys.stdout)

这使：

- job-template:
    name: "{name}_job"
    description: job description
    project-type: multibranch
    number-to-keep: 30
    days-to-keep: 30
    scm:
    - git:
        url: "{git_url}"

上面对于Python2和Python3同样有效

对'{'的额外代码测试是对不能用普通标量表示的字符串强制使用双引号。 默认情况下，如果不需要使用YAML双引号标量中可用的额外转义序列来表示字符串， ruamel.yaml将使用单引号标量。