yaml和jinja2读者

时间:2017-02-07 06:59:13

标签: python jinja2 pyyaml

我希望能够在python中读取YAML jinja配置文件,就像使用PyYAML库一样,但是我收到了错误:

{% set name = "abawaca" %}
{% set version = "1.00" %}

package:
   name: {{ name }}
   version: {{ version }}

source:
   fn: {{ name }}-{{ version }}.tar.gz
   url: https://github.com/CK7/abawaca/archive/v{{ version }}.tar.gz
   sha256: 57465bb291c3a9af93605ffb11d704324079036205e5ac279601c9e98c467529

build:
   number: 0

requirements:
   build:
        - gcc   # [not osx]
        - llvm  # [osx]

1 个答案:

答案 0 :(得分:2)

您的输入无效YAML,因为您可以轻松检查,例如here 您应首先展开{% %}构造,然后处理YAML,或者您应该将文件转换为有效的YAML。

这是选择jinja2的部分结果,其中宏序列{% ... %}以一个在YAML中具有特殊含义的字符({)开头。

如果您需要更改YAML并再次将其写出来,您可以定义自己的分隔符并选择它们,以便在YAML中不具有特殊含义。

{% %}您应该放入YAML注释块,因为您在顶层有映射,并且应该只有键值对。实现这一目标的一种方法是将开头重新定义为#% %#(您不必改变结束,但我更喜欢对称)。

然后在更新之后,通过处理文件的小脚本运行正确的YAML,并将分隔符替换为jinja2理解的分隔符,或者调整环境,以更改jinja2使用的实际定义。

更正data.yaml

#% set name = "abawaca" %#
#% set version = "1.00" %#

package:
   name: <{ name }>
   version: 42

source:
   fn: <{ name }>-<{ version }>.tar.gz
   url: https://github.com/CK7/abawaca/archive/v<{ version }>.tar.gz
   sha256: 57465bb291c3a9af93605ffb11d704324079036205e5ac279601c9e98c467529

build:
   number: 0

requirements:
   build:
      - gcc   # [not osx]
      - llvm  # [osx]

这可以通过以下方式处理:

import jinja2
from ruamel import yaml

yaml_file = 'data.yaml'
tmp_file = 'tmp.yaml'

data = yaml.round_trip_load(open(yaml_file))
data['package']['version'] = '<{ version }>'
with open(tmp_file, 'w') as fp:
    yaml.round_trip_dump(data, fp)

environment = jinja2.Environment(
    loader=jinja2.FileSystemLoader(searchpath='.'),
    trim_blocks=True,
    block_start_string='#%', block_end_string='%#',
    variable_start_string='<{', variable_end_string='}>')

    print(environment.get_template(tmp_file).render())

给予:

package:
  name: abawaca
  version: 1.00

source:
  fn: abawaca-1.00.tar.gz
  url: https://github.com/CK7/abawaca/archive/v1.00.tar.gz
  sha256: 57465bb291c3a9af93605ffb11d704324079036205e5ac279601c9e98c467529

build:
  number: 0

requirements:
  build:
  - gcc       # [not osx]
  - llvm      # [osx]

请注意,您必须使用`ruamel.yaml(免责声明:我是该软件包的作者),您不能轻易地使用PyYAML执行此操作,因为它会删除有关读取YAML文件的注释。由于注释中的所有jinja2都出现在文件的开头,因此您可以使用此特定示例解决此问题,但通常情况并非如此。