Skip to content

[3.11] gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497) #98131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2022
Merged

[3.11] gh-56133: copyreg docs: Clarify function/constructor parameter (GH-95497) #98131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions Doc/library/copyreg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down