11.3. copy_reg — Register pickle support functions

Nota

The copy_reg module has been renamed to copyreg in Python 3. The 2to3 tool will automatically adapt imports when converting your sources to Python 3.

The copy_reg module offers a way to define functions used while pickling specific objects. The pickle, cPickle, and copy modules use those functions when pickling/copying those objects. The module provides configuration information about object constructors which are not classes. Such constructors may be factory functions or class instances.

copy_reg.constructor(object)

Declara object para ser um construtor válido. Se object não puder ser chamado (e, portanto, não for válido como um construtor), gera TypeError.

copy_reg.pickle(type, function[, constructor])

Declares that function should be used as a “reduction” function for objects of type type; type must not be a “classic” class object. (Classic classes are handled differently; see the documentation for the pickle module for details.) function should return either a string or a tuple containing two or three elements.

O parâmetro opcional constructor, se fornecido, é um objeto que pode ser chamado, que pode ser usado para reconstruir o objeto quando chamado com a tupla de argumentos retornados por function no tempo de decapagem. TypeError será gerado se object for uma classe ou constructor não for chamado.

See the pickle module for more details on the interface expected of function and constructor.

11.3.1. Exemplo

O exemplo abaixo gostaria de mostrar como registrar uma função de pickle e como ela será usada:

>>> import copy_reg, 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,)
...
>>> copy_reg.pickle(C, pickle_c)
>>> c = C(1)
>>> d = copy.copy(c)
pickling a C instance...
>>> p = pickle.dumps(c)
pickling a C instance...