Python Справки

Python Справки — информация, появляющаяся по запросу.

Python Справки позволяют по мере необходимости получать информацию по многим аспектам языка программирования Python, причём прямо в окне программирования.

Привожу информацию о том, как можно получать Python Справки:

Получение справки

При работе с интерпретатором Python у Вас всегда под рукой будет несколько источников справочной информации.

Во-первых, при работе в интерактивном режиме с помощью команды help() можно получить информацию о любом встроенном модуле и о других аспектах языка Python.

Можно просто ввести команду help() и получить общую справочную информацию или команду help(‘имя_модуля’), чтобы получить информацию о конкретном модуле.

Если команде help() передать имя определенной функции, она может вернуть информацию об этой функции.

Большинство функций в языке Python снабжены строками документирования, описывающими порядок их использования. Чтобы вывести строку документирования, достаточно просто вывести содержимое атрибута __doc__.

Например:
>>> print (issubclass.__doc__)
issubclass(C, B) -> bool
Return whether class C is a subclass (i.e., a derived class) of class B.
When using a tuple as the second argument issubclass(X, (A, B, …)),
is a shortcut for issubclass(X, A) or issubclass(X, B) or … (etc.).

(Перевод
Проверяет, является ли класс C подклассом (то есть наследует) класса B.
Когда во втором аргументе передаётся кортеж – issubclass(X, (A, B, …)),
такой вызов является сокращённым вариантом issubclass(X, A) or issubclass(X, B)
or … (и т. д.).
)
>>>

И последнее, но также важное замечание – большинство инсталляций Python включает также команду pydoc, которая может использоваться для получения документации о модулях Python.

Для этого достаточно просто ввести команду topic в системной командной строке.

Команду pydoc в Python 3.6 запустить не удалось:

>>> pydoc winsound
SyntaxError: invalid syntax
>>> help (pydoc)
Traceback (most recent call last):
File «<pyshell#15>», line 1, in <module>
help (pydoc)
NameError: name ‘pydoc’ is not defined
>>> pydoc (winsound)
Traceback (most recent call last):
File «<pyshell#16>», line 1, in <module>
pydoc (winsound)
NameError: name ‘pydoc’ is not defined

Например, команда help (‘editor’) выдаёт многострочный голубой Help on module editor: …, то есть подробную справку по модулю editor, который хранится в файле editor.py

Обратите внимание, что в окне среды разработки IDLE команды имеют сиреневый цвет, а строковые аргументы — зелёный. Это облегчает чтение программ.

help(str) выдаёт информацию о классе str в модуле builtins

По команде help() получите такой ответ Интерпретатора

Welcome to Python 3.6′s help utility!

If this is your first time using Python, you should definitely check out the tutorial on the Internet at http://docs.python.org/3.6/tutorial/

Enter the name of any module, keyword, or topic to get help on writing Python programs and using Python modules. To quit this help utility and return to the interpreter, just type «quit«.

To get a list of available modules, keywords, symbols, or topics, type «modules», «keywords», «symbols», or «topics». Each module also comes with a one-line summary of what it does; to list the modules whose name or summary contain a given string such as «spam», type «modules spam».

help>

Последнее хвостатое слово help> приглашает ввести конкретный запрос.

Например, help> editor или help> str или какой-нибудь иной

Чтобы оценить мощность Python Справки, рекомендую выполнить команды

help> modules

help> keywords

help> symbols

help> topics

По любому слову из 4-х списков, полученных по этим командам, существуют Python Справки!

Чтобы прервать эту справочную утилиту и вернуться в Интерпретатор, достаточно исполнить quit

print (function_name.__doc__)   выдаёт информацию о function_name - пример привожу такой:

>>> import math
>>> print (math.__doc__)
This module is always available. It provides access to the
mathematical functions defined by the C standard.

Информация весьма скудная, а вот help (math) выдаёт весьма обширную информацию.

pydoc topic_name  выдаёт информацию о topic_name - Команду pydoc в Python 3.6 мне запустить не удалось.

Итак, запоминаем три основных способа получения Python Справки в окне Интерпретатора:

help (‘module_name’) или help (class_name)

print (function_name.__doc__)

pydoc topic_name - надо бы проверить в Python 2.6

К сожалению, в большинстве случаев справочная информация выдаётся на английском языке — радуйтесь тому, что не на голландском! И находите способы понять английские тексты — вот Вам повод в совершенстве выучить английский язык.

Кроме того, для получения Python Справки всегда можно обратиться к учебникам и справочникам на русском языке, упомянутым на странице Python Книги, причём нужно постараться обзавестись электронными копиями учебников и справочников на русском языке — их есть в Интернете в доступной форме и в хорошем качестве.

При запросе Python Справки избегайте без необходимости заглавных символов: help(STR) выдаст ошибку.

Приглашаю всех высказываться в Комментариях. Критику и обмен опытом одобряю и приветствую. В хороших комментариях сохраняю ссылку на сайт автора!

И не забывайте, пожалуйста, нажимать на кнопки социальных сетей, которые расположены под текстом каждой страницы сайта.
Python СправкиПродолжение тут…

Deviz_8

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Можно использовать следующие HTML-теги и атрибуты: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Проверка комментариев включена. Прежде чем Ваши комментарии будут опубликованы пройдет какое-то время.