mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

bpo-42259: clarify pprint saferepr docs (#30256)

Browse source
This commit is contained in:
andrei kulakov 2022-05-10 13:22:36 -04:00 • committed by GitHub
parent 549567c6e7
commit 392fd272cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/pprint.rst
View file

@ -171,17 +171,21 @@ The :mod:`pprint` module defines one class:
.. function:: isrecursive(object)
Determine if *object* requires a recursive representation.
Determine if *object* requires a recursive representation. This function is
subject to the same limitations as noted in :func:`saferepr` below and may raise an
:exc:`RecursionError` if it fails to detect a recursive object.
One more support function is also defined:
.. function:: saferepr(object)
Return a string representation of *object*, protected against recursive data
structures. If the representation of *object* exposes a recursive entry, the
recursive reference will be represented as ``<Recursion on typename with
id=number>``. The representation is not otherwise formatted.
Return a string representation of *object*, protected against recursion in
some common data structures, namely instances of :class:`dict`, :class:`list`
and :class:`tuple` or subclasses whose ``__repr__`` has not been overridden. If the
representation of object exposes a recursive entry, the recursive reference
will be represented as ``<Recursion on typename with id=number>``. The
representation is not otherwise formatted.
>>> pprint.saferepr(stuff)
"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"