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

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

    При рассмотрении комментариев мы говорили, что часто для комментирования большого фрагмента кода используются утроенные кавычки или утроенные апострофы. Такие строки не являются комментариями в полном смысле этого слова. Вместо комментирования фрагмента создается объект строкового типа, который сохраняется в атрибуте __doc__. Функция help () при составлении документации получает информацию из этого атрибута. Такие строки называются строками документирования.

    В качестве примера создадим два файла в одной папке. Содержимое файла test4.py:

Рис.1. Содержимое файла test4.py

    Теперь подключим этот модуль и выведем содержимое строк документирования:

Рис.2. Подключение файла и вывод строки документирования

Архив с файлами можно взять здесь.

    Результат выполнения:

Рис.3. Результат выполнения

    Теперь получим содержимое строк документирования с помощью атрибута __doc__:

Рис.4. Использование атрибута __doc__

Архив с файлами можно взять здесь.

    Результат выполнения:

Рис.5. Результат выполнения

    Атрибут __doc__ можно использовать вместо функции help (). В качестве примера получим документацию по функции input (). Результат выполнения:

Рис.6. Результат выполнения

    Получить список всех идентификаторов внутри модуля позволяет функция dir ():

Рис.7. Использование функции dir ()

Архив с файлами можно взять здесь.

    Результат выполнения:

Рис.8. Результат выполнения

    Теперь получим список всех встроенных идентификаторов:

Рис.9. Получение встроенных идентификаторов

    Функция dir() может не принимать параметров вообще. В этом случае возвращается список идентификаторов текущего модуля:

Рис.10. Использование функции dir () без параметров

Архив с файлами можно взять здесь.

    Результат выполнения:

Рис.11. Результат выполнения

    Со следующего шага мы начнем рассматривать переменные.

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