Содержание страницы
reprlib – альтернативная реализация repr()¶reprlib – Alternate repr() implementation
Исходный код: Lib/reprlib.py
Модуль 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)¶
Это метод
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 Objects
Экземпляры Repr предоставляют несколько атрибутов, которые можно использовать для задания
ограничений размера представлений разных типов объектов, а также методы,
форматирующие конкретные типы объектов.
- Repr.fillvalue¶
Эта строка отображается для рекурсивных ссылок. По умолчанию она равна
....Добавлено в версии 3.12.
- 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.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 - 1в качестве значения level при рекурсивном вызове.
- Repr.repr_TYPE(obj, level)
Методы форматирования для конкретных типов реализуются как методы, имя которых строится на основе имени типа. В имени метода TYPE заменяется на
'_'.join(type(obj).__name__.split()). Вызов этих методов осуществляется черезrepr1(). Методы, специфичные для типа, которым нужно рекурсивно отформатировать значение, должны вызыватьself.repr1(subobj, level - 1).
Создание подклассов объектов Repr¶Subclassing Repr Objects
Использование динамической диспетчеризации в 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)) # печатает '<stdin>'
<stdin>