YAML Zen への 10 ステップ

誰もが Ansible を愛していますが、Ansible は YAML です。 構成ファイルには、値のリスト、パラメーターと値のペア、INI ファイル、YAML、JSON、XML など、さまざまな形式があります。 ただし、いくつかの理由から、YAML はその中でも特に難しいと考えられることがよくあります。 特に、YAML 構文は、その新鮮なミニマリズムと階層値を操作する優れた機能にもかかわらず、インデントに対する Python のようなアプローチが煩わしい場合があります。

YAML が腹立たしい場合は、そうすることができますし、そうすべきです。 – 次の 10 のステップを実行して、イライラを許容できるレベルまで軽減し、YAML を好きになってください。 このリストにふさわしく、私たちの XNUMX のヒントにはゼロから番号が付けられ、瞑想やスピリチュアルな実践も自由に追加していきます 😉

0. エディタを機能させる

どのようなテキスト エディターを使用しているかは関係ありません。YAML を操作するためのプラグインが少なくとも XNUMX つはあるはずです。 お持ちでない場合は、すぐに見つけてインストールしてください。 検索と設定に費やす時間は、YAML を編集するたびに何倍にもなります。

たとえば、編集者 アトム はデフォルトで YAML をサポートしますが、GNU Emacs の場合は追加のパッケージをインストールする必要があります。たとえば、 yamlモード.

YAML モードの Emacs とスペースの表示。

お気に入りのエディターに YAML モードがない場合は、設定を操作することで問題の一部を解決できます。 たとえば、標準の GNOME テキスト エディターである Gedit には YAML モードがありませんが、デフォルトでは YAML 構文が強調表示され、インデントを使用した作業を設定できます。

Gedit でインデントを設定します。

プラグイン ドロースペース Gedit の場合、スペースをドットとして表示し、インデント レベルの曖昧さを排除します。

言い換えれば、お気に入りのエディタについて学ぶことに時間を費やしてください。 彼または彼の開発コミュニティが YAML を操作するために提供しているものを調べて、それらの機能を使用してください。 絶対に後​​悔しないでしょう。

1. リンターを使用する

理想的には、プログラミング言語とマークアップ言語は予測可能な構文を使用します。 コンピューターは予測可能性に優れているため、 リンテラ。 yamlint が存在してから 40 年が経ち、YAML リンターを忘れてしまったのに、まだ YAML リンターを使用していない場合は、yamlint を試してみましょう。

インストール ヤムリント 標準の Linux パッケージ マネージャーを使用できます。 たとえば、 Red Hat Enterprise Linux 8か フェドーラ それは次のように行われます:

$ sudo dnf install yamllint

次に、yamllint を実行して、チェックする YAML ファイルを渡します。 エラーのあるファイルをリンターに渡すと、次のようになります。

$ yamllint errorprone.yaml
errorprone.yaml
23:10     error    syntax error: mapping values are not allowed here
23:11     error    trailing spaces  (trailing-spaces)

左側の数字は時間ではなく、エラーの座標、つまり行番号と列番号です。 エラーの説明からは何も分からないかもしれませんが、エラーがどこにあるのかは正確にわかります。 コード内のこの場所を確認するだけで、おそらくすべてが明らかになるでしょう。

yamllint がファイル内にエラーを検出しない場合、画面には何も表示されません。 このような沈黙が怖くて、もう少しフィードバックが必要な場合は、次のように、XNUMX つのアンパサンド (&&) を使用して条件付きエコー コマンドを使用してリンターを実行できます。

$ yamllint perfect.yaml && echo "OK"
OK

POSIX では、前のコマンドが 0 を返した場合に限り、二重アンパサンドが起動されます。そして、yamllint は見つかったエラーの数を返すだけです。これが、この条件構文全体が機能する理由です。

2. YAML ではなく Python で書く

YAML が本当に腹立たしい場合は、文字通り、YAML に書き込まないでください。 アプリケーションが理解できる唯一の形式が YAML である場合があります。 ただし、この場合でも YAML ファイルを作成する必要はありません。 好きなものを書いて変換します。 たとえば、Python には優れたライブラリがあります。 ピヤムル 自己変換とスクリプトによる変換の XNUMX つの変換方法があります。

自己変換

この場合、データ ファイルは YAML を生成する Python スクリプトでもあります。 この方法は、小規模なデータ セットに最適です。 JSON データを Python 変数に書き込み、インポート ディレクティブを先頭に置き、ファイルの最後に出力を実装する XNUMX 行を追加するだけです。

#!/usr/bin/python3	
import yaml 

