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

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

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

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

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

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)

まとめ

この記事ではPythonでYAMLを使う方法について解説をしました。

YAMLについての簡単な記法も分かって頂けたでしょうか? これからはXMLよりもYAMLが使用される場面が多く出てくるでしょう。

もしPythonでYAMLを扱う方法について忘れた場合は、ぜひまたこの記事をご覧ください!

LINEで送る
Pocket

無料でSEからWebエンジニアへ転職しませんか?



侍エンジニア塾では、完全未経験の方から現在SEだけどプログラミングはやっていないという経験者まで、幅広い方々の人生を好転させるプログラミング指導を行ってきました。SEの方とお話していくなかで、

  • システムエンジニアという職業だけどコードが書けない
  • 事務作業が多くスキルがないため将来が不安
  • スクールに通うと完全未経験者と同じスタートになるからレベルが合わない
という、すでに知識があるSEならではのお悩みがあることに気づきました。そんな方におすすめなのが、弊社の「転職コース 」です。

弊社では、マンツーマンでレッスンを行いますので、現在お持ちの知識レベルからカリキュラムを作成いたします。さらにこちらの転職コースは無料で受講を始められて転職成功でそのまま卒業できるというとてもお得なコースとなっています。

既に知識のあるSEといっても転職は年齢が若いほど受かりやすいため、まずは無料体験レッスンで今の現状や理想の働き方について一緒に考えていきましょう。

まずは無料体験レッスンを予約する

書いた人

ryo

おすすめコンテンツ

あなたにぴったりなプログラミング学習プランを無料で診断!

プログラミング学習の効率を劇的に上げる学習メソッドを解説