§3.3. Справочная система

В Питоне определено множество функций, позволяющих решать различные задачи. Некоторые из них сгруппированы по назначению и вынесены в отдельные модули. В следующем разделе мы научимся импортировать модули и использовать функции из них, но, для начала, разберемся с тем, как определять, для чего предназначена та или иная функция. Этот навык вам очень пригодится в дальнейшем, т.к. часто довольно трудно догадаться о назначении функций по их названию.

Для упрощения работы программиста в Питоне предусмотрена встроенная переменная

doc (начинается и заканчивается парами символов подчеркивания), в которой обычно

хранится минимальная справочная информация:

>» print str. doc

str (object) -> string

Return a nice string representation of the object.

If the argument is a string, the return value is the same object.

Функция str() «представилась» и вывела информацию о себе: какие параметры она принимает, какого типа значение возвращает, и коротко «рассказала», что она делает.

Начиная с версии 2.2, в Питоне появилась справочная система, реализованная в виде функции help (). Данная функция в качестве параметра принимает имя любого объекта (в том числе, модуля или функции) и выводит справочную информацию о нем.

Упражнение. Ознакомьтесь со справочной информацией функции str (). Имейте ввиду, что в Питоне версий ниже 2.2 функция help () работать не будет. Выход из справочной системы осуществляется клавишей [Q].

35

Ревизия: 170

Функции

§3.4. Импорт модулей и математические функции

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

>» import math >»

Данная команда импортирует модуль math. Питон поддерживает частичный импорт модулей (подробнее об этом можно прочесть в Приложении В), но нам пока это не нужно. Итак, мы импортировали модуль с описанием математических функций и теперь попробуем вызвать из него одну из них. Для начала определим, какие функции и константы определены в модуле:

>» dir(math)
[' doc ', ' file	', ' name ',	' acos	r	'asin'	r	'atan',
'atan2', 'ceil',
'cos', 'cosh', 'e',	'exp', 'tabs',	'floor	r	'fmod'	r	'frexp',
'hypot', 'ldexp',
'log', 'loglO', 'mo	df' , 'pi', 'pow'	, ' sin	r	'sinh'	r	'sqrt',	'tan',
'tanh']
>»

В результате выполнения этой команды интерпретатор вывел все имена, определенные

в данном модуле. В их числе есть и переменная doc . Для того, чтобы обратиться к

переменной или функции из импортированного модуля необходимо указать его имя, поставить точку и написать необходимое имя:

>» print math. doc
This module is always available. It provides access	to the
mathematical functions defined by the С standard.
>» print math.pi
3.14159265359
>» decibel = math. loglO (17 . 0)

Первая строка примера выводит описание модуля; четвертая - значение константы л, а шестая- вычисляет значение логарифма 17 по основанию 10. Помимо десятичного логарифма в модуле определен и натуральный логарифм (т.е. с основанием е = 2.7182818284590451): math. log (). Еще один пример:

>»	height = math	sin	(45)
>»	print height
0.850903524534

Если вы изучали тригонометрию, то, наверное, помните, что синус 45 градусов равен квадратному корню из 2 деленному на 2. Давайте проверим результат вычисления функции:

36

Ревизия: 170

Функции

>» math		sqrt(2)	/	2	0
0	707106781187

Результаты получились разные. Почему? Разработчики допустили ошибку? Вполне вероятно - никто не застрахован от ошибок. Но, прежде чем писать отчет об ошибке и отправлять его разработчикам, давайте ознакомимся со справкой по данной функции:

>» help (math, sin)
Help on built-in function	sin:
sin(...)
sin(x)
Return the sine of x	(measured in	radians).
(END)

Из справки видно, что в качестве параметра тригонометрические функции принимают значение угла в радианах. Нажимаем [Q] для выхода из справочной системы с чувством гордости: теперь мы знаем как работает функция math.sinO; проведем преобразование в радианы:

>»

degrees

= 45

>»

angle =

degrees

*

math.pi

/

180

0

>»

height =

= math

sin

(angle)

>»

print h(

sight

0.707106781187

Теперь результаты совпали - все верно.

Упражнение. Выполните в командной строке интерпретатора Питона версии 2.2 или выше следующие инструкции:

>» import math

>» print math. doc

>» help (math)

Ознакомьтесь с описанием модуля и входящих в него функций. Вся справка на экране не поместится, но вы сможете прокручивать текст с помощью клавиш-стрелок. Выход из справочной системы осуществляется клавишей [Q].

Если возникнет желание, можете «поиграться» с этими функциями, написав несколько простеньких программок с их использованием. Где их можно применять?