note.nkmk.me

Pythonのpprintの使い方(リストや辞書を整形して出力)

Date: 2018-04-30 / Modified: 2018-07-09 / tags: Python, リスト, 辞書
このエントリーをはてなブックマークに追加

Pythonの標準ライブラリであるpprintモジュールを使うと、リスト(list型)や辞書(dict型)などのオブジェクトをきれいに整形して出力・表示したり、文字列(str型オブジェクト)に変換したりすることができる。pprintは「pretty-print」の略。

リストや辞書ではなく長い文字列を整形(折り返し・省略)して出力するにはtextwrapモジュールが便利。以下の記事を参照。

ここでは、pprintモジュールをimportし、辞書を要素とする以下のリストを例に説明する。標準ライブラリなので追加でインストールする必要はない。

import pprint

l = [{'Name': 'Alice XXX', 'Age': 40, 'Points': [80, 20]}, 
     {'Name': 'Bob YYY', 'Age': 20, 'Points': [90, 10]},
     {'Name': 'Charlie ZZZ', 'Age': 30, 'Points': [70, 30]}]

以下の内容を説明する。

  • pprintの基本的な使い方
  • 出力幅(文字数)を指定: 引数width
  • 出力する要素の深さを指定: 引数depth
  • インデント幅を指定: 引数indent
  • 改行を最小限にする: 引数compact
  • 文字列に変換: pprint.pformat()
  • 例: 二次元配列(リストのリスト)を整形して表示
スポンサーリンク

pprintの基本的な使い方

通常のprint()関数ではリストや辞書の要素が改行されることなく1行で出力される。

print(l)
# [{'Name': 'Alice XXX', 'Age': 40, 'Points': [80, 20]}, {'Name': 'Bob YYY', 'Age': 20, 'Points': [90, 10]}, {'Name': 'Charlie ZZZ', 'Age': 30, 'Points': [70, 30]}]

pprint.pprint()を使うと、以下のようにリストの要素ごとに改行されて見やすくなる。

pprint.pprint(l)
# [{'Age': 40, 'Name': 'Alice XXX', 'Points': [80, 20]},
#  {'Age': 20, 'Name': 'Bob YYY', 'Points': [90, 10]},
#  {'Age': 30, 'Name': 'Charlie ZZZ', 'Points': [70, 30]}]

どこで改行されるかは以下で説明する引数の設定によって決まる。

出力するのではなく文字列(str型オブジェクト)に変換したい場合は後述のpprint.pformat()を使う。

出力幅(文字数)を指定: 引数width

出力する幅(文字数)を引数widthで指定できる。

1行が指定の文字数に収まるようにリストや辞書の要素で改行される。デフォルトはwidth=80

pprint.pprint(l, width=40)
# [{'Age': 40,
#   'Name': 'Alice XXX',
#   'Points': [80, 20]},
#  {'Age': 20,
#   'Name': 'Bob YYY',
#   'Points': [90, 10]},
#  {'Age': 30,
#   'Name': 'Charlie ZZZ',
#   'Points': [70, 30]}]

大きい値を指定すると、改行が挿入されずprint()と同様の出力になる。

pprint.pprint(l, width=200)
# [{'Age': 40, 'Name': 'Alice XXX', 'Points': [80, 20]}, {'Age': 20, 'Name': 'Bob YYY', 'Points': [90, 10]}, {'Age': 30, 'Name': 'Charlie ZZZ', 'Points': [70, 30]}]

改行されるのはリストや辞書の要素ごとで、辞書のキーkeyと値valueで改行されたり、数値の途中で改行されたりはしない。このため、必ずwidthで指定した文字数の幅に収まるわけではない。

文字列は単語ごと(スペースごと)に改行されるので注意。

pprint.pprint(l, width=1)
# [{'Age': 40,
#   'Name': 'Alice '
#           'XXX',
#   'Points': [80,
#              20]},
#  {'Age': 20,
#   'Name': 'Bob '
#           'YYY',
#   'Points': [90,
#              10]},
#  {'Age': 30,
#   'Name': 'Charlie '
#           'ZZZ',
#   'Points': [70,
#              30]}]

出力する要素の深さを指定: 引数depth

出力する要素の深さを引数depthで指定できる。ここでいう深さは入れ子になったデータの深さのこと。

指定した値より深い要素は省略記号...で出力される。

pprint.pprint(l, depth=1)
# [{...}, {...}, {...}]

pprint.pprint(l, depth=2)
# [{'Age': 40, 'Name': 'Alice XXX', 'Points': [...]},
#  {'Age': 20, 'Name': 'Bob YYY', 'Points': [...]},
#  {'Age': 30, 'Name': 'Charlie ZZZ', 'Points': [...]}]

デフォルトはdepth=Noneで、すべての要素が省略されず出力される。

widthを組み合わせることも可能。depthで指定するのはあくまでもデータ構造としての深さで、行数ではない。どこで改行されるかはwidthで指定する文字数によって決まる。

