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
-methods. The :mod:`copy` module does not use the :mod:`copyreg` registration
+methods. The :mod:`copy` module does not use the :mod:`copy_reg` registration
module.
.. index::
-:mod:`copyreg` --- Register :mod:`pickle` support functions
-===========================================================
+:mod:`copy_reg` --- Register :mod:`pickle` support functions
+============================================================
.. module:: copy_reg
- :synopsis: Old name for the copyreg module.
-
-.. module:: copyreg
:synopsis: Register pickle support functions.
.. note::
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.
+ The :term:`2to3` tool will automatically adapt imports when converting your
+ sources to 3.0.
.. index::
module: pickle
module: cPickle
module: copy
-The :mod:`copyreg` module provides support for the :mod:`pickle` and
+The :mod:`copy_reg` module provides support for the :mod:`pickle` and
:mod:`cPickle` modules. The :mod:`copy` module is likely to use this in the
future as well. It provides configuration information about object constructors
which are not classes. Such constructors may be factory functions or class
Loaded modules:
_types:
- copyreg: _inverted_registry,_slotnames,__all__
+ copy_reg: _inverted_registry,_slotnames,__all__
sre_compile: isstring,_sre,_optimize_unicode
_sre:
sre_constants: REPEAT_ONE,makedict,AT_END_LINE
.. toctree::
pickle.rst
- copyreg.rst
+ copy_reg.rst
shelve.rst
marshal.rst
anydbm.rst
and calls :meth:`__reduce__`.
An alternative to implementing a :meth:`__reduce__` method on the object to be
-pickled, is to register the callable with the :mod:`copyreg` module. This
+pickled, is to register the callable with the :mod:`copy_reg` module. This
module provides a way for programs to register "reduction functions" and
constructors for user-defined types. Reduction functions have the same
semantics and interface as the :meth:`__reduce__` method described above, except
.. seealso::
- Module :mod:`copyreg`
+ Module :mod:`copy_reg`
Pickle interface constructor registration for extension types.
Module :mod:`shelve`
"""
import types
-from copyreg import dispatch_table
+from copy_reg import dispatch_table
class Error(Exception):
pass
def pickle(ob_type, pickle_function, constructor_ob=None):
if type(ob_type) is _ClassType:
- raise TypeError("copyreg is not intended for use with classes")
+ raise TypeError("copy_reg is not intended for use with classes")
if not hasattr(pickle_function, '__call__'):
raise TypeError("reduction functions must be callable")
import threading
import queue
import traceback
-import copyreg
+import copy_reg
import types
import marshal
# assert isinstance(fn, type.FunctionType)
# return repr(fn)
-copyreg.pickle(types.CodeType, pickle_code, unpickle_code)
-# copyreg.pickle(types.FunctionType, pickle_function, unpickle_function)
+copy_reg.pickle(types.CodeType, pickle_code, unpickle_code)
+# copy_reg.pickle(types.FunctionType, pickle_function, unpickle_function)
BUFSIZE = 8*1024
LOCALHOST = '127.0.0.1'
+++ /dev/null
-import sys
-from warnings import warnpy3k
-
-warnpy3k("the copy_reg module has been renamed "
- "to 'copyreg' in Python 3.0", stacklevel=2)
-
-import copyreg
-sys.modules[__name__] = copyreg
return p.stdin, p.stdout
__all__.append("popen4")
-import copyreg as _copy_reg
+import copy_reg as _copy_reg
def _make_stat_result(tup, dict):
return stat_result(tup, dict)
"""Create portable serialized representations of Python objects.
See module cPickle for a (much) faster implementation.
-See module copyreg for a mechanism for registering custom picklers.
+See module copy_reg for a mechanism for registering custom picklers.
See module pickletools source for extensive comments.
Classes:
__version__ = "$Revision$" # Code version
from types import *
-from copyreg import dispatch_table
-from copyreg import _extension_registry, _inverted_registry, _extension_cache
+from copy_reg import dispatch_table
+from copy_reg import _extension_registry, _inverted_registry, _extension_cache
import marshal
import sys
import struct
self.save_global(obj)
return
- # Check copyreg.dispatch_table
+ # Check copy_reg.dispatch_table
reduce = dispatch_table.get(t)
if reduce:
rv = reduce(obj)
analysis.
To this end, all tests for __safe_for_unpickling__ or for
-copyreg.safe_constructors are removed from the unpickling code.
+copy_reg.safe_constructors are removed from the unpickling code.
References to these variables in the descriptions below are to be seen
as describing unpickling in Python 2.2 and before.
"""
BUILD opcode to apply __setstate__ to that argument.
If type(callable) is not ClassType, REDUCE complains unless the
- callable has been registered with the copyreg module's
+ callable has been registered with the copy_reg module's
safe_constructors dict, or the callable has a magic
'__safe_for_unpickling__' attribute with a true value. I'm not sure
why it does this, but I've sure seen this complaint often enough when
# register myself for pickling
-import copyreg
+import copy_reg
def _pickle(p):
return _compile, (p.pattern, p.flags)
-copyreg.pickle(_pattern_type, _pickle, _compile)
+copy_reg.pickle(_pattern_type, _pickle, _compile)
# --------------------------------------------------------------------
# experimental stuff (see python-dev discussions for details)
import pickle
import cPickle
import pickletools
-import copyreg
+import copy_reg
from test.test_support import TestFailed, have_unicode, TESTFN, \
run_with_locale
# there is one).
def __init__(self, code):
self.code = code
- if code in copyreg._inverted_registry:
- self.pair = copyreg._inverted_registry[code]
- copyreg.remove_extension(self.pair[0], self.pair[1], code)
+ if code in copy_reg._inverted_registry:
+ self.pair = copy_reg._inverted_registry[code]
+ copy_reg.remove_extension(self.pair[0], self.pair[1], code)
else:
self.pair = None
# Restore previous registration for code.
def restore(self):
code = self.code
- curpair = copyreg._inverted_registry.get(code)
+ curpair = copy_reg._inverted_registry.get(code)
if curpair is not None:
- copyreg.remove_extension(curpair[0], curpair[1], code)
+ copy_reg.remove_extension(curpair[0], curpair[1], code)
pair = self.pair
if pair is not None:
- copyreg.add_extension(pair[0], pair[1], code)
+ copy_reg.add_extension(pair[0], pair[1], code)
class C:
def __cmp__(self, other):
self.assertEqual(B(x), B(y), detail)
self.assertEqual(x.__dict__, y.__dict__, detail)
- # Register a type with copyreg, with extension code extcode. Pickle
+ # Register a type with copy_reg, with extension code extcode. Pickle
# an object of that type. Check that the resulting pickle uses opcode
# (EXT[124]) under proto 2, and not in proto 1.
def produce_global_ext(self, extcode, opcode):
e = ExtensionSaver(extcode)
try:
- copyreg.add_extension(__name__, "MyList", extcode)
+ copy_reg.add_extension(__name__, "MyList", extcode)
x = MyList([1, 2, 3])
x.foo = 42
x.bar = "hello"
def dash_R(the_module, test, indirect_test, huntrleaks):
# This code is hackish and inelegant, but it seems to do the job.
- import copyreg, _abcoll, io
+ import copy_reg, _abcoll, io
if not hasattr(sys, 'gettotalrefcount'):
raise Exception("Tracking reference leaks requires a debug build "
# Save current values for dash_R_cleanup() to restore.
fs = warnings.filters[:]
- ps = copyreg.dispatch_table.copy()
+ ps = copy_reg.dispatch_table.copy()
pic = sys.path_importer_cache.copy()
abcs = {}
modules = _abcoll, io
refrep.close()
def dash_R_cleanup(fs, ps, pic, abcs):
- import gc, copyreg
+ import gc, copy_reg
import _strptime, linecache
dircache = test_support.import_module('dircache', deprecated=True)
import urlparse, urllib, urllib2, mimetypes, doctest
# Restore some original values.
warnings.filters[:] = fs
- copyreg.dispatch_table.clear()
- copyreg.dispatch_table.update(ps)
+ copy_reg.dispatch_table.clear()
+ copy_reg.dispatch_table.update(ps)
sys.path_importer_cache.clear()
sys.path_importer_cache.update(pic)
self.check_all("commands")
self.check_all("compileall")
self.check_all("copy")
- self.check_all("copyreg")
+ self.check_all("copy_reg")
self.check_all("csv")
self.check_all("dbhash")
self.check_all("decimal")
"""Unit tests for the copy module."""
import copy
-import copyreg
+import copy_reg
import unittest
from test import test_support
return (C, (obj.foo,))
x = C(42)
self.assertRaises(TypeError, copy.copy, x)
- copyreg.pickle(C, pickle_C, C)
+ copy_reg.pickle(C, pickle_C, C)
y = copy.copy(x)
def test_copy_reduce_ex(self):
return (C, (obj.foo,))
x = C(42)
self.assertRaises(TypeError, copy.deepcopy, x)
- copyreg.pickle(C, pickle_C, C)
+ copy_reg.pickle(C, pickle_C, C)
y = copy.deepcopy(x)
def test_deepcopy_reduce_ex(self):
-import copyreg
+import copy_reg
import unittest
from test import test_support
class CopyRegTestCase(unittest.TestCase):
def test_class(self):
- self.assertRaises(TypeError, copyreg.pickle,
+ self.assertRaises(TypeError, copy_reg.pickle,
C, None, None)
def test_noncallable_reduce(self):
- self.assertRaises(TypeError, copyreg.pickle,
+ self.assertRaises(TypeError, copy_reg.pickle,
type(1), "not a callable")
def test_noncallable_constructor(self):
- self.assertRaises(TypeError, copyreg.pickle,
+ self.assertRaises(TypeError, copy_reg.pickle,
type(1), int, "not a callable")
def test_bool(self):
e = ExtensionSaver(code)
try:
# Shouldn't be in registry now.
- self.assertRaises(ValueError, copyreg.remove_extension,
+ self.assertRaises(ValueError, copy_reg.remove_extension,
mod, func, code)
- copyreg.add_extension(mod, func, code)
+ copy_reg.add_extension(mod, func, code)
# Should be in the registry.
- self.assert_(copyreg._extension_registry[mod, func] == code)
- self.assert_(copyreg._inverted_registry[code] == (mod, func))
+ self.assert_(copy_reg._extension_registry[mod, func] == code)
+ self.assert_(copy_reg._inverted_registry[code] == (mod, func))
# Shouldn't be in the cache.
- self.assert_(code not in copyreg._extension_cache)
+ self.assert_(code not in copy_reg._extension_cache)
# Redundant registration should be OK.
- copyreg.add_extension(mod, func, code) # shouldn't blow up
+ copy_reg.add_extension(mod, func, code) # shouldn't blow up
# Conflicting code.
- self.assertRaises(ValueError, copyreg.add_extension,
+ self.assertRaises(ValueError, copy_reg.add_extension,
mod, func, code + 1)
- self.assertRaises(ValueError, copyreg.remove_extension,
+ self.assertRaises(ValueError, copy_reg.remove_extension,
mod, func, code + 1)
# Conflicting module name.
- self.assertRaises(ValueError, copyreg.add_extension,
+ self.assertRaises(ValueError, copy_reg.add_extension,
mod[1:], func, code )
- self.assertRaises(ValueError, copyreg.remove_extension,
+ self.assertRaises(ValueError, copy_reg.remove_extension,
mod[1:], func, code )
# Conflicting function name.
- self.assertRaises(ValueError, copyreg.add_extension,
+ self.assertRaises(ValueError, copy_reg.add_extension,
mod, func[1:], code)
- self.assertRaises(ValueError, copyreg.remove_extension,
+ self.assertRaises(ValueError, copy_reg.remove_extension,
mod, func[1:], code)
# Can't remove one that isn't registered at all.
- if code + 1 not in copyreg._inverted_registry:
- self.assertRaises(ValueError, copyreg.remove_extension,
+ if code + 1 not in copy_reg._inverted_registry:
+ self.assertRaises(ValueError, copy_reg.remove_extension,
mod[1:], func[1:], code + 1)
finally:
e.restore()
# Shouldn't be there anymore.
- self.assert_((mod, func) not in copyreg._extension_registry)
- # The code *may* be in copyreg._extension_registry, though, if
+ self.assert_((mod, func) not in copy_reg._extension_registry)
+ # The code *may* be in copy_reg._extension_registry, though, if
# we happened to pick on a registered code. So don't check for
# that.
for code in 1, 0x7fffffff:
e = ExtensionSaver(code)
try:
- copyreg.add_extension(mod, func, code)
- copyreg.remove_extension(mod, func, code)
+ copy_reg.add_extension(mod, func, code)
+ copy_reg.remove_extension(mod, func, code)
finally:
e.restore()
# Ensure invalid codes blow up.
for code in -1, 0, 0x80000000L:
- self.assertRaises(ValueError, copyreg.add_extension,
+ self.assertRaises(ValueError, copy_reg.add_extension,
mod, func, code)
def test_slotnames(self):
- self.assertEquals(copyreg._slotnames(WithoutSlots), [])
- self.assertEquals(copyreg._slotnames(WithWeakref), [])
+ self.assertEquals(copy_reg._slotnames(WithoutSlots), [])
+ self.assertEquals(copy_reg._slotnames(WithWeakref), [])
expected = ['_WithPrivate__spam']
- self.assertEquals(copyreg._slotnames(WithPrivate), expected)
- self.assertEquals(copyreg._slotnames(WithSingleString), ['spam'])
+ self.assertEquals(copy_reg._slotnames(WithPrivate), expected)
+ self.assertEquals(copy_reg._slotnames(WithSingleString), ['spam'])
expected = ['eggs', 'spam']
expected.sort()
- result = copyreg._slotnames(WithInherited)
+ result = copy_reg._slotnames(WithInherited)
result.sort()
self.assertEquals(result, expected)
class TestStdlibRenames(unittest.TestCase):
- renames = {'copy_reg': 'copyreg', 'Queue': 'queue',
+ renames = {'Queue': 'queue',
'SocketServer': 'socketserver',
'ConfigParser': 'configparser',
'repr': 'reprlib'}
compileall Force "compilation" of all .py files in a directory.
configparser Configuration file parser (much like windows .ini files)
copy Generic shallow and deep copying operations.
-copyreg Helper to provide extensibility for pickle/cPickle.
+copy_reg Helper to provide extensibility for pickle/cPickle.
csv Read and write files with comma separated values.
dbhash (g)dbm-compatible interface to bsdhash.hashopen.
dircache Sorted list of files in a dir, using a cache.
/* As the name says, an empty tuple. */
static PyObject *empty_tuple;
-/* copyreg.dispatch_table, {type_object: pickling_function} */
+/* copy_reg.dispatch_table, {type_object: pickling_function} */
static PyObject *dispatch_table;
/* For EXT[124] opcodes. */
-/* copyreg._extension_registry, {(module_name, function_name): code} */
+/* copy_reg._extension_registry, {(module_name, function_name): code} */
static PyObject *extension_registry;
-/* copyreg._inverted_registry, {code: (module_name, function_name)} */
+/* copy_reg._inverted_registry, {code: (module_name, function_name)} */
static PyObject *inverted_registry;
-/* copyreg._extension_cache, {code: object} */
+/* copy_reg._extension_cache, {code: object} */
static PyObject *extension_cache;
-/* For looking up name pairs in copyreg._extension_registry. */
+/* For looking up name pairs in copy_reg._extension_registry. */
static PyObject *two_tuple;
static PyObject *__class___str, *__getinitargs___str, *__dict___str,
}
/* Get a reduction callable, and call it. This may come from
- * copyreg.dispatch_table, the object's __reduce_ex__ method,
+ * copy_reg.dispatch_table, the object's __reduce_ex__ method,
* or the object's __reduce__ method.
*/
__reduce__ = PyDict_GetItem(dispatch_table, (PyObject *)type);
INIT_STR(copyreg);
INIT_STR(dispatch_table);
- if (!( copyreg = PyImport_ImportModule("copyreg")))
+ if (!( copyreg = PyImport_ImportModule("copy_reg")))
return -1;
/* This is special because we want to use a different
* If this fails, the import of this module will fail because an
* exception will be raised here; should we clear the exception?
*/
- copyreg = PyImport_ImportModuleNoBlock("copyreg");
+ copyreg = PyImport_ImportModuleNoBlock("copy_reg");
if (copyreg != NULL) {
PyObject *func, *pickler;
/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
- We fall back to helpers in copyreg for:
+ We fall back to helpers in copy_reg for:
- pickle protocols < 2
- calculating the list of slot names (done only once per class)
- the __newobj__ function (which is used as a token but never called)
static PyObject *copyreg_str;
if (!copyreg_str) {
- copyreg_str = PyString_InternFromString("copyreg");
+ copyreg_str = PyString_InternFromString("copy_reg");
if (copyreg_str == NULL)
return NULL;
}
!PyList_Check(slotnames))
{
PyErr_SetString(PyExc_TypeError,
- "copyreg._slotnames didn't return a list or None");
+ "copy_reg._slotnames didn't return a list or None");
Py_DECREF(slotnames);
slotnames = NULL;
}
projects / python / commitdiff