Как получить справку в Python имея только консоль?

🔸 Основная справка

python3 -h

Команда вводится в консоль. Даёт информацию по флагам и переменным интерпретатора.

🔸 Справка по объектам

Сначала нужно зайти в REPL (интерактивная консоль Python) и там вводить такой код

>>> import some
>>> help(some)

Функция help() достаёт докстринги и распечатывает в консоль. Это самый очевидный способ получить справку по объекту не выходя из консоли. Но в такой метод нельзя передать директивы, например import или def

>>> help(import)
SyntaxError: invalid syntax

🔸 модуль pydoc

Специальный инструмент для работы с документаций в Python.

Доступные команды:

как использовать pydoc
python3 -m pydoc

показать справку по функции или классу
python3 -m pydoc os.path.join

показать справку по ключевым словам языка
python3 -m pydoc <keyword>

например
python3 -m pydoc import
python3 -m pydoc def

справка по модулям
python3 -m pydoc <modulename>

поиск по документации
python3 -m pydoc -k <request>

Есть еще одна интересная возможность — запускать веб сервер документации как оболочка для pydoc.
То есть это не статичные HTML страницы из файлов, а сгенерированные на лету из докстрингов.

запустить веб сервер с документацией на порту 8000
python3 -m pydoc -p 8000

Теперь можете зайти на этот хост по указанному порту и получите простой сайт с документацией.

Если вы на локальном хосте, то можно открыть браузер введя команду b, или добавить такой же флаг в команду чтобы браузер открылся сам сразу.

Запустить веб сервер и сразу открыть браузер
python3 -m pydoc -p 8000 -b
____________________
PS. Чтобы с помощью функции help() получить справку по ключевым словам, следует их писать в виде строки

help('import')

#libs