pprint.pprint(l, depth=2, width=40)
# [{'Age': 40,
#   'Name': 'Alice XXX',
#   'Points': [...]},
#  {'Age': 20,
#   'Name': 'Bob YYY',
#   'Points': [...]},
#  {'Age': 30,
#   'Name': 'Charlie ZZZ',
#   'Points': [...]}]

インデント幅を指定: 引数indent

インデント幅を引数indentで指定できる。デフォルトはindent=1

pprint.pprint(l, indent=4, width=4)
# [   {   'Age': 40,
#         'Name': 'Alice '
#                 'XXX',
#         'Points': [   80,
#                       20]},
#     {   'Age': 20,
#         'Name': 'Bob '
#                 'YYY',
#         'Points': [   90,
#                       10]},
#     {   'Age': 30,
#         'Name': 'Charlie '
#                 'ZZZ',
#         'Points': [   70,
#                       30]}]

改行を最小限にする: 引数compact

デフォルトでは出力幅widthに収まらない場合はリストや辞書のすべての要素で改行される。

l_long = [list(range(10)), list(range(100, 110))]

print(l_long)
# [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [100, 101, 102, 103, 104, 105, 106, 107, 108, 109]]

pprint.pprint(l_long, width=40)
# [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
#  [100,
#   101,
#   102,
#   103,
#   104,
#   105,
#   106,
#   107,
#   108,
#   109]]

引数compactTrueとすると出力幅widthに収まらない分だけが改行される。要素数の多いリストなどがある場合はcompact=Trueのほうが見やすい。

pprint.pprint(l_long, width=40, compact=True)
# [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
#  [100, 101, 102, 103, 104, 105, 106,
#   107, 108, 109]]

なお、引数compactはPythonのバージョン3.4で追加されたので、それより前のバージョンでは使えない。

文字列に変換: pprint.pformat()

辞書やリストはstr()で文字列(str型)に変換できる。

この場合、通常のprint()関数での出力のようにリストや辞書の要素が改行されることなく1行の文字列となる。

s_normal = str(l)
print(s_normal)
# [{'Name': 'Alice XXX', 'Age': 40, 'Points': [80, 20]}, {'Name': 'Bob YYY', 'Age': 20, 'Points': [90, 10]}, {'Name': 'Charlie ZZZ', 'Age': 30, 'Points': [70, 30]}]

print(type(s_normal))
# <class 'str'>

pprint.pprint()ではなくpprint.pformat()を使うと適宜改行が挿入されて整形された文字列(str型オブジェクト)として取得できる。

s_pp = pprint.pformat(l)
print(s_pp)
# [{'Age': 40, 'Name': 'Alice XXX', 'Points': [80, 20]},
#  {'Age': 20, 'Name': 'Bob YYY', 'Points': [90, 10]},
#  {'Age': 30, 'Name': 'Charlie ZZZ', 'Points': [70, 30]}]

print(type(s_pp))
# <class 'str'>

pprint.pformat()の引数はpprint.pprint()と共通。

s_pp = pprint.pformat(l, depth=2, width=40, indent=2)
print(s_pp)
# [ { 'Age': 40,
#     'Name': 'Alice XXX',
#     'Points': [...]},
#   { 'Age': 20,
#     'Name': 'Bob YYY',
#     'Points': [...]},
#   { 'Age': 30,
#     'Name': 'Charlie ZZZ',
#     'Points': [...]}]

例: 二次元配列(リストのリスト)を整形して表示

pprintは二次元配列(リストのリスト)を表示する場合に使うと便利。

通常のprint()関数だと見にくいが、pprintを使うと見やすい。

l_2d = [list(range(10)), list(range(10)), list(range(10))]

print(l_2d)
# [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]]

pprint.pprint(l_2d)
# [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
#  [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
#  [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]]

上述のように、どこで改行するかは引数widthで指定する文字数によって決まる。

要素数が少ない場合はデフォルトの出力幅width=80に収まるので改行されない。

l_2d = [[0, 1, 2], [3, 4, 5], [6, 7, 8]]

print(l_2d)
# [[0, 1, 2], [3, 4, 5], [6, 7, 8]]

pprint.pprint(l_2d)
# [[0, 1, 2], [3, 4, 5], [6, 7, 8]]

改行して表示したい場合はwidthを適宜指定すればOK。

pprint.pprint(l_2d, width=20)
# [[0, 1, 2],
#  [3, 4, 5],
#  [6, 7, 8]]

文字列として取得したい場合はpprint.pformat()

s = pprint.pformat(l_2d, width=20)
print(s)
# [[0, 1, 2],
#  [3, 4, 5],
#  [6, 7, 8]]

print(type(s))
# <class 'str'>
スポンサーリンク
シェア
このエントリーをはてなブックマークに追加

関連カテゴリー

関連記事