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. Как объявить docstring для переменной python? Я знаю о :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:

test = my() # type: dict 

Примеры автозаполнения в PyCharm:

Answer 2

Я не думаю, что вы можете сделать это через docstring, но есть механизм, называемый annotation. Вы можете добавить любое выражение, которое вы хотите использовать, после двоеточия : и самому объявлению функции, используя стрелку ->. Например:

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

Я добавил здесь параметр ввода для целей иллюстрации. В этом случае str и MyClass являются объектами, представляющими ожидаемые типы ввода и возврата соответственно. Они никогда не используются в вашем коде напрямую, просто спрятаны в атрибуте func_annotations для конечных пользователей, которые заботятся о таких вещах (например, редакторы).