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

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

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

作成日: 更新日:

基本的な使い方

__class_getitem__メソッドは、Pythonの組み込み型であるdict(辞書)が、型ヒントにおいてジェネリック型として利用できるようにするメソッドです。これはPython 3.9から導入されました。

具体的には、このメソッドによってdict[キーの型, 値の型]という構文で、辞書がどのような型のキーと値を持つかを明示できるようになりました。例えば、dict[str, int]と記述することで、「この辞書は文字列をキーとし、整数を値として保持する」という情報を型チェッカーに伝えることができます。これにより、開発者はコードを読むだけでその辞書がどのようなデータを扱うのかを理解しやすくなります。

この機能は、コードの可読性を大幅に向上させ、MyPyなどの静的解析ツールが開発中に潜在的な型エラーを早期に発見する手助けをします。__class_getitem__は、実際の辞書オブジェクトを生成するものではなく、あくまでプログラムの実行前に型の一貫性を確認するための「型情報」を表現する目的で使われます。

以前は、同様のジェネリック型ヒントを記述するためにtypingモジュールからtyping.Dictをインポートする必要がありましたが、このメソッドのおかげで、組み込みのdict型自体を直接使って、より簡潔かつ直感的に型ヒントを記述できるようになりました。これにより、大規模なプロジェクトにおけるコードの品質と保守性の向上に貢献します。

構文(syntax)

1dict[KeyType, ValueType]

引数(parameters)

cls: type, item: typing.Any

  • cls: type: このメソッドが属するクラス自体を表します。
  • item: typing.Any: 辞書から取得したい要素のキーまたはスライスを指定します。

戻り値(return)

types.GenericAlias

このメソッドは、辞書型(dict)が型ヒントのコンテキストでサブスクリプト([])演算子でアクセスされた際に、その辞書の型を表すジェネリックエイリアス(GenericAlias)を返します。

関連コンテンツ