как ссылаться на "настройку" YAML из другого места в том же файле YAML?

У меня есть следующий YAML:

paths:
  patha: /path/to/root/a
  pathb: /path/to/root/b
  pathc: /path/to/root/c

как я могу "нормализовать" это, удалив /path/to/root/ из трех путей, и иметь его как свою собственную настройку, что-то вроде:

paths:
  root: /path/to/root/
  patha: *root* + a
  pathb: *root* + b
  pathc: *root* + c

очевидно, что это недействительно, я только что это придумал. Каков настоящий синтаксис? Можно ли это сделать?

85
syntax transclusion yaml

7 ответов

Я не думаю, что это возможно. Вы можете повторно использовать "узел", но не его часть. 

bill-to: &id001
    given  : Chris
    family : Dumars
ship-to: *id001

Это совершенно действительный YAML и поля given и family используются в ship-to заблокировать. Вы можете повторно использовать скалярный узел таким же образом, но вы не можете изменить то, что внутри, и добавить эту последнюю часть пути к нему изнутри YAML.

если повторение беспокоит вас, что много я предлагаю, чтобы сделать ваше приложение в курсе root свойство и добавьте его в каждый путь, который выглядит относительный, а не абсолютный.

81

Да, используя пользовательские теги. Пример в Python, делая !join tag соединить строки в массиве:

import yaml

## define custom tag handler
def join(loader, node):
    seq = loader.construct_sequence(node)
    return ''.join([str(i) for i in seq])

## register the tag handler
yaml.add_constructor('!join', join)

## using your sample data
yaml.load("""
paths:
    root: &BASE /path/to/root/
    patha: !join [*BASE, a]
    pathb: !join [*BASE, b]
    pathc: !join [*BASE, c]
""")

что приводит к:

{
    'paths': {
        'patha': '/path/to/root/a',
        'pathb': '/path/to/root/b',
        'pathc': '/path/to/root/c',
        'root': '/path/to/root/'
     }
}

массив аргументов !join может иметь любое количество элементов любого типа данных, если они могут быть преобразованы в строку, поэтому !join [*a, "/", *b, "/", *c] делает то, что вы ожидаете.

44

другой способ взглянуть на это-просто использовать другое поле.

paths:
  root_path: &root
     val: /path/to/root/
  patha: &a
    root_path: *root
    rel_path: a
  pathb: &b
    root_path: *root
    rel_path: b
  pathc: &c
    root_path: *root
    rel_path: c
10

определение YML:

dir:
  default: /home/data/in/
  proj1: ${dir.default}p1
  proj2: ${dir.default}p2
  proj3: ${dir.default}p3

где-то в thymeleaf

<p th:utext='${@environment.getProperty("dir.default")}' />
<p th:utext='${@environment.getProperty("dir.proj1")}' />

выход: / главная/данные / in/ / главная/данные / in / p1

6

Я создал библиотеку, доступную на Packagist, которая выполняет эту функцию: https://packagist.org/packages/grasmash/yaml-expander

пример файла YAML: 

type: book
book:
  title: Dune
  author: Frank Herbert
  copyright: ${book.author} 1965
  protaganist: ${characters.0.name}
  media:
    - hardcover
characters:
  - name: Paul Atreides
    occupation: Kwisatz Haderach
    aliases:
      - Usul
      - Muad'Dib
      - The Preacher
  - name: Duncan Idaho
    occupation: Swordmaster
summary: ${book.title} by ${book.author}
product-name: ${${type}.title}

пример логики: 

// Parse a yaml string directly, expanding internal property references.
$yaml_string = file_get_contents("dune.yml");
$expanded = \Grasmash\YamlExpander\Expander::parse($yaml_string);
print_r($expanded);

результирующий массив: 

