Содержание страницы
pprint – Форматированный вывод данных¶pprint – Data pretty printer
Модуль pprint предоставляет возможность «красиво выводить» произвольные структуры данных Python в форме, которую можно использовать как входные данные для интерпретатора. Если форматированные структуры содержат объекты, не являющиеся базовыми типами Python, представление может не загружаться. Это возможно, если включены объекты такие как файлы, сокеты, классы или экземпляры, а также многие другие встроенные объекты, которые не представимы в виде констант Python.
Форматированное представление размещает объекты на одной строке, если возможно, и переносит их на несколько строк, если они не помещаются в заданную ширину. Создавайте объекты PrettyPrinter явно, если требуется изменить ограничение по ширине.
Перед выводом словари сортируются по ключам.
Модуль pprint определяет один класс:
- class pprint.PrettyPrinter(...)¶
Создаёт экземпляр PrettyPrinter. Этот конструктор понимает несколько именованных параметров. Выходной поток данных можно задать с помощью ключевого слова stream; единственный метод, используемый на объекте потока данных – это метод write() из протокола файлов. Если не указано, PrettyPrinter использует sys.stdout. Ещё три параметра могут управлять форматированным представлением. Ключевые слова: indent, depth и width. Величина отступа, добавляемого на каждый рекурсивный уровень, задаётся параметром indent; по умолчанию – один. Другие значения могут сделать вывод немного необычным, но помогают лучше различать вложенность. Количество уровней, которые могут быть выведены, контролируется параметром depth; если выводимая структура данных слишком глубока, следующий вложенный уровень заменяется на .... По умолчанию ограничений на глубину форматируемых объектов нет. Желаемая ширина вывода задаётся параметром width; по умолчанию 80 символов. Если структуру невозможно отформатировать в заданной ширине, будет предпринята наилучшая попытка.
>>> import pprint >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni'] >>> stuff.insert(0, stuff[:]) >>> pp = pprint.PrettyPrinter(indent=4) >>> pp.pprint(stuff) [ ['spam', 'eggs', 'lumberjack', 'knights', 'ni'], 'spam', 'eggs', 'lumberjack', 'knights', 'ni'] >>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', ... ('parrot', ('fresh fruit',)))))))) >>> pp = pprint.PrettyPrinter(depth=6) >>> pp.pprint(tup) ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...)))))))
Класс PrettyPrinter поддерживает несколько производных функций:
- pprint.pformat(object[, indent[, width[, depth]]])¶
- Возвращает форматированное представление object в виде строки. Параметры indent, width и depth будут переданы конструктору PrettyPrinter в качестве параметров форматирования.
- pprint.pprint(object[, stream[, indent[, width[, depth]]]])¶
Выводит форматированное представление object в поток данных, добавляя новую строку. Если поток данных опущен, используется sys.stdout. Это может использоваться в интерактивном интерпретаторе вместо функции print() для просмотра значений (можно даже переназначить print = pprint.pprint для использования в области видимости). indent, width и depth будут переданы конструктору PrettyPrinter в качестве параметров форматирования.
>>> import pprint >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni'] >>> stuff.insert(0, stuff) >>> pprint.pprint(stuff) [<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']
- pprint.isreadable(object)¶
Определяет, является ли отформатированное представление object «читаемым» (readable) или может быть использовано для восстановления значения с помощью eval(). Для рекурсивных объектов всегда возвращает False.
>>> pprint.isreadable(stuff) False
- pprint.isrecursive(object)¶
- Определяет, требует ли объект object рекурсивного представления.
Также определена ещё одна вспомогательная функция:
- pprint.saferepr(object)¶
Возвращает строковое представление object, защищённое от рекурсивных структур данных. Если представление object содержит рекурсивную ссылку, она будет представлена как <Recursion on typename with id=number>. В остальном представление не форматируется.
>>> pprint.saferepr(stuff) "[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"
Объекты PrettyPrinter¶PrettyPrinter Objects
Экземпляры PrettyPrinter имеют следующие методы:
- PrettyPrinter.pformat(object)¶
- Возвращает отформатированное представление object. Учитываются параметры, переданные конструктору PrettyPrinter.
- PrettyPrinter.pprint(object)¶
- Выводит отформатированное представление object в настроенный поток, после чего добавляет новую строку.
Следующие методы предоставляют реализации соответствующих функций с теми же именами. Использование этих методов на экземпляре немного эффективнее, так как не требуется создавать новые объекты PrettyPrinter.
- PrettyPrinter.isreadable(object)¶
Определяет, является ли отформатированное представление объекта «читаемым» или может быть использовано для восстановления значения с помощью eval(). Обратите внимание: для рекурсивных объектов возвращается False. Если задан параметр depth объекта PrettyPrinter и объект глубже допустимого, возвращается False.
- PrettyPrinter.isrecursive(object)¶
- Определяет, требует ли объект рекурсивного представления.
Этот метод предоставляется как перехватчик (hook), позволяющий подклассам изменять способ преобразования объектов в строки. Реализация по умолчанию использует внутренние механизмы реализации saferepr().
- PrettyPrinter.format(object, context, maxlevels, level)¶
- Возвращает три значения: отформатированную версию object в виде строки, флаг, указывающий, является ли результат читаемым, и флаг, указывающий, была ли обнаружена рекурсия. Первый аргумент – отображаемый объект. Второй – словарь, который содержит id() объектов, являющихся частью текущего контекста представления (прямые и косвенные контейнеры для object, влияющие на представление), в качестве ключей; если нужно представить объект, который уже присутствует в context, третье возвращаемое значение должно быть True. Рекурсивные вызовы метода format() должны добавлять дополнительные записи для контейнеров в этот словарь. Третий аргумент, maxlevels, задаёт запрошенное ограничение на рекурсию; если ограничения нет, он равен 0. Этот аргумент следует передавать в рекурсивные вызовы без изменений. Четвёртый аргумент, level, задаёт текущий уровень; рекурсивным вызовам следует передавать значение меньше текущего.
Пример pprint¶pprint Example
Этот пример демонстрирует несколько способов использования функции pprint() и её параметров.
>>> import pprint
>>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
... ('parrot', ('fresh fruit',))))))))
>>> stuff = ['a' * 10, tup, ['a' * 30, 'b' * 30], ['c' * 20, 'd' * 20]]
>>> pprint.pprint(stuff)
['aaaaaaaaaa',
('spam',
('eggs',
('lumberjack',
('knights', ('ni', ('dead', ('parrot', ('fresh fruit',)))))))),
['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'],
['cccccccccccccccccccc', 'dddddddddddddddddddd']]
>>> pprint.pprint(stuff, depth=3)
['aaaaaaaaaa',
('spam', ('eggs', (...))),
['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'],
['cccccccccccccccccccc', 'dddddddddddddddddddd']]
>>> pprint.pprint(stuff, width=60)
['aaaaaaaaaa',
('spam',
('eggs',
('lumberjack',
('knights',
('ni', ('dead', ('parrot', ('fresh fruit',)))))))),
['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'],
['cccccccccccccccccccc', 'dddddddddddddddddddd']]