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