copyreg — 注册 pickle 支持函数

源代码: Lib/copyreg.py


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

copyreg.constructor(object)

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

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

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

constructor_ob 参数是一个遗留特性,现在被忽略,但如果传递,它必须是可调用的。

请注意,pickler 对象或 pickle.Pickler 子类的 dispatch_table 属性也可以用于声明归约函数。

示例

下面的示例将展示如何注册一个 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...