【Python入門】PyYAMLでYAMLを扱う方法を解説！

2024年4月10日

侍テック編集部

こんにちは！　Pythonの学習、はかどってますか？

さっそくですが、今回の記事では「PythonでYAMLを使いたい」「PythonでYAMLを編集したい」と思っている方に向けて、

【基礎】YAMLとは
【基礎】YAMLの基本的な記法
【実践】PyYAMLのインストール
【実践】YAMLの読み書き

などの基本的な部分について解説をしていきます。一緒にPythonでYAMLを扱う方法について学んでいきましょう！

本記事を読む前に、Pythonがどんなプログラミング言語なのかをおさらいしておきたい人は次の記事を参考にしてください。

→ Pythonとは？特徴やできること、活用例をわかりやすく簡単に解説

なお、その他のPythonの記事についてはこちらにまとめています。

YAMLとは

まずはYAMLとは何かについて知っておきましょう。

YAMLはXMLなどに似たデータのフォーマットで、設定ファイルやデータの保存などで使われます。XMLよりも読みやすく書きやすいことが特徴で、YAMLを設定ファイルとして使うプログラムも増えてきています。

XMLであればHTMLのようにタグを使ってデータを構造化していきますが、YAMLではPythonのようにインデントを使ってデータを構造化していきます。

YAMLの基本的な記法

次はYAMLの基本的な記法について学びましょう。YAMLはスカラー、シーケンス、ハッシュを使ってデータを表します。

スカラーは文字列、数値、真偽値などのことです。シーケンスとハッシュはそれぞれ、Pythonで言うところの配列と辞書のようなものだと思ってもらって構いません。

では練習のためにtest.yamlというファイルを作成して、以下のコードを書き込んでください。

[test.yaml]

member:
- name:Taro Yamada
    address:Hokkaido
- name:Ichiro Tanaka
    address:Tokyo
- name:Jiro Sato
    address:Okinawa

これがYAMLで構造化されたデータになります。「:」はハッシュを、「-」はシーケンスを表しています。

また「address」の前の半角スペース2つはハッシュのネストになっています。同じようにシーケンスをネストする場合は「-」を2つ続けて書きましょう。

見てわかるようにとても読みやすく分かりやすいのがYAMLの特徴です。

PyYAMLのインストール

それでは早速PythonでYAMLを操作しましょう。PythonでYAMLを扱うためにはPyYAMLというパッケージが必要になります。pipでインストールしましょう。

pip install pyyaml

これで準備は出来ました。

YAMLの読み書き

それではYAMLの読み書きをしてみましょう。

YAMLの読み込み

まずは先程のtest.yamlをを読み込んでみます。

こちらのコードをご覧ください。

import yaml

with open('test.yaml') as file:
    yml = yaml.load(file)
    print(yml)

実行結果

{'member': ['name:Taro Yamada address:Hokkaido', 'name:Ichiro Tanaka address:Tokyo', 'name:Jiro Sato address:Okinawa']}

yaml.load関数を使ってYAMLファイルを読み込むことが出来ます。

Pythonに読み込んだときは辞書型として読み込まれましたね。このように読み込むことができればPythonでYAMLを加工することも出来ます。

YAMLの書き込み

次はYAMLに書き込んでみましょう。

こちらのコードをご覧ください。

import yaml
 
yml = {'member': ['name:Taro Yamada address:Hokkaido', 
                  'name:Ichiro Tanaka address:Tokyo', 
                  'name:Jiro Sato address:Okinawa']}
with open('test_out.yaml', 'w') as file:
    yaml.dump(yml, file)

先程出力された辞書型のオブジェクトを、test_out.yamlに書き込んで保存しています。

yaml.dump関数を使えばYAMLファイルに辞書型を書き込むことが出来ます。ただし、出力されたtest_out.yamlを見てみると、test.yamlとは形式が違うことに気づくかと思います。

member: ['name:Taro Yamada address:Hokkaido', 'name:Ichiro Tanaka address:Tokyo',
  'name:Jiro Sato address:Okinawa']

これはYAMLのフロースタイルとブロックスタイルの違いで、一番最初に示したYAMLはブロックスタイルと呼ばれるものになります。

ブロックスタイルで出力をしたければ、yaml.dump関数に「default_flow_style=False」を付け加えましょう。

import yaml
 
yml = {'member': ['name:Taro Yamada address:Hokkaido', 
                  'name:Ichiro Tanaka address:Tokyo', 
                  'name:Jiro Sato address:Okinawa']}
with open('test_out.yaml', 'w') as file:
    yaml.dump(yml, file, default_flow_style=False)