[Python-checkins] bpo-42259: clarify pprint saferepr docs (#30256)
rhettinger
webhook-mailer at python.org
Tue May 10 13:22:52 EDT 2022
https://github.com/python/cpython/commit/392fd272cde0542859063ea01980091945029e95
commit: 392fd272cde0542859063ea01980091945029e95
branch: main
author: andrei kulakov <andrei.avk at gmail.com>
committer: rhettinger <rhettinger at users.noreply.github.com>
date: 2022-05-10T12:22:36-05:00
summary:
bpo-42259: clarify pprint saferepr docs (#30256)
files:
M Doc/library/pprint.rst
diff --git a/Doc/library/pprint.rst b/Doc/library/pprint.rst
index 3da5aa9389b17..4e29192311fc2 100644
--- a/Doc/library/pprint.rst
+++ b/Doc/library/pprint.rst
@@ -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']"
More information about the Python-checkins
mailing list