12.2. copyreg — pickle サポート関数を登録する

ソースコード: Lib/copyreg.py

---

copyreg モジュールは、特定のオブジェクトを pickle する際に使われる関数を定義する手段を提供します。 pickle モジュールと copy モジュールは、オブジェクトを pickle/コピーする場合にそれらの関数を使用します。このモジュールは、クラスでないオブジェクトコンストラクタに関する設定情報を提供します。そのようなコンストラクタは、ファクトリ関数か、クラスインスタンスかもしれません。

copyreg.constructor(object)

object を有効なコンストラクタであると宣言します。 object が呼び出し可能でなければ(したがってコンストラクタとして有効でなければ)、 TypeError を発生します。

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

function が型 type のオブジェクトに対する”リダクション”関数として使われるように宣言します。function は文字列か、2要素または3要素を含んだタプルを返さなければなりません。

オプションの constructor パラメータが与えられた場合、それは呼び出し可能オブジェクトで、 function が返した引数のタプルとともに pickle 化時に呼ばれてオブジェクトを再構築するために使われます。 object がクラスの場合、または constructor が呼び出し可能でない場合には TypeError が発生します。

function と constructor に期待されるインタフェースについての詳細については pickle モジュールを参照してください。 pickler オブジェクトまたは pickle.Pickler のサブクラスの dispatch_table 属性を、リダクション関数の宣言のために使うこともできるということは覚えておいてください。

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