PythonでYAMLファイルのインデントを調整する方法

PythonでYAMLファイルを扱う際に、インデントを調整する方法について説明します。この記事では、PyYAMLとyaml-indentという2つのライブラリを使用します。

PyYAMLを使用した方法

まずは、PyYAMLを使用した方法について見ていきましょう。

import yaml
import re

def represent_str(dumper, instance):
    if "\\n" in instance:
        instance = re.sub(' +\\n| +$', '\\n', instance)
        return dumper.represent_scalar('tag:yaml.org,2002:str', instance, style='|')
    else:
        return dumper.represent_scalar('tag:yaml.org,2002:str', instance)

def main():
    test_dict = {
        'aa': 'bbbb\\ncccc\\ndddd',
        'bb': 'eeee'
    }
    yaml.add_representer(str, represent_str)
    print(yaml.dump(test_dict, allow_unicode=True, encoding='utf-8', default_flow_style=False).decode())

if __name__ == '__main__':
    main()

このコードは、YAMLファイルに書き込む文字列に改行が含まれている場合、適切に改行を行うためのものです。具体的には、represent_str関数で文字列を処理し、改行を含む文字列をブロックスタイル(|)で出力します。

yaml-indentを使用した方法

次に、yaml-indentというライブラリを使用した方法について見ていきましょう。

pip install yaml-indent

上記のコマンドでyaml-indentをインストールします。そして、以下のようにコマンドラインから使用します。

yaml-indent <input_file> [ -o <output_file>] [ -i]

ここで、<input_file>はインデントを調整したいYAMLファイルのパス、-o <output_file>はインデントを調整した結果を書き込むファイルのパス（オプション）、-iは入力ファイルを直接編集する場合に指定します（オプション）。

以上、PythonでYAMLファイルのインデントを調整する方法について説明しました。PyYAMLとyaml-indentの2つのライブラリを使って、YAMLファイルの読み書きをより柔軟に行うことができます。