Python 文档，IDE 指导

Question

假设我有这样的功能：

def render(someobject):
 someobject. #here i expect IDE to know which class it is and autocompletion and other IDE functional will be available
 dorender()

在我的情况下，IDE 无法知道里面有什么。 如何使用 cmets 来判断？

如果是 PHP，我使用过类似的东西

/**
 * @param MyClass myobject
**/
function render($myobject){
  //by typing $myobject-> IDE already knows, that it should use $myobject as MyClass objec
  dorender()
}

另一个用例是当我知道时，在某些情况下某些代理会返回某些对象 IDE没有机会知道，但我肯定知道并想通过评论指定这一点，以帮助自己将来帮助IDE。

在 PHP 中使用 PhpStorm 我会执行以下操作：

$myobject=some_proxy()
/**
 * @var $my_object MyClass
**/
// in following code IDE will use $myobject as MyClass

如何使用 PyCharm 和 python 文档实现相同的行为？

Answer 1

使用docstring：

def render(someobject):
    """ This methods renders some object. """
    dorender()

更多信息可以在这里找到http://en.wikipedia.org/wiki/Docstring#Python

您可以使用自省来了解对象的方法、属性等：

dir(object)
help(object)

基于自省的自动补全和 IDE 集成是可能的，Python.org 网站上有更详细的信息：http://wiki.python.org/moin/IntegratedDevelopmentEnvironments

要找出someobject是什么，可以使用type或isinstance，见以下伪代码：

type(someobject)
if isinstance(someobject, ClassA):
    print "someobject is a ClassA variable"

Answer 2

我不确定它是否可以在 PyCharm 中工作（我不使用它） - 但是为 Python 3 添加了function annotations。

您可以将它们放入函数的定义中：

def render(someobject :ObjectClass):
    dorender()

也许 PyCharm 会使用它来定义某些对象上可用的方法。

编辑：

经过一个小测试，我想这应该可以工作（这非常棒）。