Получение docstring из функции

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

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

Как получить доступ к docstring?

Ответ 1

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

help(my_func)

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

my_func.__doc__

Ответ 2

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

Ответ 3

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

my_func?

или

?my_func

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

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

my_func??

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