### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python v2.6.2 documentation »
- Python 標準ライブラリ »
- 9. データ型 »

# 9.18. `pprint` — データ出力の整然化

`pprint` モジュールを使うと、Pythonの任意のデータ構造をインタープリタへの入力で使われる形式にして”pretty-print”できます。 フォーマット化された構造の中にPythonの基本的なタイプではないオブジェクトがあるなら、表示できないかもしれません。 Pythonの定数として表現できない多くの組み込みオブジェクトと同様、ファイル、ソケット、クラスあるいはインスタンスのようなオブジェクトが含まれてい た場合は出力できません。

可能であればオブジェクトをフォーマット化して1行に出力しますが、与えられた幅に合わないなら複数行に分けて出力します。 無理に幅を設定したいなら、 `PrettyPrinter` オブジェクトを作成して明示してください。

バージョン 2.5 で変更: 辞書は出力を計算する前にキーでソートされます。 2.5以前では、辞書は1行以上必要な場合にのみソートされていましたがドキュメントには書かれていませんでした。

バージョン 2.6 で変更: `set` と `frozenset` がサポートされました。

`pprint` モジュールには1つのクラスが定義されています：

class `pprint.``PrettyPrinter`(...)

  `PrettyPrinter` インスタンスを作ります。このコンストラクタにはいくつかのキーワードパラメータを設定できます。

  stream キーワードで出力ストリームを設定できます；このストリームに対して呼び出されるメソッドはファイルプロトコルの `write()` メソッドだ けです。もし設定されなければ、 `PrettyPrinter` は `sys.stdout` を使用します。 さらに3つのパラメータで出力フォーマットをコントロールできます。そのキーワードは indent 、 depth と width です。

  再帰的なレベルごとに加えるインデントの量は indent で設定できます；デフォルト値は1です。 他の値にすると出力が少しおかしく見えますが、ネスト化されたところが見分け易くなります。

  出力されるレベルは depth で設定できます；出力されるデータ構造が深いなら、指定以上の深いレベルのものは `...` で置き換えられて表示されます。 デフォルトでは、オブジェクトの深さを制限しません。

  width パラメータを使うと、出力する幅を望みの文字数に設定できます；デフォルトでは80文字です。 もし指定した幅にフォーマットできない場合は、できるだけ近づけます。

      >>> import pprint
      >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
      >>> stuff.insert(0, stuff[:])
      >>> pp = pprint.PrettyPrinter(indent=4)
      >>> pp.pprint(stuff)
      [   ['spam', 'eggs', 'lumberjack', 'knights', 'ni'],
          'spam',
          'eggs',
          'lumberjack',
          'knights',
          'ni']
      >>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
      ... ('parrot', ('fresh fruit',))))))))
      >>> pp = pprint.PrettyPrinter(depth=6)
      >>> pp.pprint(tup)
      (266, (267, (307, (287, (288, (...))))))
      ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...)))))))

`PrettyPrinter` クラスにはいくつかの派生する関数が提供されています：

`pprint.``pformat`(object[, indent[, width[, depth]]])

  object をフォーマット化して文字列として返します。 indent 、 width と、 depth は `PrettyPrinter` コンストラクタにフォーマット指定引数として渡されます。

  バージョン 2.4 で変更: 引数 indent 、 width と、 depth が追加されました.

`pprint.``pprint`(object[, stream[, indent[, width[, depth]]]])

  object をフォーマット化して stream に出力し、最後に改行します。 stream が省略されたら、 `sys.stdout` に出力します。 これは対話型のインタープリタ上で、求める値を `print` する代わりに使用できます。 indent 、 width と、 depth は `PrettyPrinter` コンストラクタにフォーマット指定引数として渡されます。

      >>> import pprint
      >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
      >>> stuff.insert(0, stuff)
      >>> pprint.pprint(stuff)
      [<Recursion on list with id=...>,
       'spam',
       'eggs',
       'lumberjack',
       'knights',
       'ni']

  バージョン 2.4 で変更: 引数 indent 、 width と、 depth が追加されました.

`pprint.``isreadable`(object)

  object をフォーマット化して出力できる（”readable”）か、あるいは `eval()` を使って値を再構成できるかを返します。 再帰的なオブジェクトに対しては常に `False` を返します。

      >>> pprint.isreadable(stuff)
      False

