Содержание страницы

`pprint` – форматированный вывод данных¶pprint – Data pretty printer

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

Модуль pprint предоставляет возможность «форматированного вывода» произвольных структур данных Python в форме, которую можно использовать как входные данные для интерпретатора. Если отформатированные структуры содержат объекты, не являющиеся фундаментальными типами Python, представление может оказаться незагружаемым. Так бывает, если включены объекты вроде файлов, сокетов или классов, а также многие другие объекты, которые не представимы в виде литералов Python.

Форматированное представление помещает объекты в одну строку, если это возможно, и разбивает их на несколько строк, если они не помещаются в заданную ширину, которая настраивается с помощью параметра width (по умолчанию 80 символов).

Изменено в версии 3.9: Добавлена поддержка форматированного вывода types.SimpleNamespace.

Изменено в версии 3.10: Добавлена поддержка форматированного вывода dataclasses.dataclass.

Функции¶Functions

pprint.pp(object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=False, underscore_numbers=False)¶

Выводит форматированное представление объекта с последующим переводом строки. Эту функцию можно использовать в интерактивном интерпретаторе вместо функции print() для просмотра значений. Подсказка: вы можете переназначить print = pprint.pp для использования в пределах области видимости.

Параметры:

object – Объект для вывода.
поток данных (объект, подобный файлу | None) – Объект, подобный файлу, в который будет записан вывод путём вызова его метода write(). Если None (по умолчанию), используется sys.stdout.
indent (int) – Величина отступа, добавляемого для каждого уровня вложенности.
width (int) – Желаемая максимальная длина строки в символах. Если структуру невозможно отформатировать с заданным ограничением ширины, будет предпринята попытка сделать всё возможное.
depth (int | None) – Количество уровней вложенности, которое может быть выведено. Если выводимая структура данных слишком глубока, следующий вложенный уровень заменяется на .... Если None (по умолчанию), ограничение на глубину форматируемых объектов отсутствует.
compact (bool) – Управляет способом форматирования длинных последовательностей. Если False (по умолчанию), каждый элемент последовательности выводится на отдельной строке, иначе на каждой выходной строке выводится столько элементов, сколько помещается в пределах width.
sort_dicts (bool) – Если True, словари будут форматироваться с сортировкой ключей, в противном случае они будут отображаться в порядке вставки (по умолчанию).
underscore_numbers (bool) – Если True, целые числа будут форматироваться с символом _ в качестве разделителя тысяч, в противном случае символ подчёркивания не отображается (по умолчанию).

>>> import pprint
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
>>> stuff.insert(0, stuff)
>>> pprint.pp(stuff)
[<Recursion on list with id=...>,
 'spam',
 'eggs',
 'lumberjack',
 'knights',
 'ni']

Добавлено в версии 3.8.

pprint.pprint(object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)¶: Псевдоним для pp() с sort_dicts, по умолчанию установленным в True, что автоматически сортирует ключи словарей. Вместо этого рекомендуется использовать pp(), где по умолчанию False.

pprint.pformat(object, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)¶: Возвращает форматированное представление object в виде строки. Параметры indent, width, depth, compact, sort_dicts и underscore_numbers передаются конструктору PrettyPrinter в качестве параметров форматирования; их значения описаны в документации выше.

pprint.isreadable(object)¶

Определяет, является ли форматированное представление object «читаемым» или может использоваться для восстановления значения с помощью eval(). Для рекурсивных объектов всегда возвращает False.

>>> pprint.isreadable(stuff)
False

pprint.isrecursive(object)¶: Определяет, требует ли object рекурсивного представления. Эта функция имеет те же ограничения, что указаны в saferepr() ниже, и может вызывать RecursionError, если не удаётся обнаружить рекурсивный объект.

pprint.saferepr(object)¶

Возвращает строковое представление object, защищённое от рекурсии в некоторых распространённых структурах данных, а именно экземплярах dict, list и tuple или подклассах, у которых не переопределён __repr__. Если представление объекта содержит рекурсивный элемент, рекурсивная ссылка будет представлена как <Recursion on typename with id=number>. В остальном представление не форматируется.

>>> pprint.saferepr(stuff)
"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"

Объекты PrettyPrinter¶PrettyPrinter Objects

class pprint.PrettyPrinter(indent=1, width=80, depth=None, stream=None, *, compact=False, sort_dicts=True, underscore_numbers=False)¶

Создаёт экземпляр PrettyPrinter.

Аргументы имеют тот же смысл, что и для pp(). Обратите внимание, что они расположены в другом порядке, и sort_dicts по умолчанию равен True.

>>> 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']
>>> pp = pprint.PrettyPrinter(width=41, compact=True)
>>> 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', (...)))))))

Изменено в версии 3.4: Добавлен параметр compact.

Изменено в версии 3.8: добавлен параметр sort_dicts.

Изменено в версии 3.10: добавлен параметр underscore_numbers.

Изменено в версии 3.11: больше не пытается записывать в sys.stdout, если он равен None.

Экземпляры PrettyPrinter имеют следующие методы:

