Шаг 8.
Основы языка Python.
Доступ к документации

    На этом шаге мы рассмотрим различные способы получения справочной документации.

    При установке Python на компьютер помимо собственно интерпретатора копируется документация по этому языку в формате СНМ. Чтобы отобразить документацию, в меню Пуск выбираем пункт Программы (Все программы) | Python 3.4 | Python 3.4 Manuals (рисунок 1).


Рис.1. Документация в формате СНМ

    Если в меню Пуск | Программы (Все программы) | Python 3.4 выбрать пункт Python 3.4 Docs Server (pydoc - 32 bit), запустится сервер документов pydoc (рисунок 2).


Рис.2. Сервер документов

    Он представляет собой программу, написанную на самом Python, выступающую в роли Web-сервера и выводящую результаты работы в Web-браузере. Сразу после запуска pydoc откроется Web-браузер, в котором будет выведен список всех стандартных модулей, поставляющихся в составе Python (рисунок 3).


Рис.3. Web-браузер со списком стандартных модулей

    Нажав на название модуля, представляющее собой гиперссылку, мы откроем страницу с описанием всех классов, функций и констант, объявленных в этом модуле.

    Чтобы завершить работу pydoc, следует переключиться в его окно (рисунок 2, ввести в нем команду q (от quit - выйти) и нажать клавишу Enter - окно при этом автоматически закроется. А введенная там команда b (от browser - браузер) повторно выведет страницу со списком модулей.

    В окне Python Shell редактора IDLE также можно отобразить документацию. Для этого предназначена функция help (). В качестве примера отобразим документацию по встроенной функции input ():


Рис.4. Результат выполнения функции help ()

    С помощью функции help () можно получить документацию не только по конкретной функции, но и по всему модулю сразу. Для этого предварительно необходимо подключить модуль. Например, подключим модуль builtins, содержащий определения всех встроенных функций и классов, а затем выведем документацию по этому модулю (рисунок 5):


Рис.5. Документация по модулю builtins

    На следующем шаге мы закончим изучение этого вопроса.




Предыдущий шаг Содержание Следующий шаг