YAML(YAML Ain't Markup Language)は、人間に優しく、言語を超えたデータシリアライゼーション言語で、一般的に設定ファイルに使用され、データをマッピング、シーケンス、スカラーとして表現します。バージョン1.2では、YAMLはJSONの厳密なスーパーセットとなりました。プロキシやスクレイピングの作業では、YAMLは設定ファイルに現れます。たとえば、Envoyプロキシの静的設定はYAMLで記述されており、トラフィックが流れるリスナーとクラスターを定義しています。

YAML構文の基本

  • マッピング: key: valueペア、辞書やハッシュのようなものです。
  • シーケンス: 各項目が独自の行にあり、-で始まるリストです。
  • インデント: ブロックスタイルでは、インデントが構造を決定するため、スペースが誤って配置されるとデータの意味が変わります。
  • タブなし: インデントにはタブ文字を使用してはいけません。
  • コメント: #はコメントを開始します。

スクレイパーとプロキシ設定でのYAMLの安全な使用

YAMLパーサーは、単純なデータを読むだけではありません。PyYAMLのドキュメントは、信頼できないソースからのデータに対してyaml.loadを呼び出すことは安全ではないと警告しています。なぜなら、任意のPythonオブジェクトを構築することができるからです。yaml.safe_load関数は標準のYAMLタグのみを認識するため、信頼できない入力のための文書化された選択肢となります。

複数行の文字列、アンカー、および複数のドキュメント

  • リテラルブロック (|): 複数行の文字列内のすべての改行を保持します。
  • 折り畳みブロック (>): 空行またはよりインデントされた行の前を除いて、各改行をスペースに変えます。
  • アンカーとエイリアス: &nameはノードをマークし、*nameはそれを後で再利用します。
  • 複数のドキュメント: ---はドキュメントの内容の開始をマークするため、1つのストリームに複数のドキュメントを保持できます。...は新しいドキュメントを開始せずにドキュメントを終了します。

関連用語