Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】__base__::__reduce_ex__()メソッドの使い方

__reduce_ex__メソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__reduce_ex__メソッドは、Pythonオブジェクトの直列化(シリアライズ)を制御するメソッドです。pickleモジュールがオブジェクトを保存・転送・再構築する際に自動的に呼び出されます。このメソッドは、オブジェクト復元に必要な情報を定義します。

具体的には、指定されたプロトコルバージョンに基づき、オブジェクトのクラス、初期化引数、状態データを含むタプルを返します。カスタムオブジェクトの状態を正確に保存・復元することを可能にします。

__reduce__メソッドの拡張版で、プロトコルバージョンを引数として受け取れる点が特徴です。__reduce__より__reduce_ex__が定義されていれば、pickleモジュールはそちらを優先します。開発者は、独自のクラスの直列化挙動をカスタマイズする際に、このメソッドをオーバーライドします。

構文(syntax)

1class MyClass:
2    def __init__(self, arg):
3        self.arg = arg
4
5    def __reduce_ex__(self, protocol):
6        return (self.__class__, (self.arg,))

引数(parameters)

self, protocol: int, /

  • self: メソッドを呼び出すオブジェクト自身
  • protocol: int: シリアライズに使用するプロトコルバージョンを指定する整数

戻り値(return)

tuple

このメソッドは、オブジェクトをpickle化(シリアライズ)する際に、そのオブジェクトを復元するために必要な情報を含むタプルを返します。

関連コンテンツ