d={
"glossary": {
  "title": "example glossary",
  "GlossDiv": {
	"title": "S",
	"GlossList": {
	  "GlossEntry": {
		"ID": "SGML",
		"SortAs": "SGML",
		"GlossTerm": "Standard Generalized Markup Language",
		"Acronym": "SGML",
		"Abbrev": "ISO 8879:1986",
		"GlossDef": {
		  "para": "A meta-markup language, used to create markup languages such as DocBook.",
		  "GlossSeeAlso": ["GML", "XML"]
		  },
		"GlossSee": "markup"
		}
	  }
	}
  }
}

f=open('output.yaml','w')
f.write(yaml.dump(d))
f.close

次に、このファイルを Python で実行し、output.yaml ファイルを取得します。

$ python3 ./example.json
$ cat output.yaml
glossary:
  GlossDiv:
	GlossList:
	  GlossEntry:
		Abbrev: ISO 8879:1986
		Acronym: SGML
		GlossDef:
		  GlossSeeAlso: [GML, XML]
		  para: A meta-markup language, used to create markup languages such as DocBook.
		GlossSee: markup
		GlossTerm: Standard Generalized Markup Language
		ID: SGML
		SortAs: SGML
	title: S
  title: example glossary

これは完全に有効な YAML ですが、yamllint は - で始まらないことを警告します。 これは手動で簡単に修正するか、Python スクリプトでわずかに変更することができます。

スクリプトによる変換

この場合、最初に JSON で記述し、次にコンバータを別の Python スクリプトとして実行し、出力として YAML を生成します。 前の方法と比較して、この方法は変換がデータから分離されているため、スケーリングが優れています。

まず、JSON ファイル example.json を作成しましょう。たとえば、以下から取得できます。 json.org:

{
	"glossary": {
	  "title": "example glossary",
	  "GlossDiv": {
		"title": "S",
		"GlossList": {
		  "GlossEntry": {
			"ID": "SGML",
			"SortAs": "SGML",
			"GlossTerm": "Standard Generalized Markup Language",
			"Acronym": "SGML",
			"Abbrev": "ISO 8879:1986",
			"GlossDef": {
			  "para": "A meta-markup language, used to create markup languages such as DocBook.",
			  "GlossSeeAlso": ["GML", "XML"]
			  },
			"GlossSee": "markup"
			}
		  }
		}
	  }
	}

次に、単純なコンバータ スクリプトを作成し、json2yaml.py という名前で保存します。 このスクリプトは、YAML と JSON の両方の Python モジュールをインポートし、ユーザー指定の JSON ファイルをロードして変換を実行し、データを output.yaml ファイルに書き込みます。

#!/usr/bin/python3
import yaml
import sys
import json

OUT=open('output.yaml','w')
IN=open(sys.argv[1], 'r')

JSON = json.load(IN)
IN.close()
yaml.dump(JSON, OUT)
OUT.close()

このスクリプトをシステム パスに保存し、必要に応じて実行します。

$ ~/bin/json2yaml.py example.json

3. 解析を頻繁に行う

問題を別の角度から見ることが役立つ場合があります。 YAML でデータ間の関係を表現するのに問題がある場合は、一時的にデータをより使いやすいものに変換できます。

たとえば、辞書リストや JSON の操作に慣れている場合は、対話型 Python シェルで XNUMX つのコマンドを実行するだけで YAML を JSON に変換できます。 YAML ファイル mydata.yaml があるとします。このファイルは次のようになります。

$ python3
>>> f=open('mydata.yaml','r')
>>> yaml.load(f)
{'document': 34843, 'date': datetime.date(2019, 5, 23), 'bill-to': {'given': 'Seth', 'family': 'Kenlon', 'address': {'street': '51b Mornington Roadn', 'city': 'Brooklyn', 'state': 'Wellington', 'postal': 6021, 'country': 'NZ'}}, 'words': 938, 'comments': 'Good article. Could be better.'}

このトピックに関する他の多くの例を見つけることができます。 さらに、多くのオンライン コンバーターやローカル パーサーが利用可能です。 したがって、理解できないごちゃごちゃのデータしか含まれていない場合は、ためらわずにデータを再フォーマットしてください。

4. 仕様を読む

長い休憩の後に YAML に戻ると、次の訪問が役に立ちます。 yaml.org そして仕様書（スペック）を読み直してみます。 YAML に問題があるにもかかわらず、仕様を理解できていない場合は、この状況を修正する時期が来ています。 仕様は驚くほど簡単に記述でき、構文要件は多数の例で示されています。 第6章.

5. 疑似構成

本や記事を書くときは、最初に少なくとも目次の形式で予備的な概要をスケッチすると常に役に立ちます。 YAMLも同様です。 おそらく、どのデータを YAML ファイルに書き込む必要があるかについては理解していますが、それを相互に接続する方法はよく理解していません。 したがって、YAML をスカルプトする前に、疑似コンフィグを描画します。

