Как ссылаться на «настройки» YAML из другого места в том же файле YAML? - PullRequest
Новая
       37

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

106 голосов
/ 14 января 2010

У меня есть следующий 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

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

Ответы [ 7 ]

100 голосов
/ 14 января 2010

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

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

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

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

57 голосов
/ 22 апреля 2014

Да, с использованием пользовательских тегов. Пример на Python, создание тега !join, объединяющего строки в массиве: 

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] делает то, что вы ожидаете.

14 голосов
/ 01 ноября 2014

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

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
4 голосов
/ 02 октября 2017

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

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

Где-то в тимелии 

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

Выход: / Главная / данные / в / / home / data / in / p1

1 голос
/ 01 ноября 2017

В некоторых языках вы можете использовать альтернативную библиотеку. Например, tampax является реализацией переменных обработки 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 голос
/ 13 января 2017

Я создал библиотеку, доступную на 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',
);
0 голосов
/ 06 июня 2015

То, что ваш пример неверен, это только , потому что вы выбрали зарезервированный символ для начала своих скаляров. Если вы замените * каким-либо другим незарезервированным символом (я склонен использовать для этого не-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)

...