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

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.