PrettyPrinter.pformat(object)¶: Возвращает отформатированное представление object. Учитываются параметры, переданные конструктору PrettyPrinter.

PrettyPrinter.pprint(object)¶: Выводит отформатированное представление object в настроенный поток, после чего добавляет новую строку.

Следующие методы предоставляют реализации для соответствующих функций с теми же именами. Использование этих методов на экземпляре немного эффективнее, поскольку не нужно создавать новые объекты PrettyPrinter.

PrettyPrinter.isreadable(object)¶: Определяет, является ли форматированное представление объекта «читаемым» или может быть использовано для восстановления значения с помощью eval(). Обратите внимание: для рекурсивных объектов возвращается False. Если установлен параметр depth в PrettyPrinter и объект глубже допустимого, возвращается False.

PrettyPrinter.isrecursive(object)¶: Определяет, требует ли объект рекурсивного представления.

Этот метод предоставляется как хук, позволяющий подклассам изменять способ преобразования объектов в строки. Реализация по умолчанию использует внутренние механизмы реализации saferepr().

PrettyPrinter.format(object, context, maxlevels, level)¶: Возвращает три значения: форматированную версию object в виде строки, флаг, указывающий, является ли результат читаемым, и флаг, указывающий, была ли обнаружена рекурсия. Первый аргумент – отображаемый объект. Второй – словарь, содержащий id() объектов, которые являются частью текущего контекста представления (прямые и косвенные контейнеры для object, влияющие на представление) в качестве ключей; если необходимо отобразить объект, который уже представлен в context, третье возвращаемое значение должно быть True. Рекурсивные вызовы метода format() должны добавлять дополнительные записи для контейнеров в этот словарь. Третий аргумент, maxlevels, задаёт запрошенный лимит рекурсии; он будет равен 0, если лимит не задан. Этот аргумент должен передаваться рекурсивным вызовам без изменений. Четвёртый аргумент, level, указывает текущий уровень; рекурсивные вызовы должны получать значение, меньшее текущего.

Пример¶Example

Чтобы продемонстрировать несколько способов использования функции pp() и её параметров, получим информацию о проекте из PyPI:

>>> import json
>>> import pprint
>>> from urllib.request import urlopen
>>> with urlopen('https://pypi.org/pypi/sampleproject/1.2.0/json') as resp:
...     project_info = json.load(resp)['info']

В своей базовой форме pp() отображает весь объект:

>>> pprint.pp(project_info)
{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': ['Development Status :: 3 - Alpha',
                 'Intended Audience :: Developers',
                 'License :: OSI Approved :: MIT License',
                 'Programming Language :: Python :: 2',
                 'Programming Language :: Python :: 2.6',
                 'Programming Language :: Python :: 2.7',
                 'Programming Language :: Python :: 3',
                 'Programming Language :: Python :: 3.2',
                 'Programming Language :: Python :: 3.3',
                 'Programming Language :: Python :: 3.4',
                 'Topic :: Software Development :: Build Tools'],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the project.\n'
                '\n'
                'The file should use UTF-8 encoding and be written using '
                'ReStructured Text. It\n'
                'will be used to generate the project webpage on PyPI, and '
                'should be written for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would include an overview of '
                'the project, basic\n'
                'usage examples, etc. Generally, including the project '
                'changelog in here is not\n'
                'a good idea, although a simple "What\'s New" section for the '
                'most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': {'last_day': -1, 'last_month': -1, 'last_week': -1},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': {'Download': 'UNKNOWN',
                  'Homepage': 'https://github.com/pypa/sampleproject'},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'}

Результат можно ограничить определённой depth (для более глубокого содержимого используется многоточие):

>>> pprint.pp(project_info, depth=1)
{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': [...],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the project.\n'
                '\n'
                'The file should use UTF-8 encoding and be written using '
                'ReStructured Text. It\n'
                'will be used to generate the project webpage on PyPI, and '
                'should be written for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would include an overview of '
                'the project, basic\n'
                'usage examples, etc. Generally, including the project '
                'changelog in here is not\n'
                'a good idea, although a simple "What\'s New" section for the '
                'most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': {...},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': {...},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'}

Кроме того, можно указать максимальную ширину width. Если длинный объект невозможно разбить, указанная ширина будет превышена:

>>> pprint.pp(project_info, depth=1, width=60)
{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': [...],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the '
                'project.\n'
                '\n'
                'The file should use UTF-8 encoding and be '
                'written using ReStructured Text. It\n'
                'will be used to generate the project '
                'webpage on PyPI, and should be written '
                'for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would '
                'include an overview of the project, '
                'basic\n'
                'usage examples, etc. Generally, including '
                'the project changelog in here is not\n'
                'a good idea, although a simple "What\'s '
                'New" section for the most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': {...},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': {...},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'}

pprint – форматированный вывод данных¶pprint – Data pretty printer

Функции¶Functions

Объекты PrettyPrinter¶PrettyPrinter Objects

Пример¶Example

`pprint` – форматированный вывод данных¶pprint – Data pretty printer