【PyYAML】Pythonでyamlを読み込む方法を解説

Python

本記事では、Pythonでyamlファイルを読み込む方法を詳しく解説します。PythonでYAMLデータを効率的に扱うには「PyYAML」というライブラリが最適です。このライブラリを使えば、複雑なYAMLデータも簡単に読み書きできます。この記事では、PyYAMLの基本的な使い方から応用まで解説していきます。

yamlファイルとは

YAMLは「YAML Ain’t Markup Language」の略で、人間が読みやすいデータシリアライゼーション形式です。設定ファイルやデータ交換などによく使用されます。YAMLはインデントを使って階層構造を表現し、JSONよりも読みやすい形式になっています。

以下はYAMLファイルの例です。

# config.yaml
name: sample-project
version: 1.0.0
description: サンプルプロジェクトの設定ファイル

database:
  host: localhost
  port: 5432
  user: admin
  password: secret

features:
  - logging
  - authentication
  - api

debug: true

PyYAMLライブラリとは

PyYAMLはPythonでYAMLファイルを扱うための標準的なライブラリです。このライブラリを使うことで、YAMLファイルの読み込み、解析、書き込みなどの操作を簡単かつ安全に行うことができます。

特に優れているのは、PyYAMLがPythonのネイティブデータ型（辞書、リスト、文字列など）とYAML形式の間の変換を自動的に処理してくれる点です。これにより、開発者は複雑な変換ロジックを実装する必要がなく、データ構造に集中できます。

主な機能と特徴

  • データ変換: YAML⇔Python間の双方向データ変換
  • 複数ドキュメント対応: 1つのファイル内の複数YAMLドキュメントの読み書き
  • セキュリティ対策: 安全な読み込みオプション（safe_load）
  • カスタマイズ: 出力形式の詳細なカスタマイズ機能
  • 国際化対応: Unicode対応で多言語処理が可能
  • 高いパフォーマンス: C言語実装によるオプションで高速処理も可能

インストール方法

PyYAMLは標準ライブラリではないため、使用前にインストールする必要があります。インストールは以下のように簡単に行えます

pip install pyyaml

読み込み

YAMLファイルを読み込むには、yaml.safe_load()関数を使用します。この関数は、YAMLファイルの内容をPythonのデータ構造（辞書、リスト、文字列など）に変換します。

以下のコードは、YAMLファイルを読み込む基本的な方法を示しています。

import yaml

# YAMLファイルを読み込む
with open('config.yaml', 'r', encoding='utf-8') as file:
    config = yaml.safe_load(file)

# 読み込んだデータを使用する
print(config['name'])
print(config['version'])
print(config['database']['host'])
print(config['features'][0])

# 出力:
# sample-project
# 1.0.0
# localhost
# logging

複数のYAMLドキュメントが含まれるファイルを読み込む場合は、yaml.safe_load_all()関数を使用します。

import yaml

# 複数のYAMLドキュメントを含むファイルを読み込む
with open('multiple_docs.yaml', 'r', encoding='utf-8') as file:
    documents = list(yaml.safe_load_all(file))

# 各ドキュメントを処理する
for i, doc in enumerate(documents):
    print(f"ドキュメント {i+1}:")
    print(doc)

# 出力:
# ドキュメント 1:
# {'name': 'doc1', 'value': 100}
# ドキュメント 2:
# {'name': 'doc2', 'value': 200}

書き込み

YAMLファイルを書き込むには、yaml.safe_dump()関数を使用します。この関数は、Pythonのデータ構造をYAML形式の文字列に変換します。

以下のコードは、Pythonの辞書をYAMLファイルに書き込む方法を示しています。

import yaml

# 書き込むデータ
data = {
    'name': 'new-project',
    'version': '2.0.0',
    'database': {
        'host': 'db.example.com',
        'port': 3306,
        'user': 'user1',
        'password': 'pass123'
    },
    'features': ['logging', 'security', 'api'],
    'debug': False
}

# YAMLファイルに書き込む
with open('new_config.yaml', 'w', encoding='utf-8') as file:
    yaml.safe_dump(data, file, default_flow_style=False, allow_unicode=True)

# 出力: new_config.yamlファイルが作成される

作成されるYAMLファイルの内容は以下のようになります。

database:
  host: db.example.com
  password: pass123
  port: 3306
  user: user1
debug: false
features:
- logging
- security
- api
name: new-project
version: 2.0.0

重要な注意点と実践的なアドバイス

PyYAMLを効果的かつ安全に使用するためには、以下の点に注意することが重要です。これらの実践的なアドバイスは、多くの開発者が実際に遭遇する問題を回避するのに役立ちます。

セキュリティ: 安全な関数を使用する

読み込み時はyaml.load()ではなくyaml.safe_load()を使用しましょう。yaml.load()関数は任意のPythonオブジェクトを構築できるため、悪意のあるYAMLファイルを読み込むとセキュリティリスクになります。

import yaml

# 安全でない方法（使用しないでください）
# dangerous_data = yaml.load(file)

# 安全な方法
safe_data = yaml.safe_load(file)

