これは既にサポートされていない古いバージョンの Python のドキュメントです。 是非 Python をアップグレードし、このドキュメントを読みましょう: 現在の安定板リリースの Python ドキュメント.

# `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要素を含んだタプルを返さなければなりません。

  The optional constructor parameter, if provided, is a callable object which can be used to reconstruct the object when called with the tuple of arguments returned by function at pickling time. A `TypeError` is raised if the constructor is not callable.

  function と constructor に期待されるインターフェースについての詳細については `pickle` モジュールを参照してください。 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...