`reprlib` — 替代 `repr()` 實現¶

reprlib 模組提供了一種生成物件表示的方法，並限制了結果字串的大小。這在 Python 偵錯程式中使用，也可能在其他上下文中有用。

此模組提供了一個類、一個例項和一個函式

class reprlib.Repr(*, maxlevel=6, maxtuple=6, maxlist=6, maxarray=5, maxdict=4, maxset=6, maxfrozenset=6, maxdeque=6, maxstring=30, maxlong=40, maxother=30, fillvalue='...', indent=None)¶

此類別提供格式化服務，有助於實現類似於內建 repr() 的函式；增加了不同物件型別的尺寸限制，以避免生成過長的表示。

建構函式的關鍵字引數可用作設定 Repr 例項屬性的快捷方式。這意味著以下初始化

aRepr = reprlib.Repr(maxlevel=3)

等效於

aRepr = reprlib.Repr()
aRepr.maxlevel = 3

有關 Repr 屬性的更多資訊，請參閱 Repr 物件部分。

3.12 版本中的更改: 允許透過關鍵字引數設定屬性。

reprlib.aRepr¶: 這是一個 Repr 例項，用於提供下面描述的 repr() 函式。更改此物件的屬性將影響 repr() 和 Python 偵錯程式使用的尺寸限制。

reprlib.repr(obj)¶: 這是 aRepr 的 repr() 方法。它返回一個與內建同名函式返回的字串類似的字串，但在大多數尺寸上都有限制。

除了尺寸限制工具之外，該模組還提供了一個裝飾器，用於檢測對 __repr__() 的遞迴呼叫，並替換為佔位符字串。

@reprlib.recursive_repr(fillvalue='...')¶

用於 __repr__() 方法的裝飾器，用於檢測同一執行緒內的遞迴呼叫。如果發生遞迴呼叫，則返回 fillvalue，否則，進行常規的 __repr__() 呼叫。例如

>>> 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¶: 此字串用於顯示遞迴引用。預設值為 ...。

在 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.indent¶

如果此屬性設定為 None（預設值），則輸出不帶換行符或縮排進行格式化，就像標準 repr() 一樣。例如

>>> example = [
...     1, 'spam', {'a': 2, 'b': 'spam eggs', 'c': {3: 4.5, 6: []}}, 'ham']
>>> import reprlib
>>> aRepr = reprlib.Repr()
>>> print(aRepr.repr(example))
[1, 'spam', {'a': 2, 'b': 'spam eggs', 'c': {3: 4.5, 6: []}}, 'ham']

如果 indent 設定為字串，則每個遞迴級別都放置在新行上，並由該字串縮排

>>> aRepr.indent = '-->'
>>> print(aRepr.repr(example))
[
-->1,
-->'spam',
-->{
-->-->'a': 2,
-->-->'b': 'spam eggs',
-->-->'c': {
-->-->-->3: 4.5,
-->-->-->6: [],
-->-->},
-->},
-->'ham',
]

將 indent 設定為正整數值，其行為如同將其設定為具有該數量空格的字串一樣

>>> aRepr.indent = 4
>>> print(aRepr.repr(example))
[
    1,
    'spam',
    {
        'a': 2,
        'b': 'spam eggs',
        'c': {
            3: 4.5,
            6: [],
        },
    },
    'ham',
]

3.12 新版功能.

Repr.repr(obj)¶: 等同於內建的 repr()，它使用例項強制的格式化。

Repr.repr1(obj, level)¶: repr() 使用的遞迴實現。它使用 obj 的型別來確定要呼叫的格式化方法，將 obj 和 level 傳遞給它。特定型別的方法應該呼叫 repr1() 來執行遞迴格式化，遞迴呼叫中 level 的值為 level - 1。

Repr.repr_TYPE(obj, level): 特定型別的格式化方法實現為名稱基於型別名稱的方法。在方法名稱中，TYPE 被替換為 '_'.join(type(obj).__name__.split())。repr1() 處理對這些方法的排程。需要遞迴格式化值的特定型別方法應呼叫 self.repr1(subobj, level - 1)。

Repr 物件子類化¶

Repr.repr1() 使用動態排程，允許 Repr 的子類新增對其他內建物件型別的支援或修改對已支援型別的處理。此示例顯示瞭如何新增對檔案物件的特殊支援

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>

`reprlib` — 替代 `repr()` 實現¶

Repr 物件¶

Repr 物件子類化¶

目錄

上一主題

下一主題

本頁

reprlib — 替代 repr() 實現¶

Repr 物件¶

Repr 物件子類化¶

`reprlib` — 替代 `repr()` 實現¶