# 出力: 安全にデータが読み込まれる

同様に、書き込み時もyaml.dump()ではなくyaml.safe_dump()を使用しましょう。yaml.dump()は任意のPythonオブジェクトをシリアライズできるため、潜在的なセキュリティリスクがあります。

import yaml

data = {'key': 'value'}

# 安全でない方法（使用しないでください）
# with open('file.yaml', 'w') as file:
#     yaml.dump(data, file)

# 安全な方法
with open('file.yaml', 'w') as file:
    yaml.safe_dump(data, file)

# 出力: 安全にデータが書き込まれる

日本語などの文字化け対策

YAMLファイルに日本語などの非ASCII文字が含まれる場合、適切なエンコーディングを指定しないと文字化けが発生します。Pythonでは、ファイルを開く際にencodingパラメータを指定することで、この問題を解決できます。

一般的に、YAMLファイルではutf-8エンコーディングを使用することが推奨されています。これにより、ほとんどの言語の文字を正しく処理できます。

# エンコーディングを指定してファイルを開く
with open('config.yaml', 'r', encoding='utf-8') as file:
    config = yaml.safe_load(file)

# 書き込み時も同様にエンコーディングを指定する
with open('output.yaml', 'w', encoding='utf-8') as file:
    yaml.safe_dump(data, file, allow_unicode=True)

# 出力: 日本語が正しく表示される

エンコーディングに関する主な注意点:

  • 読み込み時と書き込み時の両方でエンコーディングを指定する
  • allow_unicode=Trueを指定して、Unicode文字が正しくエスケープされずにそのまま出力されるようにする

フォーマット制御

PyYAMLでは、YAMLファイルの出力形式を細かく制御できます。これにより、人間が読みやすい形式や特定の要件に合わせたフォーマットでファイルを生成できます。

import yaml

data = {'a': 1, 'b': [2, 3, 4], 'c': {'d': 5, 'e': 6}}

# デフォルトのフォーマット
with open('default.yaml', 'w', encoding='utf-8') as file:
    yaml.safe_dump(data, file)

# カスタマイズしたフォーマット
with open('custom.yaml', 'w', encoding='utf-8') as file:
    yaml.safe_dump(data, file, 
                  default_flow_style=False,  # ネストされた要素をブロックスタイルで表示
                  sort_keys=False,           # キーをソートしない
                  indent=4,                  # インデントを4スペースに設定
                  allow_unicode=True)        # Unicode文字を許可

# 出力: 2つの異なるフォーマットのYAMLファイルが作成される

主なフォーマット制御オプションは以下になります。

  • default_flow_style:
    • False: ネストされた要素をブロックスタイル（複数行）で表示
    • True: フロースタイル（JSON風の一行表示）で表示
    • None: 自動判断（デフォルト）
  • indent: インデントのスペース数を指定（デフォルトは2）
  • width: 折り返し文字数を指定（デフォルトは80）
  • sort_keys:
    • True: キーをアルファベット順にソート（デフォルト）
    • False: 元の順序を維持
  • canonical:
    • True: 正規形式で出力（すべてのタグを明示的に表示）
    • False: 簡略形式で出力（デフォルト）
  • explicit_start: ドキュメント開始マーカー（---）を出力するかどうか
  • explicit_end: ドキュメント終了マーカー（...）を出力するかどうか

デフォルト設定とカスタム設定の出力例:

デフォルト設定（default.yaml）

a: 1
b:
- 2
- 3
- 4
c:
  d: 5
  e: 6

カスタム設定（custom.yaml）

a: 1
b:
- 2
- 3
- 4
c:
    d: 5
    e: 6

ここで注目すべき違いは以下の点です：

  1. リスト表現：両方のファイルでリストbの要素は同じ形式（- 2のように表示）ですが、これはPyYAMLのデフォルト動作です。
  2. ネストされたマップのインデント：cの下の要素（dとe）のインデントが異なります。
    • default.yamlでは2スペース（デフォルト設定）
    • custom.yamlでは4スペース（indent=4で指定）

このように、indentパラメータを変更することで、ネストされた要素のインデントを制御できますが、リストの表示形式には影響しません。

まとめ

本記事では、Pythonでyamlファイルを効率的に読み書きする方法について詳しく解説しました。要点をまとめると：

  1. PyYAMLの基本：yaml.safe_load()とyaml.safe_dump()を使用して、安全にYAMLファイルの読み書きができる
  2. セキュリティ対策：常にsafe_プレフィックスのついた関数を使用し、安全性を確保する
  3. 多言語対応：適切なエンコーディング設定で、日本語などの多言語コンテンツも正しく処理できる
  4. 出力カスタマイズ：さまざまなパラメータを調整して、目的に合った形式のYAMLファイルを生成できる

YAMLは人間にとって読みやすく、プログラムにとっても扱いやすいため、設定ファイルやデータ交換形式として最適です。Pythonと組み合わせることで、複雑なデータ構造も簡潔に表現でき、開発効率が向上します。

PyYAMLの詳細については公式ドキュメントも参照してみてください。

タイトルとURLをコピーしました