summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorStanley <46876382+slateny@users.noreply.github.com>2022-10-10 00:51:02 (GMT)
committerGitHub <noreply@github.com>2022-10-10 00:51:02 (GMT)
commit281a3f18cc2afac0fa92c75e807775971e531711 (patch)
treef1ea568c809125ef22bf18730916a6748e6299a1 /Doc/library
parentf1879690aa0498ffc4427c95aed94e1ca629e072 (diff)
downloadcpython-281a3f18cc2afac0fa92c75e807775971e531711.zip
cpython-281a3f18cc2afac0fa92c75e807775971e531711.tar.gz
cpython-281a3f18cc2afac0fa92c75e807775971e531711.tar.bz2
gh-56133: copyreg docs: Clarify function/constructor parameter (#95497)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/copyreg.rst15
1 files changed, 6 insertions, 9 deletions
diff --git a/Doc/library/copyreg.rst b/Doc/library/copyreg.rst
index dc35965..866b180 100644
--- a/Doc/library/copyreg.rst
+++ b/Doc/library/copyreg.rst
@@ -25,20 +25,17 @@ Such constructors may be factory functions or class instances.
hence not valid as a constructor), raises :exc:`TypeError`.
-.. function:: pickle(type, function, constructor=None)
+.. function:: pickle(type, function, constructor_ob=None)
Declares that *function* should be used as a "reduction" function for objects
of type *type*. *function* should return either a string or a tuple
- containing two or three elements.
+ containing two or three elements. See the :attr:`~pickle.Pickler.dispatch_table`
+ for more details on the interface of *function*.
- The optional *constructor* parameter, if provided, is a callable object which
- can be used to reconstruct the object when called with the tuple of arguments
- returned by *function* at pickling time. A :exc:`TypeError` is raised if the
- *constructor* is not callable.
+ The *constructor_ob* parameter is a legacy feature and is now ignored, but if
+ passed it must be a callable.
- See the :mod:`pickle` module for more details on the interface
- expected of *function* and *constructor*. Note that the
- :attr:`~pickle.Pickler.dispatch_table` attribute of a pickler
+ Note that the :attr:`~pickle.Pickler.dispatch_table` attribute of a pickler
object or subclass of :class:`pickle.Pickler` can also be used for
declaring reduction functions.