【簡単】PythonでYAMLファイルを扱う方法｜具体例付き

2023.07.21

※本サイトにはプロモーション・広告が含まれています。

（最終更新日：2023年7月）

✔このような方へ向けて書かれた記事です

「PythonとYAMLの相互運用における手順について理解したい」
「Pythonを用いてYAMLファイルの操作を学びたい」
「PythonとYAMLの実際の使用例を確認したい」

✔当記事を通じて伝える内容

  • PythonとYAMLの基本的な連携方法
  • PythonでYAMLファイルを操作するための手法や応用例
  • PythonとYAMLを使った具体的な状況例

当記事では、PythonとYAMLの基本的な連携から始め、Pythonを用いたYAMLファイルの逐次操作まで、明瞭な実例に基づいて細部まで解説します。

どうぞ最後までお付き合いください。

筆者プロフィール

筆者プロフィールアイコン

【現職】プロダクトマネージャー

【副業】ブログ（月間20万PV）/YouTube/Web・アプリ制作

「プログラミング × ライティング × 営業」の経験を活かし、30後半からのIT系職へシフト。現在はプロダクトマネージャーとして、さまざまな関係者の間に入り奮闘してます。当サイトでは、実際に手を動かせるWebアプリの開発を通じて、プログラミングはもちろん、IT職に必要な情報を提供していきます。

【当ブログで紹介しているサイト】

当サイトチュートリアルで作成したデモ版日報アプリ

Django × Reactで開発したツール系Webアプリ

✔人に見せても恥ずかしくないコードを書こう

「リーダブルコード」は、わかりやすく良いコードの定義を教えてくれる本です。

  • 見るからにきれいなコードの書き方
  • コードの分割方法
  • 変数や関数の命名規則

エンジニアのスタンダートとすべき基準を一から解説しています。

何回も読むのに値する本なので、ぜひ手にとって読んでみてください。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック
created by Rinker

YAMLとPythonの連携の重要性

こちらでは、YAMLとPythonの連携についてお伝えしていきます。

YAMLとPythonを連携させることのメリットを正しく理解しましょう。

  • YAMLの概要とその利用価値
  • YAMLとPythonの相性の良さ

YAMLの概要とその利用価値

YAMLは、データ構造を人間が読みやすい形式で表現するための言語です。

設定ファイルやデータ交換のフォーマットとして広く使用されています。

YAMLはJSONと似ていますが、より読みやすく、コメントを入れることができるため、設定ファイルの記述に適しています。

YAMLとPythonの相性の良さ

YAMLはPythonと非常に相性が良いです。

Pythonは可読性が高く、YAMLは人間が読みやすい形式であるため、両者は自然とマッチします。

PythonのライブラリであるPyYAMLを使用することで、YAMLファイルを簡単に読み込んでPythonオブジェクトとして操作できます。

YAMLの基本的な記法

こちらでは、YAMLの基本的な記法について解説します。

YAMLの記法を理解することで、データの表現が容易になります。

  • YAMLでよく使われる書式と構造
  • YAMLでのデータ表現の例

YAMLでよく使われる書式と構造

YAMLでは、データの構造をインデントとコロンを使用して表現します。

リストはハイフンを使用して表し、連想配列(辞書)はキーと値をコロンで区切ります。

また、文字列は通常クォート無しで記述可能です。

コメントは「#」記号から始まります。

name: John Doe
age: 30
languages:
  - English
  - Spanish
# This is a comment

YAMLでのデータ表現の例

YAMLは、さまざまなデータ型をサポートしています。

数値、文字列、真偽値、配列、ネストされたオブジェクトなどを表現可能です。

employees:
  - name: John Doe
    age: 28
    department: Engineering
  - name: Jane Smith
    age: 30
    department: Marketing

employeesというキーに対して、複数の従業員のデータをリストとして格納。

各従業員はname、age、およびdepartmentという属性を持っています。

PythonとYAMLの連携の準備

