PyCharm の型ヒント

型ヒントを追加する

PyCharm は PEP 484(英語) でサポートされている型の追加方法をすべてサポートしていますが、インテンションアクションを通じて型ヒントを使用するのが最も便利です。使用するインタープリターに応じて、型はアノテーション（Python 3）またはコメント（Python 2）として追加されます。

サンプル	インテンションアクション	アノテーションの結果コード (Python 3)
変数
関数
クラス属性

サンプル	インテンションアクション	コメントの結果コード (Python 2)
変数
関数
クラス属性

Python スタブを使用して、変数、関数、クラスフィールドの型を指定することもできます。

アノテーションを使用して戻り値の型を指定する

Python 3 アノテーションを使用して、関数の戻り値の型にアノテーションを付けることができます。PyCharm が自動的に戻り値のアノテーションを挿入し、必要に応じて型を調整できます。

1. 関数名にキャレットを置き、Alt+Enter を押します。

2. 開いたインテンションアクションのリストで、アノテーションを使用して戻り値の型を指定するを選択します。

コメントを変換する

コメントベースの型ヒントの場合、PyCharm は、コメントベースの型ヒントを変数アノテーションに変換できるインテンションアクションを提案します。このインテンションには変数アノテーションに変換するという名前があり、次のように動作します。

型ヒントを検証する

型ヒントを適用するときはいつでも、PyCharm は、サポートされている PEP に従ってタイプが正しく使用されているかどうかをチェックします。使用箇所エラーがある場合、対応する警告が表示され、推奨されるアクションが提案されます。以下は検証の例です。

検証エラー	推奨アクション
型宣言の重複。	いずれかの型宣言を削除します。
型宣言の引数の数は、関数の引数の数とは異なります。	引数の数を調整します。
アンパックを伴う型コメントは、対応するターゲットと一致しません。	ターゲットフォーマットをチェックし、それに応じてタイプコメントを変更してください。
Callable パラメーターの構文が正しくありません。	推奨フォーマットを使用し、必要な角括弧を追加して Callable パラメーターをラップします。
代入式に予期しない型があります。	予想されるパターンに合うようにタイプを揃えます。
Final 変数に値を代入します。	Final とアノテーションが付けられた変数を変更することはできません。変数の型を変更することを検討してください。
Final アノテーションが付けられたクラスを継承します。	Final アノテーションを持つクラスを継承することはできません。別のクラスを作成することを検討してください。
@final で装飾されたメソッドのオーバーライド。	@final で装飾されたメソッドをオーバーライドすることはできません。別のメソッドを定義することを検討してください。
関数引数の型が正しくありません。	リストの代わりに辞書を foo() 関数に渡します。
TypedDict タイプのキーに間違ったタイプの値を割り当てる。	year の値を int として指定します。 add_movie({'title': 'Blade Runner', 'year': 1982})
TypedDict タイプで間違ったキーを使用する:	型定義で指定されているようにキーを割り当てます。 add_movie({'title': 'Blade Runner', 'year': 1982})
装飾された関数の不適切な使用。PyCharm は、デコレーターのタイプに基づいて、装飾された関数のタイプを検証します。	必要に応じて、関数 return を使用するデコレーターまたはステートメントを変更します。

# type: ignore または # noqa コメントを追加して、型検証の警告を抑制したり、欠落しているインポートステートメントを無視したりできます。

Python スタブ

Python スタブファイルを使用すると、Python 3 構文を使用して型ヒントを指定できます。これらのヒントは、インタープリターで使用されている Python バージョンに関係なく、Python ファイルで利用できます。

次の例では、スタブファイル (stubs.pyi) からの sample_function の型ヒントが Python ファイル (stubs.py) で使用可能になります。

スタブアナログが検出されたパッケージを使用している場合は、次のメッセージが表示されます。

スタブパッケージをインストールし、このメッセージを無視して現在インストールされているパッケージで作業を続行するか、プロジェクト設定でこの種のインスペクションを無効にすることができます。

Typeshed を使用する

Typeshed(英語) は、標準の Python ライブラリとさまざまなパッケージの型アノテーションが付いたファイルのセットです。Typeshed スタブは、型ヒントで定義された Python クラス、関数、モジュールの定義を提供します。PyCharm は、この情報を使用して、コード補完、インスペクション、その他のコードインサイト機能を向上させます。

PyCharm には Typeshed(英語) スタブがバンドルされています。使用可能な Typeshed スタブのリストは、ノード外部ライブラリ | <Python インタープリター> | Typeshed スタブのプロジェクトビューに表示されます。

Python スケルトンリポジトリ https://github.com/JetBrains/python-skeletons(英語) は廃止予定です。