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

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

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

作成日: 更新日:

基本的な使い方

__init_subclass__メソッドは、クラスがサブクラス化された際に自動的に呼び出され、サブクラスの定義時に特定の処理を実行するメソッドです。Pythonの組み込み例外の最上位の基底クラスであるBaseExceptionに所属しており、全ての例外クラスがBaseExceptionのサブクラスとして定義されるため、このメソッドを適切に利用することで、カスタム例外クラスの生成時に共通の振る舞いや属性を付与することができます。

具体的には、class MyException(BaseException): passのように新しいクラスが定義されると、その定義が完了した直後にBaseException.__init_subclass__(cls)が呼び出されます。ここでcls引数には、新しく作成されたサブクラス(この例ではMyException)自身が渡されます。開発者はこのメソッドをオーバーライドすることで、サブクラスが持つべき特定の属性の追加、サブクラスの自動登録、あるいはサブクラスの定義に対する検証などを行うことが可能です。例えば、全てのカスタム例外クラスに特定のログ機能を自動的に組み込むといった用途が考えられます。

このメソッドをオーバーライドする際は、必ずsuper().__init_subclass__(**kwargs)を呼び出して、親クラスの同名のメソッドが持つ初期化処理も実行するようにしてください。これにより、継承チェーン全体での適切な初期化が保証されます。__init_subclass__は、クラス作成時のフックを提供し、サブクラスの挙動をより柔軟に制御するための強力なメカニズムを提供します。

構文(syntax)

1class MyCustomException(BaseException):
2    def __init_subclass__(cls, **kwargs):
3        super().__init_subclass__(**kwargs)

引数(parameters)

cls: type, **kwargs

  • cls: type: このメソッドが呼び出されたクラス自身
  • **kwargs: dict: その他のキーワード引数

戻り値(return)

戻り値なし

戻り値はありません

関連コンテンツ