web-dev-qa-db-ja.com

同じYAMLファイルの他の場所からYAML「設定」を参照する方法は？

次のYAMLがあります。

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

3つのパスから/path/to/root/を削除して、これを「正規化」し、独自の設定として使用するにはどうすればよいですか。

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

明らかにそれは無効です、私はそれを作りました。実際の構文は何ですか？できますか？

syntaxyamltransclusion
110
Andrew Bullock

可能だとは思いません。 「ノード」は再利用できますが、その一部は再利用できません。

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

これは完全に有効なYAMLであり、フィールドgivenおよびfamilyはship-toブロックで再利用されます。スカラーノードは同じ方法で再利用できますが、内部の内容を変更し、YAMLの内部からパスの最後の部分を追加する方法はありません。

繰り返し気になる場合は、アプリケーションにrootプロパティを認識させ、絶対ではなく相対的に見えるすべてのパスに追加することをお勧めします。

101
vava

はい、カスタムタグを使用します。 !joinタグを配列内の文字列に結合するPythonの例：

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]は期待どおりに動作します。

63
Chris Johnson

これを見る別の方法は、単に別のフィールドを使用することです。

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
15
Brian Bruggeman

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// home/data/in/p1

4
Pavol

一部の言語では、代替ライブラリを使用できます。たとえば、 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."
2
Arthur Lacoste

この機能を実行する、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
grasmash

Pythonに独自のライブラリを作成し、次のような階層を持つディレクトリからロードされる変数を展開しました。

/root
 |
 +- /proj1
     |
     +- config.yaml
     |
     +- /proj2
         |
         +- config.yaml
         |
         ... and so on ...

ここでの主な違いは、すべてのconfig.yamlファイルがロードされた後にのみ展開を適用する必要があることです。

env = YamlEnv()
env.load('/root/proj1/config.yaml')
env.load('/root/proj1/proj2/config.yaml')
...
env.expand()

追加オプションとして、xonshスクリプトは、結果の変数を環境変数にエクスポートできます（yaml_update_global_vars関数を参照）。

スクリプト：

https://sourceforge.net/p/contools/contools/HEAD/tree/trunk/Scripts/Tools/cmdoplib.yaml.pyhttps://sourceforge.net/p/ contools/contools/HEAD/tree/trunk/Scripts/Tools/cmdoplib.yaml.xsh

長所：

  • シンプル、再帰およびネストされた変数をサポートしません
  • 未定義の変数をプレースホルダーに置き換えることができます（${MYUNDEFINEDVAR}-> *$/{MYUNDEFINEDVAR}）
  • 環境変数からの参照を展開できます（${env:MYVAR}）
  • パス変数のすべての\\を/に置き換えることができます（${env:MYVAR:path}）

短所：

  • ネストされた変数をサポートしていないため、ネストされた辞書の値を展開できません（${MYSCOPE.MYVAR}のようなものは実装されていません）
  • プレースホルダーを配置した後の再帰を含む、拡張再帰を検出しません
0
Andry

あなたの例が無効であることは、スカラーを開始するために予約文字を選択したため、onlyです。 *を他の非予約文字（一部の仕様の一部として使用されることはほとんどないため、非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をCommentedMap（ruamel.yaml.comments.pyからインポート）にする必要があります

0
Anthon