docstring のレガシー型構文
PyCharm は docstring を使用した Python の型指定のレガシーアプローチをサポートしています。 その際、サポートされているフォーマットは次のとおりです。
必要な docstring 形式を選択するには、設定ダイアログの Python 統合ツールページを使用します。
Python の docstrings の型構文は、どの標準でも定義されていません。 そのため、PyCharm は次の表記法を提案します：
構文 | 説明 |
|---|---|
| 現在のスコープで表示されるクラス Foo |
| x.y モジュールのクラス Bar |
| Foo または Bar |
| Foo と Bar のタプル |
| Foo 要素のリスト |
| Foo から Bar への Dict |
| 汎用型 (T-Z は一般用に予約されています) |
| 上限を持つ汎用型 Foo |
| Foo は T でパラメーター化される |
| Baz を返す Foo と Bar の関数 |
| str から datetime への dicts のリスト (ネストされた引数) |
ローカル変数の型の指定
:type または @type docstring を使用して、期待されるローカル変数の型に関する情報を追加することを検討してください。
isinstance を使用して、予想されるローカル変数型を定義することもできます。
フィールドの型の指定
型ヒントを使用して、予想されるフィールド型を指定することができます。
また、クラスのドキュメント文字列内のフィールドの型を指定することもできます。
戻り値の型の指定
docstrings :rtype または @rtype を使用して、期待される戻り値の型を指定します。
:rtype: collections.Iterable[int] # return type：「items」はgeneratorまたはcollections.Iterable型、「a」はint型です。次のコードを参照してください：def my_iter(): global i for i in range(10): yield i items = my_iter() for a in items: print a:rtype: list[int] for my_iter # 戻り値の型：「a」は
int型です。次のコードを参照してください：def my_iter(): for i in range(10): yield i for a in my_iter(): print a
パラメーター型の指定
想定されるパラメーターの型に関する情報を追加することを検討してください。 この情報は docstring を使用して指定します。 選択した docstring の形式に応じて、異なる docstring を使用できます（例: :type、 @type、 Args）。 プロジェクト設定を使用して、docstring の形式（ ）を変更してください。
