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

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

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

作成日: 更新日:

基本的な使い方

__subclasshook__メソッドは、Pythonの抽象基底クラス(ABC)において、あるクラスがそのABCのサブクラスであるかどうかをカスタムで判断するために使用される、特別なクラスメソッドです。

通常、クラスがABCのサブクラスとして認識されるには、そのABCを明示的に継承するか、あるいはABCで定義されているすべての抽象メソッドを実装する必要があります。しかし、既存のクラスが既に特定の振る舞い(メソッド)を持っているにもかかわらず、特定のABCを継承していない場合でも、そのクラスをABCのサブクラスとして扱いたいケースがあります。このような状況で__subclasshook__が非常に有用です。

このメソッドをABC内に定義すると、Pythonのissubclass()関数が呼び出された際に、継承関係や抽象メソッドの実装状況よりも優先して、開発者が定義したカスタムルールに基づいてサブクラス判定を行うことができます。例えば、Pythonの標準ライブラリにあるcollections.Sized抽象基底クラスでは、__subclasshook__を使って、たとえSizedを継承していなくても__len__メソッドを持つすべてのクラスをSizedのサブクラスとして認識するようにしています。これにより、リストや文字列のような組み込み型も、Sizedの要件を満たすものとして適切に扱われるのです。

__subclasshook__はクラスメソッドとして実装され、判定対象のクラスを引数として受け取ります。そして、判定ロジックに基づいてTrueを返せばサブクラスとして認識され、Falseを返せばサブクラスではないと判定されます。もしNotImplementedを返した場合は、通常のPythonのサブクラス判定機構に処理が委ねられます。この機能により、開発者は既存のコードベースに影響を与えることなく、より柔軟で動的な型チェックやポリモーフィズムを実現し、設計の自由度を高めることができます。

構文(syntax)

1import abc
2
3class MyAbstractBaseClass(abc.ABC):
4    @classmethod
5    def __subclasshook__(cls, other_class):
6        if hasattr(other_class, 'required_method') and callable(getattr(other_class, 'required_method')):
7            return True
8        return NotImplemented

引数(parameters)

cls: type, subclass: type

  • cls: type: 比較対象のクラス自身
  • subclass: type: 検査対象のサブクラス

戻り値(return)

bool または NotImplemented

このメソッドは、サブクラスとして有効かどうかを判定し、その結果を真偽値 (True/False) で返します。サブクラスとして無効な場合は NotImplemented を返します。

関連コンテンツ

関連プログラミング言語