languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-09-06 03:23:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

gh-56133: copyreg docs: Clarify function/constructor parameter (#95497)

Browse source
This commit is contained in:
Stanley 2022-10-09 17:51:02 -07:00 committed by GitHub
parent f1879690aa
commit 281a3f18cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Doc/library/copyreg.rst
View file

@ -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.