Skip to content

Commit

Permalink
[3.11] GH-115986 Docs: promote pprint.pp usage as a default (GH-116614)…
Browse files Browse the repository at this point in the history
… (#117197)

Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
  • Loading branch information
3 people committed Mar 24, 2024
1 parent 5d12230 commit a3a0ce1
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions Doc/library/pprint.rst
Expand Up @@ -44,6 +44,17 @@ Functions
*args* and *kwargs* will be passed to :func:`~pprint.pprint` as formatting
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


Expand All @@ -61,16 +72,8 @@ Functions
:class:`PrettyPrinter` constructor and their meanings are as
described in its documentation below.

>>> 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']
Note that *sort_dicts* is ``True`` by default and you might want to use
:func:`~pprint.pp` instead where it is ``False`` by default.

.. function:: pformat(object, indent=1, width=80, depth=None, *, \
compact=False, sort_dicts=True, underscore_numbers=False)
Expand Down Expand Up @@ -258,7 +261,7 @@ are converted to strings. The default implementation uses the internals of the
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>`_::

>>> import json
Expand All @@ -267,9 +270,9 @@ let's fetch information about a project from `PyPI <https://pypi.org>`_::
>>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
... 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_email': 'pypa-dev@googlegroups.com',
'bugtrack_url': None,
Expand Down Expand Up @@ -326,7 +329,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
contents)::

>>> pprint.pprint(project_info, depth=1)
>>> pprint.pp(project_info, depth=1)
{'author': 'The Python Packaging Authority',
'author_email': 'pypa-dev@googlegroups.com',
'bugtrack_url': None,
Expand Down Expand Up @@ -372,7 +375,7 @@ contents)::
Additionally, maximum character *width* can be suggested. If a long object
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_email': 'pypa-dev@googlegroups.com',
'bugtrack_url': None,
Expand Down

0 comments on commit a3a0ce1

Please sign in to comment.