`pprint.``isrecursive`(object)

  object が再帰的な表現かどうかを返します。

さらにもう1つ、関数が定義されています：

`pprint.``saferepr`(object)

  object の文字列表現を、再帰的なデータ構造から保護した形式で返します。 もし object の文字列表現が再帰的な要素を持っているなら、再帰的な参照は `<Recursion on typename with id=number>` で表示されます。 出力は他と違ってフォーマット化されません。

      >>> pprint.saferepr(stuff)
      "[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"

## 9.18.1. PrettyPrinter オブジェクト

`PrettyPrinter` インスタンスには以下のメソッドがあります：

`PrettyPrinter.``pformat`(object)

  object のフォーマット化した表現を返します。これは `PrettyPrinter` のコンストラクタに渡されたオプションを考慮し てフォーマット化されます。

`PrettyPrinter.``pprint`(object)

  object のフォーマット化した表現を指定したストリームに出力し、最後に改行します。

以下のメソッドは、対応する同じ名前の関数と同じ機能を持っています。 以下のメソッドをインスタンスに対して使うと、新たに `PrettyPrinter` オブジェクトを作る必要がないのでちょっぴり効果的です。

`PrettyPrinter.``isreadable`(object)

  object をフォーマット化して出力できる（”readable”）か、あるいは `eval()` を使って値を再構成できるかを返します。 これは再帰的なオブジェクトに対して `False` を返すことに注意して下さい。 もし `PrettyPrinter` の depth パラメータが設定されていて、オブジェクトのレベルが設定よりも深かったら、 `False` を返します。

`PrettyPrinter.``isrecursive`(object)

  オブジェクトが再帰的な表現かどうかを返します。

このメソッドをフックとして、サブクラスがオブジェクトを文字列に変換する方法を修正するのが可能になっています。 デフォルトの実装では、内部で `saferepr()` を呼び出しています。

`PrettyPrinter.``format`(object, context, maxlevels, level)

  3つの値を返します： object をフォーマット化して文字列にしたもの、その結果が読み込み可能かどうかを示すフラグ、再帰が含まれているかどうかを示 すフラグ。

  最初の引数は表示するオブジェクトです。 2つめの引数はオブジェクトの `id()` をキーとして含むディクショナリ で、オブジェクトを含んでいる現在の（直接、間接に object のコンテナとして表示に影響を与える）環境です。 ディクショナリ context の中でどのオブジェクトが表示されたか表示する必要があるなら、3つめの返り値は `True` になります。 `format()` メソッドの再帰呼び出しではこのディクショナリのコンテナに対してさらにエントリを加えます。 3つめの引数 maxlevels で再帰呼び出しのレベルを設定します；もし制限しないなら、 `0` にします。この引数は再帰呼び出しでそのまま渡されます。 4つめの引数 level で現在のレベルを設定します；再帰呼び出しでは、現在の呼び出しより小さい値が渡されます。

  バージョン 2.3 で追加.

## 9.18.2. pprint の例

この例は `pprint()` 関数とその引数の幾つかの使い方を例示しています。

    >>> import pprint
    >>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
    ... ('parrot', ('fresh fruit',))))))))
    >>> stuff = ['a' * 10, tup, ['a' * 30, 'b' * 30], ['c' * 20, 'd' * 20]]
    >>> pprint.pprint(stuff)
    ['aaaaaaaaaa',
     ('spam',
      ('eggs',
       ('lumberjack',
        ('knights', ('ni', ('dead', ('parrot', ('fresh fruit',)))))))),
     ['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'],
     ['cccccccccccccccccccc', 'dddddddddddddddddddd']]
    >>> pprint.pprint(stuff, depth=3)
    ['aaaaaaaaaa',
     ('spam', ('eggs', (...))),
     ['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'],
     ['cccccccccccccccccccc', 'dddddddddddddddddddd']]
    >>> pprint.pprint(stuff, width=60)
    ['aaaaaaaaaa',
     ('spam',
      ('eggs',
       ('lumberjack',
        ('knights',
         ('ni', ('dead', ('parrot', ('fresh fruit',)))))))),
     ['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
      'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'],
     ['cccccccccccccccccccc', 'dddddddddddddddddddd']]

### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python v2.6.2 documentation »
- Python 標準ライブラリ »
- 9. データ型 »