Как получить docstring функции программно?

Question

Docstring функции можно получить через атрибут __doc__. Это самый простой и прямой способ. Также существует вспомогательная функция из стандартной библиотеки, которая делает доступ более безопасным. Оба подхода используются на практике.

YeaHub · Accepted Answer

Python предоставляет несколько способов программного доступа к документации объектов.Прямой доступСамый простой вариант — использовать атрибут:def foo():
    """Example docstring"""
    pass

print(foo.__doc__)
Если docstring отсутствует, значение будет None.Использование inspectМодуль inspect предоставляет более удобный интерфейс:import inspect

inspect.getdoc(foo)
Этот способ:нормализует отступыкорректно работает с унаследованными docstringбезопаснее для сложных случаевГде это используетсяПолучение docstring важно для:автодокументацииCLI-инструментовфреймворковинтроспекции в рантаймеКраткий выводDocstring можно получить напрямую через __doc__, но для надёжной работы и сложных сценариев предпочтительнее использовать inspect.getdoc.