traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix-up docs for the copyreg module renaming.

This commit is contained in:
Georg Brandl 2008-05-12 10:05:39 +00:00
parent 7a148c2357
commit 6a0a368479
4 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/library/copy.rst
View File

@ -63,7 +63,7 @@ of lists by assigning a slice of the entire list, for example,
Classes can use the same interfaces to control copying that they use to control Classes can use the same interfaces to control copying that they use to control
pickling. See the description of module :mod:`pickle` for information on these pickling. See the description of module :mod:`pickle` for information on these
methods. The :mod:`copy` module does not use the :mod:`copy_reg` registration methods. The :mod:`copy` module does not use the :mod:`copyreg` registration
module. module.
.. index:: .. index::

14
Doc/library/copy_reg.rst → Doc/library/copyreg.rst
View File

@ -1,19 +1,23 @@
:mod:`copyreg` --- Register :mod:`pickle` support functions
:mod:`copy_reg` --- Register :mod:`pickle` support functions ===========================================================
============================================================
.. module:: copy_reg .. module:: copy_reg
:synopsis: Old name for the copyreg module.
.. module:: copyreg
:synopsis: Register pickle support functions. :synopsis: Register pickle support functions.
.. note:: .. note::
The :mod:`copy_reg` module has been renamed to `copyreg` in Python 3.0. The :mod:`copy_reg` module has been renamed to :mod:`copyreg` in Python 3.0.
It is importable under both names in Python 2.6 and the rest of the 2.x
series.
.. index:: .. index::
module: pickle module: pickle
module: cPickle module: cPickle
module: copy module: copy
The :mod:`copy_reg` module provides support for the :mod:`pickle` and The :mod:`copyreg` module provides support for the :mod:`pickle` and
:mod:`cPickle` modules. The :mod:`copy` module is likely to use this in the :mod:`cPickle` modules. The :mod:`copy` module is likely to use this in the
future as well. It provides configuration information about object constructors future as well. It provides configuration information about object constructors
which are not classes. Such constructors may be factory functions or class which are not classes. Such constructors may be factory functions or class

2
Doc/library/persistence.rst
View File

@ -19,7 +19,7 @@ The list of modules described in this chapter is:
.. toctree:: .. toctree::
pickle.rst pickle.rst
copy_reg.rst copyreg.rst
shelve.rst shelve.rst
marshal.rst marshal.rst
anydbm.rst anydbm.rst

4
Doc/library/pickle.rst
View File

@ -535,7 +535,7 @@ not :meth:`__reduce_ex__`, the :meth:`__reduce_ex__` implementation detects this
and calls :meth:`__reduce__`. and calls :meth:`__reduce__`.
An alternative to implementing a :meth:`__reduce__` method on the object to be An alternative to implementing a :meth:`__reduce__` method on the object to be
pickled, is to register the callable with the :mod:`copy_reg` module. This pickled, is to register the callable with the :mod:`copyreg` module. This
module provides a way for programs to register "reduction functions" and module provides a way for programs to register "reduction functions" and
constructors for user-defined types. Reduction functions have the same constructors for user-defined types. Reduction functions have the same
semantics and interface as the :meth:`__reduce__` method described above, except semantics and interface as the :meth:`__reduce__` method described above, except
@ -786,7 +786,7 @@ the same process or a new process. ::
.. seealso:: .. seealso::
Module :mod:`copy_reg` Module :mod:`copyreg`
Pickle interface constructor registration for extension types. Pickle interface constructor registration for extension types.
Module :mod:`shelve` Module :mod:`shelve`