PythonでYAMLを扱う準備について説明します。

  • PyYAMLのインストール方法
  • PyYAMLを使った基本的なコーディング

PyYAMLのインストール方法

PythonでYAMLを扱うには、PyYAMLというライブラリを使用します。

PyYAMLはpipを使って簡単にインストールすることができます。

pip install pyyaml

このコマンドを実行することで、Pythonの環境にPyYAMLがインストールされます。

PyYAMLを使った基本的なコーディング

PyYAMLを使うと、Pythonプログラム内で簡単にYAMLファイルを読み込めます。

以下は、PyYAMLを使ってYAMLファイルを読み込む基本的なコード例です。

import yaml

with open('example.yml', 'r') as file:
    data = yaml.safe_load(file)

print(data)

# 出力
# {'employees': [{'name': 'John Doe', 'age': 28, 'department': 'Engineering'}, {'name': 'Jane Smith', 'age': 30, 'department': 'Marketing'}]}

このコードはexample.yamlというYAMLファイルを読み込み、その内容をPythonオブジェクトとしてdata変数に格納しています。

Pythonを使ってYAMLを解析する

こちらでは、Pythonを使用してYAMLを解析する方法について解説します。

  • PythonでYAMLファイルの読み込みと解析
  • サンプルコードとその実行結果
  • YAML解析時の例外処理

PythonでYAMLファイルの読み込みと解析

Pythonを使用してYAMLファイルを読み込み、解析するには、PyYAMLライブラリのloadまたはsafe_load関数を使用します。

通常、safe_loadを使用することが推奨されます。

これは、load関数が任意のPythonオブジェクトを作成する可能性があり、セキュリティ上のリスクがあるためです。

import yaml

with open('data.yaml', 'r') as file:
    data = yaml.safe_load(file)

print(data)

上記のコードは、data.yamlというYAMLファイルを読み込み、その内容をPythonの辞書として出力します。

サンプルコードとその実行結果

ここでは具体的なYAMLファイルを読み込むPythonのサンプルコードと、その実行結果を示します。

data.yaml

name: Alice
age: 25
languages:
  - English
  - French

Python script

import yaml

with open('data.yaml', 'r') as file:
    data = yaml.safe_load(file)

print(data)

実行結果

{'name': 'Alice', 'age': 25, 'languages': ['English', 'French']}

YAML解析時の例外処理

YAMLファイルの解析時にエラーが発生する可能性があります。

例えば、YAMLファイルの構文に誤りがある場合などです。

このようなエラーを適切に処理するために、try exceptブロックを使用しましょう。

import yaml

try:
    with open('data.yaml', 'r') as file:
        data = yaml.safe_load(file)
    print(data)
except yaml.YAMLError as error:
    print(f"Error parsing YAML file: {error}")

YAMLの解析時にエラーが発生した場合、エラーメッセージを出力します。

【保存版】Pythonのtry-except文をマスター｜実例付
Pythonのtry-exceptについて知りたいですか？当記事では、Pythonのtry-exceptの基本的な使い方や実践的な例を詳細に解説しています。さまざまなケースに合わせたコードを載せているので、初心者の方でもすぐに使いこなせるはず。初心者の方は必見です。
itc.tokyo
2023.06.27

PythonでYAMLにデータを変換する

こちらでは、PythonオブジェクトをYAML形式の文字列に変換する方法を学びます。

  • PythonオブジェクトをYAML文字列に変換
  • サンプルコードとその実行結果

PythonオブジェクトをYAML文字列に変換

PythonオブジェクトをYAML形式の文字列に変換するには、PyYAMLのdump関数を使用します。

Pythonの辞書やリストなどをYAML形式で表現可能です。

import yaml

data = {
    'name': 'John Smith',
    'age': 30,
    'hobbies': ['reading', 'cooking', 'hiking'],
    'address': {
        'street': '123 Main Street',
        'city': 'Anytown',
        'country': 'USA'
    }
}

# PythonオブジェクトをYAML形式の文字列に変換する
yaml_string = yaml.dump(data)

