reprlib — Альтернативная реализация repr()

Исходный код: Lib/reprlib.py

Модуль reprlib предоставляет средства для создания представлений объектов с ограничениями на размер результирующих строк. Это используется в отладчике Python и может быть полезно в других контекстах.

Этот модуль предоставляет класс, экземпляр и функцию:

class reprlib.Repr: Класс, предоставляющий сервисы форматирования, полезные при реализации функций, подобных встроенной repr(); ограничения размера для разных типов объектов добавлены, чтобы избежать генерации чрезмерно длинных представлений.

reprlib.aRepr: Это экземпляр Repr, который используется для предоставления функции repr(), описанной ниже. Изменение атрибутов этого объекта повлияет на ограничения размера, используемые функцией repr() и отладчиком Python.

reprlib.repr(obj): Это метод repr() объекта aRepr. Он возвращает строку, аналогичную той, что возвращает встроенная функция с тем же именем, но с ограничениями на большинство размеров.

В дополнение к инструментам ограничения размера, модуль также предоставляет декоратор для обнаружения рекурсивных вызовов __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.maxlevel: Предельная глубина создания рекурсивных представлений. По умолчанию 6.

Repr.maxdict
Repr.maxlist
Repr.maxtuple
Repr.maxset
Repr.maxfrozenset
Repr.maxdeque
Repr.maxarray: Ограничения на количество элементов, представленных для указанного типа объекта. По умолчанию 4 для maxdict, 5 для maxarray и 6 для остальных.

Repr.maxlong: Максимальное количество символов в представлении для целого числа. Цифры опускаются из середины. По умолчанию 40.

Repr.maxstring: Ограничение на количество символов в представлении строки. Обратите внимание, что используется «нормальное» представление строки в качестве источника символов: если для представления необходимы escape-последовательности, они могут быть повреждены при укорачивании представления. По умолчанию 30.

Repr.maxother: Это ограничение используется для управления размером типов объектов, для которых в объекте Repr нет специальных методов форматирования. Оно применяется аналогично maxstring. По умолчанию 20.

Repr.repr(obj): Эквивалент встроенной функции repr(), использующий форматирование, заданное экземпляром.

Repr.repr1(obj, level): Рекурсивная реализация, используемая методом repr(). Она использует тип obj для определения вызываемого метода форматирования, передавая ему obj и level. Методы, специфичные для типов, должны вызывать repr1() для выполнения рекурсивного форматирования, с level - 1 в качестве значения level в рекурсивном вызове.

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>'