reprlib --- Alternate repr() implementation¶
ソースコード: Lib/reprlib.py
reprlib モジュールは、結果の文字列のサイズに対する制限付きでオブジェクト表現を生成するための手段を提供します。これは Python デバッガの中で使用されており、他の文脈でも同様に役に立つかもしれません。
このモジュールはクラスとインスタンス、それに関数を提供します:
- class reprlib.Repr¶
組み込み関数
repr()に似た関数を実装するために役に立つフォーマット用サービスを提供します。 過度に長い表現を作り出さないようにするための大きさの制限をオブジェクト型ごとに設定できます。
- reprlib.aRepr¶
これは下で説明される
repr()関数を提供するために使われるReprのインスタンスです。このオブジェクトの属性を変更すると、repr()と Python デバッガが使うサイズ制限に影響します。
In addition to size-limiting tools, the module also provides a decorator for
detecting recursive calls to __repr__() and substituting a
placeholder string instead.
- @reprlib.recursive_repr(fillvalue='...')¶
Decorator for
__repr__()methods to detect recursive calls within the same thread. If a recursive call is made, the fillvalue is returned, otherwise, the usual__repr__()call is made. For example:>>> from reprlib import recursive_repr >>> class MyList(list): ... @recursive_repr() ... def __repr__(self): ... return '<' + '|'.join(map(repr, self)) + '>' ... >>> m = MyList('abc') >>> m.append(m) >>> m.append('x') >>> print(m) <'a'|'b'|'c'|...|'x'>
バージョン 3.2 で追加.
Reprオブジェクト¶
Repr インスタンスはオブジェクト型毎に表現する文字列のサイズを制限するために使えるいくつかの属性と、特定のオブジェクト型をフォーマットするメソッドを提供します。
- Repr.fillvalue¶
This string is displayed for recursive references. It defaults to
....バージョン 3.11 で追加.
- Repr.maxlevel¶
再帰的な表現を作る場合の深さ制限。デフォルトは
6です。
- Repr.maxdict¶
- Repr.maxlist¶
- Repr.maxtuple¶
- Repr.maxset¶
- Repr.maxfrozenset¶
- Repr.maxdeque¶
- Repr.maxarray¶
指定されたオブジェクト型に対するエントリ表現の数についての制限。
maxdictに対するデフォルトは4で、maxarrayは5、その他に対しては6です。
- Repr.maxlong¶
整数の表現のおける文字数の最大値。中央の数字が抜け落ちます。デフォルトは
40です。
- Repr.maxstring¶
文字列の表現における文字数の制限。文字列の"通常の"表現は文字の「元」として使われることに注意してください。表現にエスケープシーケンスが必要とされる場合、表現が短縮されるときにこれらのエスケープシーケンスの形式は崩れます。デフォルトは
30です。
- Repr.maxother¶
この制限は
Reprオブジェクトに利用できる特定のフォーマットメソッドがないオブジェクト型のサイズをコントロールするために使われます。maxstringと同じようなやり方で適用されます。デフォルトは20です。
- Repr.repr1(obj, level)¶
repr()が使う再帰的な実装。 obj の型を使ってどのフォーマットメソッドを呼び出すかを決定し、それに obj と level を渡します。 再帰呼び出しにおいて level の値に対してlevel - 1を与える再帰的なフォーマットを実行するために、型に固有のメソッドはrepr1()を呼び出します。
- Repr.repr_TYPE(obj, level)
型名に基づく名前をもつメソッドとして、特定の型に対するフォーマットメソッドは実装されます。メソッド名では、 TYPE は
'_'.join(type(obj).__name__.split())に置き換えられます。これらのメソッドへのディスパッチはrepr1()によって処理されます。再帰的に値をフォーマットする必要がある型固有のメソッドは、self.repr1(subobj, level - 1)を呼び出します。
Reprオブジェクトをサブクラス化する¶
The use of dynamic dispatching by Repr.repr1() allows subclasses of
Repr to add support for additional built-in object types or to modify
the handling of types already supported. This example shows how special support
for file objects could be added:
import reprlib
import sys
class MyRepr(reprlib.Repr):
def repr_TextIOWrapper(self, obj, level):
if obj.name in {'<stdin>', '<stdout>', '<stderr>'}:
return obj.name
return repr(obj)
aRepr = MyRepr()
print(aRepr.repr(sys.stdin)) # prints '<stdin>'
<stdin>