copyreg — 注册 pickle 支持函数

源代码: Lib/copyreg.py


copyreg 模块提供了一种方法,可用于定义在序列化特定对象时使用的函数。picklecopy 模块在序列化/复制这些对象时会使用这些函数。该模块提供了关于非类的对象构造器的配置信息。这种构造器可以是工厂函数或类实例。

copyreg.constructor(object)

声明 object 是一个有效的构造器。如果 object 不可调用(因此不是有效的构造器),则会引发 TypeError

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

声明 function 应当被用作 type 类型对象的“缩减”函数。function 必须返回一个字符串或一个包含两到六个元素的元组。有关 function 接口的更多详细信息,请参阅 dispatch_table

constructor_ob 参数是一项遗留特性,现已被忽略,但如果传入,则必须是可调用对象。

请注意,pickle 化工具对象的 dispatch_table 属性或 pickle.Pickler 的子类也可用于声明缩减函数。

示例

以下示例将演示如何注册一个 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...