Use placeholders in yaml

Is there a way to use placeholders in yaml like this:

foo: &FOO
    <<propname>>: 
        type: number 
        default: <<default>>

bar:
    - *FOO 
       propname: "some_prop"
       default: "some default"

标签： yaml template-variables

1条回答

老娘就宠你

2楼-- · 2019-01-04 04:02

Context

YAML version 1.2
user wishes to include variable placeholders in YAML

Problem

YAML does not natively support variable placeholders
Anchors and Aliases do allow for some level of abstraction and indirection, but these do not work as variable placeholders that can be inserted into arbitrary regions throughout the YAML text. They must be placed as separate YAML nodes
There are some add-on libraries that support arbitrary variable placeholders, but they are not part of the native YAML specification

Example

Consider the following example YAML. It is well-formed YAML syntax, however it uses (non-standard) curly-brace placeholders with embedded expressions.

The embedded expressions do not produce the desired result in YAML, because they are not part of the native YAML specification, but they help illustrate what is available with standard YAML and what is not.

part01_customer_info:
  cust_fname:   "Homer"
  cust_lname:   "Himpson"
  cust_motto:   "I love donuts!"
  cust_email:   homer@himpson.org

part01_government_info:
  govt_sales_taxrate: 1.15

part01_purchase_info:
  prch_unit_label:    "Bacon-Wrapped Fancy Glazed Donut"
  prch_unit_price:    3.00
  prch_unit_quant:    7
  prch_product_cost:  "{{prch_unit_price * prch_unit_quant}}"
  prch_total_cost:    "{{prch_product_cost * govt_sales_taxrate}}"

part02_shipping_info:
  cust_fname:   "{{cust_fname}}"
  cust_lname:   "{{cust_lname}}"
  ship_city:    Houston
  ship_state:   Hexas

part03_email_info:
  cust_email:     "{{cust_email}}"
  mail_subject:   Thanks for your DoughNutz order!
  mail_notes: |
    We want the mail_greeting to have all the expected values
    with filled-in placeholders (and not curly-braces).
  mail_greeting: |
    Greetings {{cust_fname}} {{cust_lname}}!

    We love your motto "{{cust_motto}}" and we agree with you!

    Your total purchase price is {{prch_total_cost}}

    Thank you for your order!

Explanation

The substitutions marked in GREEN are readily available in standard YAML, using anchors, aliases, and merge keys.
The substitutions marked in YELLOW are technically available in standard YAML, but not without a custom type declaration, or some other binding mechanism.
The substitutions marked in RED are not available in standard YAML, and require the use of some kind of string formatting or string template engine (such as python's str.format, for example).

Details

A frequently-requested feature for YAML is the ability to insert arbitrary variable placeholders that support arbitrary cross-references and expressions that relate to the other content in the same (or transcluded) YAML file(s).

YAML supports anchors and aliases, but this feature does not support arbitrary placement of placeholders and expressions anywhere in the YAML text. They only work with YAML nodes.

YAML addon libraries

There are YAML extension libraries, but these are not part of the native YAML spec.

Ansible
- https://docs.ansible.com/ansible-container/container_yml/template.html
- (supports many extensions to YAML, however it is an Orchestration tool, which is overkill if you just want YAML)
https://github.com/kblomqvist/yasha
https://github.com/dreftymac/dynamic.yaml
https://bitbucket.org/djarvis/yamlp

Workarounds

Use YAML in conjunction with a template system, such as Jinja2 or Twig
Use a YAML extension library
Use sprintf or str.format style functionality from the hosting language