print(yaml_string)

こちらの例で作成されたYamlファイルはこちら。

address:
  city: Anytown
  country: USA
  street: '123 Main Street'
age: 30
hobbies:
- reading
- cooking
- hiking
name: John Smith

PythonオブジェクトをYAML文字列に変換

PythonオブジェクトをYAML形式の文字列に変換するには、PyYAMLのdump関数を使用します。

Pythonの辞書やリストなどをYAML形式で表現可能です。

import yaml

data = {
    'name': 'Bob',
    'age': 28,
    'languages': ['English', 'Spanish']
}

yaml_string = yaml.dump(data)
print(yaml_string)

Pythonの辞書をYAML形式の文字列に変換しています。

サンプルコードとその実行結果

次に、もう少し複雑なPythonオブジェクトをYAML形式の文字列に変換するサンプルコードを示します。

Python script

import yaml

data = {
    'employees': [
        {'name': 'Alice', 'age': 30, 'department': 'Engineering'},
        {'name': 'Bob', 'age': 28, 'department': 'Marketing'}
    ]
}

yaml_string = yaml.dump(data)
print(yaml_string)

実行結果

employees:
- age: 30
  department: Engineering
  name: Alice
- age: 28
  department: Marketing
  name: Bob

PythonでYAMLファイルに出力する

こちらでは、PythonオブジェクトをYAMLファイルに出力する方法を学びます。

  • PythonオブジェクトからYAMLファイルへの出力方法
  • サンプルコードとその実行結果

PythonオブジェクトからYAMLファイルへの出力方法

PythonオブジェクトをYAMLファイルに出力するには、dump関数を使用し、ファイルオブジェクトを指定します。

import yaml

data = {
    'name': 'John',
    'age': 30,
    'languages': ['English', 'Spanish']
}

with open('output.yaml', 'w') as file:
    yaml.dump(data, file)

サンプルコードとその実行結果

上記のコードは、Pythonの辞書をoutput.yamlという名前のYAMLファイルに出力します。

出力されるファイルの内容は次のとおりです。

age: 30
languages: [English, Spanish]
name: John

PyYamlのメソッド一覧

以下は、PyYAMLライブラリで使用できる主要なメソッドとその説明、および例です。

メソッド名説明例
load(stream)YAML形式のストリームをPythonオブジェクトにロードします。data = yaml.load(stream)
safe_load(stream)安全な方法でYAML形式のストリームをPythonオブジェクトにロードします。data = yaml.safe_load(stream)
dump(data, stream=None)PythonオブジェクトをYAML形式のストリームにダンプします。yaml.dump(data, stream)
safe_dump(data, stream=None)安全な方法でPythonオブジェクトをYAML形式のストリームにダンプします。yaml.safe_dump(data, stream)
dump_all(documents, stream=None)複数のPythonオブジェクトをYAML形式のストリームにダンプします。yaml.dump_all(documents, stream)
safe_dump_all(documents, stream=None)安全な方法で複数のPythonオブジェクトをYAML形式のストリームにダンプします。yaml.safe_dump_all(documents, stream)

上記の一覧はPyYAMLライブラリで一般的に使用されるメソッドです。

使用方法については、各メソッドの引数としてストリームやデータを指定し、適切なオブジェクトを取得または生成することが一般的です。

まとめ

当記事では、PythonとYAMLの連携について学びました。

  • YAMLの概要
  • Pythonとどのように連携するのか
  • YAMLの基本的な記法
  • PyYAMLライブラリを使用したYAMLファイルを読み込む方法
  • PythonオブジェクトのYAMLファイルに出力する方法

これらの知識は、設定ファイルの管理、データのシリアル化、デシリアル化、そして複雑なデータ構造の表現に役立ちます。

YAMLとPythonを組み合わせることで、効率的かつ柔軟なデータハンドリングが可能になります。

プロジェクトでこれらの技術を活用し、効率的なデータ管理と処理を実現しましょう。

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