pythonのpprintでリストや辞書を見やすく整形する

width引数

width引数には出力幅を指定します。デフォルトは80です。pprint()関数の出力は、このwidthの幅に収まるように整形されます。

pprint()関数は可能であれば1行に整形して出力します。1行がwidthの幅に収まらなければ複数行に整形して出力します。ただし、widthは努力目標なので、必ずこの幅に収まるとは限りません。データによって改行される場所が決まりますので、widthに収まるように改行できなければ、行はwidthの幅より長くなります。

widthの幅に収まるように1行で出力できるなら、次のようにpprint()関数は1行で出力します。

>>> pprint.pprint(animals, width=45)
['elephant', 'tiger', 'bear', 'hippopotamus']

出力はちょうど45文字でwidthの幅に収まるため、改行されずに1行で表示されます。次のように1行に収まらなければ複数行に整形されて出力します。

>>> pprint.pprint(animals, width=44)
['elephant',
 'tiger',
 'bear',
 'hippopotamus']

次は辞書の例です。1行で出力しようとするとデフォルトの幅80に収まらないので、これも複数行に整形されます。なお、辞書はデフォルトでキーでソートされます。

>>> pprint.pprint(fruits)
{'apple': {'color': 'red', 'price': 120},
 'banana': {'color': 'yellow', 'price': 180},
 'strawberry': {'color': 'red', 'price': 500}}

どこで改行されるかはデータ型に依存します。width=1を指定して、どこで改行されるか見てみましょう。

>>> pprint.pprint(animals, width=1)
['elephant',
 'tiger',
 'bear',
 'hippopotamus']
>>> pprint.pprint(fruits, width=1)
{'apple': {'color': 'red',
           'price': 120},
 'banana': {'color': 'yellow',
            'price': 180},
 'strawberry': {'color': 'red',
                'price': 500}}

リストは変わりませんでしたが、ネストした辞書はいくつも場所で改行されました。この例から必ずしもwidthに収まるように整形されないこともわかるでしょう。

ネストした辞書のようにいくつかの場所で改行できる場合、widthの幅によって整形結果が変わります。次の例を見てください。

>>> pprint.pprint(fruits, width=60)
{'apple': {'color': 'red', 'price': 120},
'banana': {'color': 'yellow', 'price': 180},
'strawberry': {'color': 'red', 'price': 500}}

外側の辞書のキーが1行となるように整形されました。

この結果から、辞書はまず1行で出力することを試みる。これがwidthの幅に収まらなければ（外側の）辞書の要素（キーと値）を1行で表示することを試みる。これもwidthの幅に収まらなく、値が複数の要素から成る場合は、その要素で改行する、と推測できます。正確にどのように改行されるかは構文解析を理解する必要がありそうです。いろいろなデータを試して慣れる方が楽でしょう。

indent引数

整形するときのインデントを指定します。デフォルトは1です。indent=4を指定するとこんな感じになります。

>>> pprint.pprint(animals, width=1, indent=4)
[   'elephant',
    'tiger',
    'bear',
    'hippopotamus']
>>> pprint.pprint(fruits, width=1, indent=4)
{   'apple': {   'color': 'red',
                 'price': 120},
    'banana': {   'color': 'yellow',
                  'price': 180},
    'strawberry': {   'color': 'red',
                      'price': 500}}

depth引数

どのレベルまで出力するかを指定します。デフォルトはNoneで、すべてのレベルを出力します。省略されたレベルは「...」で出力されます。どのような出力になるかは慣れが必要です。いろいろなdepthやwidthで試して見ましょう。

>>> pprint.pprint(fruits, depth=1)
{'apple': {...}, 'banana': {...}, 'strawberry': {...}}
>>> pprint.pprint(fruits, width=30, depth=1)
{'apple': {...},
 'banana': {...},
 'strawberry': {...}}
>>> pprint.pprint(fruits, width=20, depth=1)
{'apple': {...},
 'banana': {...},
 'strawberry': {'color': 'red',
                'price': 500}}

compact引数

compactのデフォルトはFalseです。Trueに設定すると、widthに収まる限り、多くの要素を1行で表示しようとします。

>>> pprint.pprint(animals, width=40, compact=True)
['elephant', 'tiger', 'bear',
 'hippopotamus']

sort_dicts引数

sort_dictsのデフォルト値はTrueで、これは辞書を整形するときにキーでソートします。挿入された順番でそのまま整形したい場合、sort_dictsにFalseを指定します。

>>> pprint.pprint(fruits, sort_dicts=False)
{'strawberry': {'price': 500, 'color': 'red'},
 'banana': {'price': 180, 'color': 'yellow'},
 'apple': {'price': 120, 'color': 'red'}}

stream引数

streamのデフォルト値はNoneで、この場合sys.stdoutが使われます。つまり出力先は標準ストリームになります。このキーワド引数に他のストリームオブジェクトを指定して出力先を変更することもできます。