PyCharmは：どのようにドキュメントに：RTYPE：発電

Question

を返す関数のために、私はNodeの発電機を返す:rtype:ドキュメンテーション文字列パラメータを文書化しよう：

def __iter__(self): 
    """iterate over node children 

    :rtype: ??? 
    """ 
    for node in self.children.itervalues(): 
     yield node 

何:rtype:をすることになっていますか？ generator of Nodeは機能していないようです。

Answer 1

officialのマニュアルに記載されているように、タイプself.childrenの下に:typeを使用するとヒントが得られます。これにより、定義された型を使用してこの変数をどこでも使用できます。次に例を示します。

class Node(object): 
    def foo(self): 
     pass 


class Iterator(object): 
    def __init__(self): 
     self.children = '' 
     """:type: dict[str, Node]""" # <<< define type of self.children after assigning the value 

    def __iter__(self): 
     for node in self.children.itervalues(): 
      yield node 


if __name__ == '__main__': 
    for node in Iterator(): 
     node. # <<< type hinting will work here 

しかし、あなたは__iter__メソッドの戻り値の型を設定することを好む場合は、次の構文を使用してそれを行うことができます。

def __iter__(self): 
    """ 
    :rtype: collections.Iterable[Node] 
    """ 
    for node in self.children.itervalues(): 
     yield node 

私は最初のソリューションを好むだろうしかし、。