PyYaml

Python「PyYaml」の使い方 †

Python「PyYaml」の使い方
- PyYaml モジュール
- 更新履歴
参考資料

※ 最終更新:2022/01/11　

↑

PyYaml モジュール †

　「pyyaml」はPython で簡単に YAML データを扱うことができライブラリ。

↑

Yaml の書式 †

階層構造
インデントを使って階層構造を表現する、タブスペースではなくスペースを使う。
```
profile:
  nickname: ニックネーム
```

コメントの表記
コメントは、# を使う。
```
# コメントを書く
```

連想配列
同一階層で、複数のキーと値を設定する方法 (Pythonの辞書型)
```
name: 太郎
age: 20
```

リスト
先頭行に 'ー' をつける。
```
member:
 - 太郎
 - 次郎
 - 三郎
```

↑

事前準備 †

PyYaml がインストールされていなければ次のコマンドを実行する。
```
$ pip install pyyaml
```

↑

YAML ファイルを読み込んで Python オブジェクトに変換 †

読み込むサンプルファイル「input.yaml」
```
x: XXX
y: 100
z: [200, 300, 400]
```

サンプルプログラム「yaml_sampl.py」

import yaml

with open('input.yaml') as file:
    obj = yaml.safe_load(file)
    print(obj['z'])

実行結果

(py37) $ python3 yaml_sample.py 
[200, 300, 400]

↑

読み込み失敗時のエラー処理を追加 †

サンプルプログラム「yaml_sampl1.py」

#!/usr/bin/env python3

import yaml
import sys

try:
    with open('sample.yaml') as file:
        obj = yaml.safe_load(file)
        print(obj)
except Exception as e:
    print('Exception occurred while loading YAML...', file=sys.stderr)
    print(e, file=sys.stderr)
    sys.exit(1)

実行結果 (エラーの例)

(py37) $ python3 yaml_sample1.py 
Exception occurred while loading YAML...
[Errno 2] No such file or directory: 'sample.yaml'

↑

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

サンプルプログラム「yaml_sampl2.py」

import yaml

obj = { 'x': 'XXX', 'y': 100, 'z': [200, 300, 400] }
print(yaml.dump(obj))

実行結果

(py37) $ python3 yaml_sample2.py 
x: XXX
y: 100
z:
- 200
- 300
- 400

↑

Python オブジェクトを YAML ファイルに出力 †

サンプルプログラム「yaml_sampl3.py」

import codecs
import yaml

obj = { 'x': 'あいうえお', 'y': [1, 2, 3] }
with codecs.open('output.yaml', 'w', 'utf-8') as f:
    yaml.dump(obj, f, encoding='utf-8', allow_unicode=True)

Python オブジェクト内に日本語の文字列データを含む場合、 UTF-8 エンコーディング形式のテキストファイルに出力することができる。
「output.yaml」
```
x: あいうえお
y:
- 1
- 2
- 3
```

↑

更新履歴 †

2022/01/10 初版

↑

参考資料 †

使い方

構文

最新の20件

Python「PyYaml」の使い方 †

PyYaml モジュール †

Yaml の書式 †

事前準備 †

YAML ファイルを読み込んで Python オブジェクトに変換 †

読み込み失敗時のエラー処理を追加 †

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

Python オブジェクトを YAML ファイルに出力 †

更新履歴 †

参考資料 †