Как заставить PyCharm получать подсказки типов из определения функции и заполнять значения типов в строках документов? - PullRequest
2 голосов
/ 31 мая 2019

Я всегда использую подсказки типов в определениях функций, например:

def foo(a: int, b: str) -> bool:
    pass

Когда я использую генератор строк документации PyCharm для создания строк документации в моем коде, я получаю следующее:

def foo(a: int, b: str) -> bool:
    """
    :param a: 
    :type a: 
    :param b: 
    :type b: 
    """
    pass

Как видите, значения типов, которые я определил в самой функции, не были распознаны PyCharm, и я должен снова записать их в строку документации. Как я могу заставить PyCharm автоматически сгенерировать что-то подобное для меня (прочитайте значения типов из первой строки и вставьте их в строку документации):

def foo(a: int, b: str) -> bool:
    """
    :param a:
    :type a: int
    :param b:
    :type b: str
    :rtype: bool
    """
    pass

1 Ответ

0 голосов
/ 31 мая 2019

Перейти к Settings -> Editor -> Intentions.Там, под категорией Python, поставьте галочку в поле Specify type for reference in docstring.

. После активации вы можете использовать отладчик и его функциональность: Insert documentation string stub для заполнения строки документации функции.(Обратите внимание, что вам нужно будет активировать опцию Collect runtime information for code insight, расположенную Settings -> Build, Execution, Deployment -> Python Debugger)

Процесс немного подробный, поэтому я дам ссылку на официальное руководство PyCharm по этому поводу: https://www.jetbrains.com/help/pycharm/using-docstrings-to-specify-types.html

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...