擬似構成は擬似コードに似ており、構造やインデント、親子関係、継承、ネストについて心配する必要がありません。 ここでも同じです。頭の中でデータが発生するたびに、データの反復を描画します。

プログラマー (Martin と Tabitha) とそのスキル (プログラミング言語: それぞれ Python、Perl、Pascal、Lisp、Fortran、Erlang) をリストした疑似構成。

紙に疑似構成を描画した後、それを注意深く分析し、すべてが正常であれば、有効な YAML ファイルの形式にフォーマットします。

6. タブとスペースのジレンマ

ジレンマを解決しなければなりません 「タブかスペースか？」。 グローバルな意味ではなく、組織レベル、または少なくともプロジェクトのレベルでのみです。 これに、sed スクリプトによる後処理の使用が含まれるか、プログラマーのマシンにテキスト エディターをセットアップするか、または解雇の脅しの下でリンターの指示に厳密に従っていることを示す受領書を普遍的に取得するかどうかは関係ありません。いずれにせよ、YAML に関連するものでは (YAML 仕様で要求されているように) スペースのみを使用する必要があります。

通常のテキスト エディタでは、タブを指定した数のスペースに自動修正するように設定できるため、主要な支持者の反逆が起こります。 タブ 恐れる必要はありません。

YAML 嫌いの人なら誰でもよく知っているように、画面上ではタブとスペースの違いがわかりません。 そして、何かが目に見えないとき、それは通常、他の考えられる問題をすべて整理し、確認し、排除した後、最後に覚えていることになります。 集計曲線やスペースのブロックを検索するのに XNUMX 時間も費やした場合、どちらかの使用に関するポリシーを早急に作成し、それに従っているかどうか鉄筋コンクリートのチェックを実装する必要があることが叫ばれるだけです (たとえば、リンターを強制的に通過させるための Git フック)。

7. 少ないほど良い (または多いほど少ない)

構造を重視するため、YAML で記述することを好む人もいます。 同時に、インデントを積極的に使用してデータのブロックを強調表示します。 これは、明示的な区切り文字を使用するマークアップ言語を模倣する一種の詐欺です。

以下はそのような構造の例です。 Ansible ドキュメント:

# Employee records
-  martin:
        name: Martin D'vloper
        job: Developer
        skills:
            - python
            - perl
            - pascal
-  tabitha:
        name: Tabitha Bitumen
        job: Developer
        skills:
            - lisp
            - fortran
            - erlang

このオプションは、頭の中で YAML 構造を整理するのに役立つ人もいますが、逆に、不必要なインデントが多くてイライラする人もいます。

ただし、あなたが YAML ドキュメントの所有者であり、それを保守する責任がある場合は、 あなたとあなただけ インデントの使用方法を定義する必要があります。 大きなパディングが煩わしい場合は、YAML 仕様に従って、パディングを最小限に抑えてください。 たとえば、Ansible ドキュメントの上記のファイルは、損失なく次のように書き換えることができます。

---
- martin:
   name: Martin D'vloper
   job: Developer
   skills:
   - python
   - perl
   - pascal
- tabitha:
   name: Tabitha Bitumen
   job: Developer
   skills:
   - lisp
   - fortran
   - erlang

8. ブランクを使用する

YAML ファイルに入力するときに常に同じ間違いを繰り返す場合は、テンプレートをコメントとしてファイルに挿入するのが合理的です。 次に、このテンプレートをコピーして、実際のデータをそこに入力するだけです。次に例を示します。

---
# - <common name>:
#   name: Given Surname
#   job: JOB
#   skills:
#   - LANG
- martin:
  name: Martin D'vloper
  job: Developer
  skills:
  - python
  - perl
  - pascal
- tabitha:
  name: Tabitha Bitumen
  job: Developer
  skills:
  - lisp
  - fortran
  - erlang

9. 別のものを使用する

アプリケーションがあなたを拘束していない場合は、YAML を別の形式に変更する価値があるかもしれません。 時間の経過とともに、構成ファイルが大きくなりすぎる可能性があるため、構成ファイルを Lua または Python の単純なスクリプトに変換することをお勧めします。

YAML は、そのミニマリズムとシンプルさで多くの人に愛される優れたツールですが、使える唯一のツールというわけではありません。 そのため、場合によっては断ることも可能です。 YAML の解析ライブラリは簡単に見つかるので、簡単な移行オプションを提供すれば、ユーザーはこの障害を比較的楽に乗り越えることができます。

YAML なしではやっていけないのであれば、次の 10 のヒントを参考にして、YAML に対する嫌いを完全に克服してください。

出所： habr.com