copyreg.rst 2.07 KB
Newer Older
1
:mod:`copyreg` --- Register :mod:`pickle` support functions
2
===========================================================
3

4
.. module:: copyreg
5 6 7 8 9 10 11
   :synopsis: Register pickle support functions.


.. index::
   module: pickle
   module: copy

12 13 14 15
The :mod:`copyreg` module offers a way to define fuctions used while pickling
specific objects.  The :mod:`pickle` and :mod:`copy` modules use those functions
when pickling/copying those objects.  The module provides configuration
information about object constructors which are not classes.
16
Such constructors may be factory functions or class instances.
17 18 19 20 21 22 23 24


.. function:: constructor(object)

   Declares *object* to be a valid constructor.  If *object* is not callable (and
   hence not valid as a constructor), raises :exc:`TypeError`.


25
.. function:: pickle(type, function, constructor=None)
26

27 28 29
   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.
30 31 32 33 34 35

   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.  :exc:`TypeError` will be raised if
   *object* is a class or *constructor* is not callable.

36 37 38 39 40
   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
   object or subclass of :class:`pickle.Pickler` can also be used for
   declaring reduction functions.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

Example
-------

The example below would like to show how to register a pickle function and how
it will be used:

   >>> import copyreg, copy, pickle
   >>> class C(object):
   ...     def __init__(self, a):
   ...         self.a = a
   ...
   >>> def pickle_c(c):
   ...     print("pickling a C instance...")
   ...     return C, (c.a,)
   ...
   >>> copyreg.pickle(C, pickle_c)
   >>> c = C(1)
   >>> d = copy.copy(c)
   pickling a C instance...
   >>> p = pickle.dumps(c)
   pickling a C instance...