Python documentator, 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 не имеет возможности узнать, что происходит там. Как я могу сказать, используя комментарии?

В случае 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 specificaly и питона documentators в общем?

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 будет использовать это, чтобы определить, какие методы доступны на SomeObject.

EDIT:

После небольшого теста я предполагаю, что это должно работать (что является довольно удивительным).