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

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

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

作成日: 更新日:

基本的な使い方

__subclasshook__メソッドは、Pythonの抽象基底クラス(ABC)において、あるクラスがそのABCのサブクラスであると動的に判断するために実行するメソッドです。通常、クラスが別のクラスのサブクラスであると見なされるのは、明示的にそのABCを継承した場合です。しかし、この__subclasshook__メソッドを定義すると、継承関係がなくても、特定の条件(例えば、特定のメソッドを持っているかなど)を満たす既存のクラスを、そのABCのサブクラスとして扱えるようになります。

これは、既存のコードを修正することなく、特定のインターフェースや「型」の要件を満たしているかをチェックしたい場合に非常に役立ちます。例えば、collections.abcモジュールが提供するAwaitableのような抽象基底クラスは、このフックを利用して、明示的な継承なしに、そのクラスが待機可能な(awaitableな)オブジェクトであるかどうかを判断します。

issubclass()関数などが内部でこのフックを利用し、開発者が定義したルールに基づいて型チェックを行います。このメソッドはクラスメソッドとして定義され、チェック対象のクラスを引数に取ります。戻り値は、サブクラスと見なす場合はTrue、見なさない場合はFalse、そしてこのフックで判断できない場合はNotImplementedを返します。これにより、柔軟な型システムを構築できます。

構文(syntax)

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

引数(parameters)

cls: type, subclass: type

  • cls: type: 比較対象となるクラス自身
  • subclass: type: 検査対象となるクラス

戻り値(return)

bool | NotImplementedType

__subclasshook__ メソッドは、クラスが特定の抽象基底クラス (Abstract Base Class: ABC) のサブクラスとして適切かどうかを判断するために使用されます。このメソッドは、True を返すとクラスがサブクラスであるとみなされ、False を返すとサブクラスではないとみなされます。NotImplemented を返した場合は、Python のデフォルトのサブクラスチェック処理に委ねられます。

関連コンテンツ

関連プログラミング言語