2026年11月20日、PythonでYAMLのファイルを読み書きするライブラリPyYAMLの6.0.4が公開されました。前の6.0.3は2025年9月25日の公開だったので、およそ1年2か月ぶりの更新です。
今回は、YAMLのマージキーという書き方を何重にも重ねたときに、読み込みがとても遅くなる問題が直りました。悪意のあるYAMLで、サーバーを止められてしまうおそれのある問題です。
YAMLは、設定ファイルでよく使われる形式ですよね。今回は、6.0.3と6.0.4で同じYAMLを読み込みながら、何が変わったのかを見ていきます。
まずはYAMLとPyYAMLとは¶
最初に、YAMLとPyYAMLを知らない方のために、簡単に紹介します。YAMLは、字下げとコロンで、データの形を人が読みやすく書ける形式です。
GitHub Actionsの設定や、Dockerの設定など、身近なところでたくさん使われています。PyYAMLは、このYAMLをPythonの辞書やリストに変えたり、その逆をしたりするライブラリです。
読み込んでみた¶
実際に、簡単な設定をYAMLで書いて、読み込んでみましょう。
import yaml
text = """
app:
name: shop
debug: true
ports: [8000, 8001]
"""
config = yaml.safe_load(text)
print(config["app"]["ports"])
実行すると、[8000, 8001]と表示されました。safe_loadは、安全な種類のデータだけを読み込む関数で、ふだんはこれを使うのが基本です。
なお、yaml.loadを使う場合は、読み込み方を表すLoaderを必ず指定します。手元の6.0.4でyaml.load("a: 1")と書くと、missing 1 required positional argument: 'Loader'というTypeErrorになりました。
読み込んだ結果は、Pythonの辞書になります。辞書の基本は、こちらで紹介しています。【関連記事】Pythonの辞書とは?
JSONやTOMLとの違い¶
設定ファイルに使われる形式は、ほかにもあります。大まかに比べると、次のような違いがあります。
| 形式 | 特徴 | Pythonでの読み込み |
|---|---|---|
| JSON | 機械どうしのやり取りに強い。コメントは書けない | 標準ライブラリのjson |
| TOML | 設定ファイル向け。pyproject.tomlで使われる | 標準ライブラリのtomllib |
| YAML | 字下げで書けて、コメントも書ける。機能が多い | PyYAMLなどを追加で入れる |
TOMLの読み込み方は、こちらで紹介しています。【関連記事】Pythonのtomllibとは?
6.0.4で何が変わったのかを整理しよう¶
続いて、6.0.4の主な変更を表にまとめます。内容は、PyYAMLの公式リポジトリにある変更履歴CHANGESと、6.0.3から6.0.4までの変更内容にもとづいています。
| 分類 | 主な変更 |
|---|---|
| 不具合の修正 | マージキーの読み込みが遅くなりすぎる問題を修正 |
| 新機能 | C言語の部品libyamlの、入れ子の深さの上限を扱う仕組みを用意 |
| 対応範囲 | 必要なPythonが3.8以上から3.10以上に。Python 3.15に対応 |
変更履歴に並んでいるのは、上の2つの修正です。GitHubのコミットの名前では、マージキーの修正にDos in merge keyという題が付いていました。
DoSとは、大量の処理をさせるなどして、サービスを使えなくする攻撃のことです。
マージキーとは¶
まずは、今回の修正に関わるマージキーという書き方から見ていきましょう。YAMLでは、&で名前を付けた部分を、*で呼び出して使い回せます。
さらに、<<というマージキーを使うと、呼び出した辞書の中身を、別の辞書に混ぜ込めます。
共通の設定を使い回してみた¶
実際に、開発用と本番用で、共通の設定を使い回す例です。
import yaml
text = """
base: &base
timeout: 30
retry: 3
dev:
<<: *base
debug: true
prod:
<<: *base
timeout: 60
"""
print(yaml.safe_load(text)["prod"])
実行すると、{'timeout': 60, 'retry': 3}と表示されました。
prodでは、baseのtimeoutとretryを受け継ぎ、timeoutだけ60に上書きしています。同じ設定を何度も書かずに済むので、とても便利な書き方です。
何重にも重ねると、とても遅くなっていた¶
ところが、このマージキーを何重にも重ねると、6.0.3では読み込みがとても遅くなっていました。6.0.4で加わったテストを参考に、同じ形のYAMLを作って試してみます。
6.0.3と6.0.4で比べてみた¶
試したのは、10個の項目を持つ辞書を、10個ずつマージしながら、何段も重ねたYAMLです。段の数を増やしながら、safe_loadにかかった時間を測りました。
YAMLは、次の関数で作りました。n0という辞書を、a0からa9の10個がそれぞれ受け継ぎ、その10個をn1がまとめて混ぜ込む、という形をlevelsの段だけくり返します。
def make_yaml(levels, width=10):
lines = ["n0: &n0 {%s}" % ", ".join(f"k{i}: {i}" for i in range(width))]
prev = "n0"
for lv in range(1, levels + 1):
p = chr(ord("a") + lv - 1)
names = []
for i in range(width):
lines.append(f"{p}{i}: &{p}{i} {{<<: *{prev}}}")
names.append(f"*{p}{i}")
lines.append(f"n{lv}: &n{lv} {{<<: [{','.join(names)}]}}")
prev = f"n{lv}"
lines.append(f"root: {{<<: *{prev}}}")
return "\n".join(lines)
手元のPython 3.11で、6.0.3と6.0.4を、それぞれ新しい仮想環境に入れた結果です。
| 段の数 | YAMLの大きさ | 6.0.3 | 6.0.4 |
|---|---|---|---|
| 3 | 802バイト | 0.019秒 | 0.005秒 |
| 4 | 1038バイト | 0.152秒 | 0.005秒 |
| 5 | 1274バイト | 1.506秒 | 0.007秒 |
| 6 | 1510バイト | 14.96秒 | 0.01秒 |
6.0.3では、段が1つ増えるごとに、時間がおよそ10倍に増えていました。わずか1.5KBほどのYAMLで、15秒近くかかっています。
6.0.4では、どの大きさでも、0.01秒ほどで読み込めました。読み込んだ結果の辞書は、どちらの版でも10個の項目を持っていました。
何が問題だったのか¶
変更内容を見ると、6.0.3では、マージで混ぜ込む項目を、重複していても全部並べていました。重ねるたびに項目の数が掛け算で増えていき、時間がかかっていたわけです。
6.0.4では、一度混ぜ込んだ項目は、二度目からは飛ばすようになりました。外から受け取ったYAMLを読み込むアプリでは、小さなファイル1つでサーバーを長く止められてしまうおそれがあったので、大事な修正です。
時間の測り方は、こちらで紹介しています。【関連記事】Pythonのtimeitとは?
上書きの結果はそのまま、並び順に注意¶
一方で、修正の前後で、読み込んだ結果が変わらないかも確かめました。2つの辞書を、リストの形で混ぜ込むYAMLです。
text = """
a: &a {x: 1, y: 1}
b: &b {x: 2, z: 2}
c:
<<: [*a, *b]
y: 9
"""
print(yaml.safe_load(text)["c"])
6.0.3では{'x': 1, 'z': 2, 'y': 9}、6.0.4では{'x': 1, 'y': 9, 'z': 2}と表示されました。xは先に書いたaの1、yは自分で書いた9という、値の決まり方は同じです。
ただし、辞書の中の並び順が変わっていました。値で比べる処理なら問題ありませんが、読み込んだ順番に頼った処理がある場合は、念のため確かめておきましょう。
入れ子の深さに上限が付いた¶
2つ目の変更は、入れ子の深さです。PyYAMLは、libyamlというC言語で書かれた部品が使える場合、それを使って速く読み込めます。
変更履歴によると、6.0.4では、libyamlの入れ子の深さの上限を扱う仕組みが用意されました。ただし、上限の機能を持たない古いlibyamlでは、何もしないとも書かれています。
試してみた¶
実際に、[を1100個重ねた、とても深いリストを、libyamlを使うCSafeLoaderで読み込んでみました。
| 版 | 深さ500 | 深さ1100 |
|---|---|---|
| 6.0.3 | 読めた | 読めた |
| 6.0.4 | 読めた | ScannerErrorで止まった |
6.0.4では、深さ1100のほうで、入れ子の深さの上限を超えたというエラーになりました。手元の6.0.4では、yaml._yaml._get_max_nest_level()が1000を返していました。
なお、libyamlを使わないSafeLoaderでは、どちらの版でも、深さ500の時点でRecursionErrorになりました。再帰の上限については、こちらで紹介しています。【関連記事】Pythonの再帰とは?
上限を変える関数は慎重に¶
上限を変える_set_max_nest_levelも用意されています。名前が_で始まる、内部向けの扱いの関数です。
説明文によると、この設定は同じプロセスの中のすべての読み込みに効き、スレッドに対して安全ではないとのことです。ふだんは、既定の上限のまま使うのがよいでしょう。
Python 3.10以上が必要に¶
3つ目は、使う環境に関わる変更です。PyPIの記録によると、必要なPythonは、6.0.3の3.8以上から、6.0.4では3.10以上になりました。
あわせて、Python 3.15への対応も加わっています。3.8や3.9のままpip install pyyamlを実行すると、6.0.4ではなく、それより前の版が入ることになります。
上げる前にやっておきたいこと¶
最後に、PyYAMLを6.0.4へ上げる前に確かめておきたいことを整理します。
| 順番 | 確認すること |
|---|---|
| 1 | Python 3.10以上を使っているか |
| 2 | 外から受け取ったYAMLを読み込んでいるなら、早めに上げる |
| 3 | マージキーで読み込んだ辞書の並び順に、頼った処理がないか |
| 4 | 1000段を超える、とても深いYAMLを扱っていないか |
私は10年ほどエンジニアとして開発に関わってきましたが、利用者がアップロードした設定ファイルを読み込む機能で、想定外に重いファイルが送られてきて、処理が詰まったことがあります。外から受け取るデータは、小さくても油断できないと実感しました。
まとめ¶
2026年11月20日、PyYAML 6.0.4が、およそ1年2か月ぶりに公開されました。マージキーを何重にも重ねたYAMLで、読み込みがとても遅くなる問題が直り、libyamlの入れ子の深さにも上限が付いています。
必要なPythonは3.10以上になりました。YAMLを読み込むプログラムを動かしている方は、この機会に上げておくと安心です。
ここまでお読みいただきありがとうございました。