Python。変数のヒント

Question

私はPyCharmをエディタとして使用しています。例えば、私は次の機能があります。

def get_instance(): 
    # method without doc sctring in some module 
    # returns instance of MyClass 
    return some_var 

をそして私はget_instance()を呼び出し、二番目のファイルがあります：値のデータの型を定義するためにどのように私ができる

var = get_instance() 

を？私は変数のオートコンプリートを使いたい。

phpの例では、それはこのようになります。この後

/** @var MyClass $var */ 
$var = getInstance(); 

私は$varのすべてのメソッドとプロパティを参照してくださいになります。 Python変数のdocstringを宣言するには？私は:typeと:rtypeについて知っていますが、私は特定の変数の型を宣言する必要がある場合？いくつかのタイプを宣言できますか？私は何をすべきか？

参考：get_instance()で変更することはできません。

Answer 1

クラスの説明プロパティと同じ方法で実行できます。ここでは例：

from example_module import MyClass 

var = get_instance() 
""" 
:type var: MyClass 
""" 

また、あなたがこのようなインポートせずに説明を使用することができます。第二の方法

var = get_instance() 
""" 
:type var: example_module.MyClass 
""" 

PEP 484を使用している：Pycharmでオートコンプリートの

test = my() # type: dict 

例：

を

Answer 2

私はdocstringでこれを行うことはできませんが、annotationというメカニズムがあります。コロン:に続くパラメータに任意の式を追加し、矢印->を使用して関数宣言自体に追加することができます。例：

def getInstance(param: str) -> MyClass 
    return some_var 

ここでは、図の目的で入力パラメータを追加しました。この場合、strとMyClassはそれぞれ予想される入力と戻り値の型を表すオブジェクトです。それらはあなたのコードで直接使用されることはありません。そのようなことを気にするエンドユーザーのために（編集者のような）func_annotations属性に隠れてしまいました。