Получение строки документа из функции

Question

У меня есть следующая функция:

def my_func():
    """My docstring is both funny and informative"""
    pass

Как получить доступ к строке документации?

Answer 1

Интерактивно вы можете отобразить его с помощью

help(my_func)

Или из кода вы можете получить его с помощью

my_func.__doc__

Answer 2

Вы также можете использовать inspect.getdoc. Он очищает __doc__, нормализуя табуляции в пробелах и смещая влево тело документа, чтобы удалить общие начальные пробелы.

Answer 3

На ноутбуке ipython или jupyter вы можете использовать все вышеперечисленные способы, но я иду с

my_func?

или

?my_func

для быстрого суммирования как сигнатуры метода, так и строки документа.

Я избегаю использования

my_func??

(как прокомментировал @rohan) для строки документации и используйте ее только для проверки исходного кода