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

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

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

作成日: 更新日:

基本的な使い方

__subclasshook__メソッドは、Pythonの抽象基底クラスにおいて、あるクラスが特定の抽象基底クラスのサブクラスであるかをカスタマイズして判定するために実行されるメソッドです。

抽象基底クラス(ABC)は、他のクラスが実装すべき機能の「型」や「契約」を定義するために利用されます。通常、あるクラスがABCのサブクラスであるかどうかは、issubclass()関数などを使って調べられます。Pythonは標準で、クラスの継承関係や、ABCで定義された抽象メソッドが全て実装されているかを確認して判定を行います。

しかし、__subclasshook__メソッドを抽象基底クラスに@classmethodデコレータを付けて実装すると、これらの標準的な判定方法の前に、あなた自身の独自のロジックでサブクラス関係を決定できるようになります。このメソッドは、判定対象のクラスを受け取り、そのクラスが抽象基底クラスのサブクラスとみなすべきであればTrueを、そうでない場合はFalseを返します。もし、このメソッドでは判定できない、あるいは判定すべきでない場合はNotImplementedを返します。NotImplementedが返されると、Pythonは通常のサブクラス判定ロジックに沿って、継承関係などを確認し、判定を続行します。

この機能を使うことで、例えば、特定の名前のメソッドや属性を持っているだけでサブクラスとみなすなど、より柔軟なサブクラス判定の仕組みを構築することが可能になります。

構文(syntax)

1import abc
2
3class MyAbstractClass(abc.ABC):
4    @classmethod
5    def __subclasshook__(cls, subclass):
6        # This method is called by issubclass(subclass, MyAbstractClass)
7        # It determines if 'subclass' should be considered a virtual subclass of 'cls'.
8        # Return True if 'subclass' satisfies the criteria for a virtual subclass.
9        # Return False if 'subclass' definitively does not satisfy the criteria.
10        # Return NotImplemented if this hook doesn't have an opinion on 'subclass'.
11        return NotImplemented

引数(parameters)

cls, C: type

  • cls: ClassDef: 呼び出し元のクラス自身
  • C: type: サブクラスかどうかをチェックしたい型

戻り値(return)

bool | NotImplementedType

このメソッドは、クラスが別のクラスのサブクラスであるかどうかを判断するために、型チェックシステムによって呼び出されます。戻り値は、サブクラス関係が真であれば True、偽であれば False、または不明な場合は NotImplemented となります。

関連コンテンツ

関連プログラミング言語