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

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

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

作成日: 更新日:

基本的な使い方

__subclasshook__メソッドは、Pythonにおいて、issubclass()関数やisinstance()関数が、あるクラスが別のクラスのサブクラスであるかどうかを判定する際に利用される特別なメソッドです。通常、サブクラスであるかどうかは明示的な継承関係によって判断されますが、このメソッドを使用することで、たとえ直接的な継承関係がなくても、特定の条件を満たすクラスを「仮想的なサブクラス」として認識させることが可能になります。

主に抽象基底クラス (ABC: Abstract Base Class) を定義する際に役立ちます。ABCは、その抽象的なメソッドの実装を子クラスに強制しますが、__subclasshook__を用いると、明示的にABCを継承していなくても、要求されるメソッドを実装しているクラスを、そのABCのサブクラスであるかのように扱えます。

このメソッドは判定対象のクラスを引数として受け取り、サブクラスと見なすべき場合にTrueを、そうでない場合にFalseを返します。もし通常のサブクラス判定ロジックに委ねたい場合はNotImplementedを返します。これにより、クラス間の関係性を継承だけでなく、振る舞い(実装されているメソッドなど)に基づいて柔軟に定義できるようになり、より疎結合で汎用的なプログラム設計を促進します。

構文(syntax)

1import abc
2
3class MyAbstractBaseClass(abc.ABC):
4    @classmethod
5    def __subclasshook__(cls, subclass_candidate):
6        return NotImplemented

引数(parameters)

cls: type, C: type

  • cls: type: このメソッドが呼び出されるクラス自身
  • C: type: 比較対象となるクラス

戻り値(return)

typing.Union[bool, type(NotImplemented)]

subclasshook メソッドは、クラスの継承関係をカスタマイズするために使用されます。このメソッドは、サブクラスであると判断された場合に True を、そうでない場合に False を返します。また、継承関係を判断できない場合は NotImplemented を返します。

関連コンテンツ