copyreg — Регистрация функций поддержки pickle

Исходный код: Lib/copyreg.py

Модуль copyreg предоставляет способ определения функций, используемых при сериализации (pickling) определенных объектов. Модули pickle и copy используют эти функции при сериализации/копировании этих объектов. Модуль предоставляет информацию о конфигурации конструкторов объектов, которые не являются классами. Такие конструкторы могут быть функциями-фабриками или экземплярами классов.

copyreg.constructor(object)

Объявляет, что object является корректным конструктором. Если object не является вызываемым (и, следовательно, не является корректным конструктором), генерируется исключение TypeError.

copyreg.pickle(type, function, constructor=None)

Объявляет, что function должна использоваться как функция «сокращения» для объектов типа type. function должна возвращать строку или кортеж, содержащий два или три элемента.

Необязательный параметр constructor, если он указан, является вызываемым объектом, который может быть использован для реконструкции объекта при вызове с кортежем аргументов, возвращённым function во время сериализации. Если object является классом или constructor не является вызываемым, будет сгенерировано исключение TypeError.

См. модуль pickle для получения дополнительной информации о требуемом интерфейсе для function и constructor. Обратите внимание, что атрибут dispatch_table объекта-сериализатора или подкласса pickle.Pickler также может использоваться для объявления функций сокращения.

1. Пример

В примере ниже показано, как зарегистрировать функцию pickle и как она будет использована:

>>> 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...