mirror of https://github.com/python/cpython.git
(cherry-picked from commit 3870d19d15
)
This commit is contained in:
parent
b49c963e85
commit
1e719d374c
|
@ -10,7 +10,7 @@
|
|||
|
||||
--------------
|
||||
|
||||
The :mod:`reprlib` module provides a means for producing object representations
|
||||
The :mod:`!reprlib` module provides a means for producing object representations
|
||||
with limits on the size of the resulting strings. This is used in the Python
|
||||
debugger and may be useful in other contexts as well.
|
||||
|
||||
|
@ -39,29 +39,31 @@ This module provides a class, an instance, and a function:
|
|||
limits on most sizes.
|
||||
|
||||
In addition to size-limiting tools, the module also provides a decorator for
|
||||
detecting recursive calls to :meth:`__repr__` and substituting a placeholder
|
||||
string instead.
|
||||
detecting recursive calls to :meth:`~object.__repr__` and substituting a
|
||||
placeholder string instead.
|
||||
|
||||
|
||||
.. index:: single: ...; placeholder
|
||||
|
||||
.. decorator:: recursive_repr(fillvalue="...")
|
||||
|
||||
Decorator for :meth:`__repr__` methods to detect recursive calls within the
|
||||
Decorator for :meth:`~object.__repr__` methods to detect recursive calls within the
|
||||
same thread. If a recursive call is made, the *fillvalue* is returned,
|
||||
otherwise, the usual :meth:`__repr__` call is made. For example:
|
||||
otherwise, the usual :meth:`!__repr__` call is made. For example:
|
||||
|
||||
>>> from reprlib import recursive_repr
|
||||
>>> class MyList(list):
|
||||
... @recursive_repr()
|
||||
... def __repr__(self):
|
||||
... return '<' + '|'.join(map(repr, self)) + '>'
|
||||
...
|
||||
>>> m = MyList('abc')
|
||||
>>> m.append(m)
|
||||
>>> m.append('x')
|
||||
>>> print(m)
|
||||
<'a'|'b'|'c'|...|'x'>
|
||||
.. doctest::
|
||||
|
||||
>>> from reprlib import recursive_repr
|
||||
>>> class MyList(list):
|
||||
... @recursive_repr()
|
||||
... def __repr__(self):
|
||||
... return '<' + '|'.join(map(repr, self)) + '>'
|
||||
...
|
||||
>>> m = MyList('abc')
|
||||
>>> m.append(m)
|
||||
>>> m.append('x')
|
||||
>>> print(m)
|
||||
<'a'|'b'|'c'|...|'x'>
|
||||
|
||||
.. versionadded:: 3.2
|
||||
|
||||
|
@ -155,7 +157,9 @@ Subclassing Repr Objects
|
|||
The use of dynamic dispatching by :meth:`Repr.repr1` allows subclasses of
|
||||
:class:`Repr` to add support for additional built-in object types or to modify
|
||||
the handling of types already supported. This example shows how special support
|
||||
for file objects could be added::
|
||||
for file objects could be added:
|
||||
|
||||
.. testcode::
|
||||
|
||||
import reprlib
|
||||
import sys
|
||||
|
@ -169,3 +173,7 @@ for file objects could be added::
|
|||
|
||||
aRepr = MyRepr()
|
||||
print(aRepr.repr(sys.stdin)) # prints '<stdin>'
|
||||
|
||||
.. testoutput::
|
||||
|
||||
<stdin>
|
||||
|
|
|
@ -87,7 +87,6 @@ Doc/library/pydoc.rst
|
|||
Doc/library/pyexpat.rst
|
||||
Doc/library/random.rst
|
||||
Doc/library/readline.rst
|
||||
Doc/library/reprlib.rst
|
||||
Doc/library/resource.rst
|
||||
Doc/library/rlcompleter.rst
|
||||
Doc/library/select.rst
|
||||
|
|
Loading…
Reference in New Issue