Pythonのpprintモジュールでデータを読みやすく整形する方法

Pythonには、printメソッドの出力を美しく整形するための「プリティプリント（pretty print）」、通称pprintと呼ばれる便利な機能が用意されています。

例えば、WebページからJSON形式のコンテンツを取得してそのまま出力すると、すべてが1行に詰め込まれて表示され、内容を把握するのが非常に困難になります。しかしpprintを使えば、JSONの構造（タグ）に従って自動的にインデントや改行が加えられ、人間にとって読みやすい形に整えてくれます。

pprintを使わない場合

まずは、従来のprintメソッドを使ってWebページのJSONコンテンツを出力してみましょう。結果はすべて1行で表示されます。

コード例

import requests
json_url_link = "https://pypi.org/pypi/sampleproject/json"
result = requests.get(json_url_link)
print(result.json())

出力結果

上記のコードを実行すると、次のような結果が得られます。

{'info': {'author': 'The Python Packaging Authority', 'author_email': 'pypa-dev@googlegroups.com', . . .

このように、長いJSONデータが1行に連なって表示されるため、どのキーにどんな値が入っているのか一目では把握しづらくなります。

pprintを使った場合

次に、同じコンテンツに対してpprintを適用してみます。pprintは標準ライブラリに含まれているため、追加のインストールは不要です。from pprint import pprintと記述するだけで利用できます。

コード例

import requests
from pprint import pprint
json_url_link = "https://pypi.org/pypi/sampleproject/json"
result = requests.get(json_url_link)
pprint(result.json())

出力結果

上記のコードを実行すると、次のような結果が得られます。

{'info': {'author': 'The Python Packaging Authority',
          'author_email': 'pypa-dev@googlegroups.com',
          'bugtrack_url': None,
          'classifiers': ['Development Status :: 3 - Alpha',
                          'Intended Audience :: Developers',
                          'License :: OSI Approved :: MIT License',
                          'Programming Language :: Python :: 2',
                          'Programming Language :: Python :: 2.7',

ご覧のとおり、出力が階層構造に沿って整理され、ネストされた辞書やリストの中身も非常に見やすくなっています。

まとめ

pprintは、APIレスポンスや設定ファイルなど、複雑なデータ構造をデバッグ・確認する際に非常に役立つツールです。通常のprintとの違いはわずか数行のコードですが、可読性の向上効果は絶大です。日常的な開発作業にぜひ取り入れてみてください。