Документация Python неофициальный перевод
Содержание страницы

copyreg – Регистрация вспомогательных функций picklecopyreg – Register pickle support functions

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


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

copyreg.constructor(object)

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

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

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

Необязательный параметр constructor, если указан, представляет собой вызываемый объект, который можно использовать для восстановления объекта при вызове с кортежем аргументов, возвращённых function во время упаковки (pickling). Возбуждается TypeError, если constructor не является вызываемым.

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

ПримерExample

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

>>> import copyreg, copy, pickle
>>> class C:
...     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...