mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-29 19:56:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

[3.12] GH-115986 Docs: promote pprint.pp usage as a default (GH-116614) (#117196)

Browse source 
Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2024-03-24 16:14:47 +01:00 • committed by GitHub
parent 4326e07a8b
commit 193a24bb80
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

33
Doc/library/pprint.rst
View file

@ -44,6 +44,17 @@ Functions
*args* and *kwargs* will be passed to :func:`~pprint.pprint` as formatting *args* and *kwargs* will be passed to :func:`~pprint.pprint` as formatting
parameters. parameters.
>>> 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']
.. versionadded:: 3.8 .. versionadded:: 3.8
@ -61,16 +72,8 @@ Functions
:class:`PrettyPrinter` constructor and their meanings are as :class:`PrettyPrinter` constructor and their meanings are as
described in its documentation below. described in its documentation below.
>>> import pprint Note that *sort_dicts* is ``True`` by default and you might want to use
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni'] :func:`~pprint.pp` instead where it is ``False`` by default.
>>> stuff.insert(0, stuff)
>>> pprint.pprint(stuff)
[<Recursion on list with id=...>,
'spam',
'eggs',
'lumberjack',
'knights',
'ni']
.. function:: pformat(object, indent=1, width=80, depth=None, *, \ .. function:: pformat(object, indent=1, width=80, depth=None, *, \
compact=False, sort_dicts=True, underscore_numbers=False) compact=False, sort_dicts=True, underscore_numbers=False)
@ -261,7 +264,7 @@ are converted to strings. The default implementation uses the internals of the
Example Example
------- -------
To demonstrate several uses of the :func:`~pprint.pprint` function and its parameters, To demonstrate several uses of the :func:`~pprint.pp` function and its parameters,
let's fetch information about a project from `PyPI <https://pypi.org>`_:: let's fetch information about a project from `PyPI <https://pypi.org>`_::
>>> import json >>> import json
@ -270,9 +273,9 @@ let's fetch information about a project from `PyPI <https://pypi.org>`_::
>>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp: >>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
... project_info = json.load(resp)['info'] ... project_info = json.load(resp)['info']
In its basic form, :func:`~pprint.pprint` shows the whole object:: In its basic form, :func:`~pprint.pp` shows the whole object::
>>> pprint.pprint(project_info) >>> pprint.pp(project_info)
{'author': 'The Python Packaging Authority', {'author': 'The Python Packaging Authority',
'author_email': 'pypa-dev@googlegroups.com', 'author_email': 'pypa-dev@googlegroups.com',
'bugtrack_url': None, 'bugtrack_url': None,
@ -329,7 +332,7 @@ In its basic form, :func:`~pprint.pprint` shows the whole object::
The result can be limited to a certain *depth* (ellipsis is used for deeper The result can be limited to a certain *depth* (ellipsis is used for deeper
contents):: contents)::
>>> pprint.pprint(project_info, depth=1) >>> pprint.pp(project_info, depth=1)
{'author': 'The Python Packaging Authority', {'author': 'The Python Packaging Authority',
'author_email': 'pypa-dev@googlegroups.com', 'author_email': 'pypa-dev@googlegroups.com',
'bugtrack_url': None, 'bugtrack_url': None,
@ -375,7 +378,7 @@ contents)::
Additionally, maximum character *width* can be suggested. If a long object Additionally, maximum character *width* can be suggested. If a long object
cannot be split, the specified width will be exceeded:: cannot be split, the specified width will be exceeded::
>>> pprint.pprint(project_info, depth=1, width=60) >>> pprint.pp(project_info, depth=1, width=60)
{'author': 'The Python Packaging Authority', {'author': 'The Python Packaging Authority',
'author_email': 'pypa-dev@googlegroups.com', 'author_email': 'pypa-dev@googlegroups.com',
'bugtrack_url': None, 'bugtrack_url': None,