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

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

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

作成日: 更新日:

基本的な使い方

__class_getitem__メソッドは、Pythonの型ヒント機能において、ジェネリック型をサポートする振る舞いを実行するメソッドです。このメソッドは、組み込み型であるlistがどのような型の要素を格納するかを、型ヒントとして明示的に指定する能力を提供します。

Python 3.9以降では、list[int]のように角括弧([])を使って、リストが保持する要素の型を直接記述できるようになりました。例えば、list[str]と記述することで、このリストが文字列型の要素のみを格納する意図であることを示すことができます。この記法が使われる際に、Pythonインタープリタは内部的にlistクラスの__class_getitem__メソッドを呼び出します。

このメソッドは、実際の実行時のリストの動作を変更するものではなく、主に静的型チェッカーや統合開発環境(IDE)がコードの型安全性検証を行う際に利用されます。コードの記述時に型の不一致を検出することで、実行時エラーの削減やデバッグ時間の短縮に貢献します。

以前は、このようなジェネリック型ヒントを記述するためにtypingモジュールからtyping.List[int]のように記述する必要がありましたが、__class_getitem__メソッドの導入により、組み込み型に直接ジェネリック型ヒントを適用することが可能になり、より直感的で簡潔なコード記述が実現されました。システム開発において、型情報を明確にすることは、コードの可読性や保守性を高める上で非常に重要です。

構文(syntax)

1list[int]

引数(parameters)

cls: type, item: Any

  • cls: type: このメソッドを呼び出しているクラス自身を表します。
  • item: Any: リストから取得したい要素のインデックスやスライスを指定します。

戻り値(return)

types.GenericAlias

__class_getitem__ メソッドは、型ヒントの文脈でリストの要素の型を指定するために使用される types.GenericAlias オブジェクトを返します。これは、例えば list[int] のようにリストの型を具体的に示す際に内部的に利用されます。

関連コンテンツ