reprlib — Альтернативная реализация repr()
Исходный код: 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 предоставляют несколько атрибутов, которые могут быть использованы для ограничения размера представлений различных типов объектов, а также методы для форматирования конкретных типов объектов.
-
Repr.fillvalue -
Эта строка отображается для рекурсивных ссылок. По умолчанию равна
....Добавлена в версии 3.11.
-
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 -
Ограничение на количество символов в представлении строки. Обратите внимание, что для получения исходных символов используется «нормальное» представление строки: если для представления требуются управляющие последовательности, они могут быть повреждены при укорачивании представления. По умолчанию
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
Использование динамической диспетчеризации в 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>
© 2001–2024 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.13/library/reprlib.html