Pythonでyamlファイルの読み込みをする方法
PythonでYAMLファイルを使用するには、外部ライブラリの「PyYAML」を導入する必要があります。PyYAMLのインストールは、コマンドラインでpip install pyyamlを実行するだけです。このライブラリを利用すると、YAML形式のデータをPythonの辞書やリストといったデータ構造に変換できるため、設定ファイルの管理やデータの保存に活用しやすいです。
【サンプルコード】
import yaml
# サンプルYAMLファイルのパス
file_path = 'config.yaml'
# YAMLファイルを読み込む
with open(file_path, 'r', encoding='utf-8') as file:
data = yaml.safe_load(file)
# 読み込んだデータを表示
print(data)
print(f"名前: {data['name']}")
print(f"年齢: {data['age']}")
print(f"趣味: {', '.join(data['hobbies'])}")
【実行結果】
{'name': '山田太郎', 'age': 30, 'hobbies': ['読書', '旅行', 'プログラミング'], 'address': {'city': '東京', 'zip': '123-4567'}}
名前: 山田太郎
年齢: 30
趣味: 読書, 旅行, プログラミング
上記のサンプルコードでは、yaml.safe_load()メソッドを用いてYAMLファイルを読み込み、その結果を辞書型として取得しています。辞書型に変換されたデータはPythonの通常の記法でアクセスでき、ネストされた構造(住所情報など)やリスト(趣味の一覧)もそのまま利用することが可能です。安全性を考慮してyaml.safe_load()を使うことが推奨されており、yaml.load()では悪意あるコードが実行される恐れがあるため注意が必要です。
| 行番号 | 詳細説明 |
|---|---|
| 1行目 | yamlモジュールをインポート |
| 3行目 | 変数file_pathにYAMLファイルのパスとして'config.yaml'を指定 |
| 6行目 | open関数でファイルを読み込みモードrとエンコーディングutf-8を指定して開く |
| 7行目 | yaml.safe_load(file)でYAMLファイルを安全に読み込み、data変数に格納 |
| 10行目 | 辞書型として読み込まれたdata全体をprint関数で出力 |
| 11行目 | dataの'name'キーを取得して、名前を出力 |
| 12行目 | dataの'age'キーを取得して、年齢を出力 |
| 13行目 | dataの'hobbies'キーが指すリストを', 'で連結し、趣味を出力 |
YAMLファイルから取り出した値は辞書型のキーを利用して柔軟にアクセスできるため、構造化データを扱う際に非常に便利です。特に大規模な設定ファイルや複雑な階層構造を扱う場合、YAMLは可読性が高く保守運用が容易になります。
複数のYAMLファイルを一度に読み込む方法
YAMLファイルは「---」という区切りを使い、複数ドキュメントを一つのファイルにまとめることができます。複数ドキュメントを含むファイルを読み込む場合はyaml.safe_load_all()メソッドを使用するのが一般的で、返されるジェネレータからリストへ変換することで各ドキュメントにアクセス可能です。
【サンプルコード】
import yaml
# 複数ドキュメントを含むYAMLファイルのパス
file_path = 'multiple_docs.yaml'
# 複数のYAMLドキュメントを読み込む
with open(file_path, 'r', encoding='utf-8') as file:
# ジェネレータからリストに変換
documents = list(yaml.safe_load_all(file))
# 各ドキュメントを処理
for i, doc in enumerate(documents):
print(f"ドキュメント {i+1}:")
print(f" タイトル: {doc['title']}")
print(f" バージョン: {doc['version']}")
if 'items' in doc:
print(f" アイテム数: {len(doc['items'])}")
【実行結果】
ドキュメント 1:
タイトル: 設定ファイル
バージョン: 1.0
アイテム数: 3
ドキュメント 2:
タイトル: ユーザー情報
バージョン: 2.1
yaml.safe_load_all()は複数のドキュメントをまとめて読み込み、イテレーション(繰り返し処理)ができる形式で返却します。異なる種類の設定情報やデータを一元管理したい場合に、複数ドキュメントの利用は非常に便利です。条件分岐などでドキュメントごとの構造の違いにも対応できるため、柔軟に運用できます。
| 行番号 | 詳細説明 |
|---|---|
| 1行目 | yamlモジュールをインポート |
| 3行目 | 変数file_pathに複数ドキュメントを含むYAMLファイルのパスを設定 |
| 6行目 | open関数でファイルを読み込みモードrとエンコーディングutf-8を指定して開く |
| 8行目 | yaml.safe_load_all(file)で複数ドキュメントを読み込み、list関数でリスト化してdocumentsへ格納 |
| 11行目 | forループでdocumentsを反復処理し、ドキュメントの番号をi+1で取得 |
| 12行目 | doc変数の'title'キーを取得し、タイトルを出力 |
| 13行目 | doc変数の'version'キーを取得し、バージョンを出力 |
| 14行目 | 'items'キーの有無を判定し、存在すればアイテム数を出力 |
複数ドキュメントを1つのファイルにまとめることで、環境ごとの設定ファイルを分けたり、データの種類によってドキュメントを切り替えたりする際の管理が容易になります。
※上記コンテンツの内容やソースコードはAIで確認・デバッグしておりますが、間違いやエラー、脆弱性などがある場合は、コメントよりご報告いただけますと幸いです。
ITやプログラミングに関するコラム
Gitでブランチ(branch)を作成する方法
crontabの書き方
PDFをExcelに変換する方法
Excelでプルダウンを設定する方法
エクセルでページ区切りを設定する方法
Markdownの取り消し線の書き方
ラズベリーパイでできること9選
Gitでbranch(ブランチ)を削除する方法をローカル・リモート別に解説
git addの取り消し方法を状況別に解説
CSSのstickyプロパティでWebサイトに固定要素を実装する方法
ITやプログラミングに関するニュース
アイアール技術者教育研究所がエクセルギー解析計算ウェビナーを開催、省エネと環境負荷低減に貢献
フラー株式会社がアプリ市場トレンド解説ウェビナーを3月25日に開催、成長アプリの共通項とデータ活用を解説
株式会社BOTANICOが2026年版X運用最新戦略ウェビナーを開催、成果につなげる資産型運用を解説
AIストーム株式会社がOpenClaw活用セミナーを開催、AIエージェントがビジネス現場を変革
株式会社オロが建設コンサルティング業向けウェビナーを開催、技術部門の損益可視化を支援
アルティウスリンク株式会社が経理向けBPO活用ウェビナーを開催、課題解決と業務効率化を支援
株式会社日本計画研究所がAI時代のインフラセミナー開催、GPUとデータセンターの課題を解説
株式会社カウンターワークスがリーシング業務AI活用ウェビナー開催、既存ツールでAIエージェント実践
株式会社セキドがDJI産業機セミナーを福井で開催、3Dデータ活用と機材選定を無料解説
株式会社ナビットが補助金活用ウェビナーを開催、販促費削減と集客力向上を解説