array (
  'type' => 'book',
  'book' => 
  array (
    'title' => 'Dune',
    'author' => 'Frank Herbert',
    'copyright' => 'Frank Herbert 1965',
    'protaganist' => 'Paul Atreides',
    'media' => 
    array (
      0 => 'hardcover',
    ),
  ),
  'characters' => 
  array (
    0 => 
    array (
      'name' => 'Paul Atreides',
      'occupation' => 'Kwisatz Haderach',
      'aliases' => 
      array (
        0 => 'Usul',
        1 => 'Muad\'Dib',
        2 => 'The Preacher',
      ),
    ),
    1 => 
    array (
      'name' => 'Duncan Idaho',
      'occupation' => 'Swordmaster',
    ),
  ),
  'summary' => 'Dune by Frank Herbert',
);
1

в некоторых языках можно использовать альтернативную библиотеку, например,тампакс является реализацией переменных обработки YAML:

const tampax = require('tampax');

const yamlString = `
dude:
  name: Arthur
weapon:
  favorite: Excalibur
  useless: knife
sentence: "{{dude.name}} use {{weapon.favorite}}. The goal is {{goal}}."`;

const r = tampax.yamlParseString(yamlString, { goal: 'to kill Mordred' });
console.log(r.sentence);

// output : "Arthur use Excalibur. The goal is to kill Mordred."
1

что ваш пример недействителен, это только потому что вы выбрали зарезервированный символ для запуска скаляров. Если вы замените * С каким-то другим незарезервированным символом (я обычно использую символы, отличные от ASCII, поскольку они редко используются как часть некоторой спецификации), вы получаете совершенно законный YAML:

paths:
  root: /path/to/root/
  patha: ♦root♦ + a
  pathb: ♦root♦ + b
  pathc: ♦root♦ + c

это загрузится в стандартное представление для отображений на языке, который использует ваш парсер, и не будет магически расширяться что угодно.
Для этого используйте локальный тип объекта по умолчанию, как в следующей программе Python:

# coding: utf-8

from __future__ import print_function

import ruamel.yaml as yaml

class Paths:
    def __init__(self):
        self.d = {}

    def __repr__(self):
        return repr(self.d).replace('ordereddict', 'Paths')

    @staticmethod
    def __yaml_in__(loader, data):
        result = Paths()
        loader.construct_mapping(data, result.d)
        return result

    @staticmethod
    def __yaml_out__(dumper, self):
        return dumper.represent_mapping('!Paths', self.d)

    def __getitem__(self, key):
        res = self.d[key]
        return self.expand(res)

    def expand(self, res):
        try:
            before, rest = res.split(u'♦', 1)
            kw, rest = rest.split(u'♦ +', 1)
            rest = rest.lstrip() # strip any spaces after "+"
            # the lookup will throw the correct keyerror if kw is not found
            # recursive call expand() on the tail if there are multiple
            # parts to replace
            return before + self.d[kw] + self.expand(rest)
        except ValueError:
            return res

yaml_str = """\
paths: !Paths
  root: /path/to/root/
  patha: ♦root♦ + a
  pathb: ♦root♦ + b
  pathc: ♦root♦ + c
"""

loader = yaml.RoundTripLoader
loader.add_constructor('!Paths', Paths.__yaml_in__)

paths = yaml.load(yaml_str, Loader=yaml.RoundTripLoader)['paths']

for k in ['root', 'pathc']:
    print(u'{} -> {}'.format(k, paths[k]))

которая будет печатать:

root -> /path/to/root/
pathc -> /path/to/root/c

расширение выполняется на лету и обрабатывает вложенные определения, но вы должны быть осторожны, чтобы не вызывать бесконечную рекурсию.

указав Дампер, вы можете сбросить исходный YAML из загруженных данных из-за расширения "на лету":

dumper = yaml.RoundTripDumper
dumper.add_representer(Paths, Paths.__yaml_out__)
print(yaml.dump(paths, Dumper=dumper, allow_unicode=True))

это изменит отображение заказ ключей. Если это проблема у вас сделать self.d a CommentedMap (импортированного от ruamel.yaml.comments.py)

-1