Python включает в себя множество встроенных функций. Такие функции выполняют заранее определенную задачу и могут быть вызваны по необходимости в любой программе. Однако если вы не нашли встроенной функции, которая способна решить вашу проблему, вы всегда можете сами написать подходящую. Сейчас мы рассмотрим, как определять и использовать функции в программе на Python.
Определение функции
Функция — это многократно используемый блок программных инструкции, предназначенный для выполнения определенной задачи. Для определения функции в Python используется ключевое слово def. Ниже приведен синтаксис определения функции.
Синтаксис:
def имя_функции(параметры):
"""docstring"""
инструкция1
инструкция2
...
...
return [выражение]
За ключевым словом def следует подходящий идентификатор (имя функции) и круглые скобки. В круглых скобках может быть дополнительно указан один или несколько параметров. Символ ‘:’ после круглых скобок начинает блок с отступом (тело функции).
Первой инструкцией в теле функции может быть строка, которая называется docstring. Она описывает функциональность функции/класса. Строка docstring не является обязательной.
В общем случае тело функции содержит одну или несколько инструкций, которые выполняют некоторые действия. В нем также может использоваться ключевое слово pass.
Последней командой в блоке функции зачастую является инструкция return. Она возвращает управление обратно вызвавшему функцию окружению. Если после оператора return стоит выражение, то его значение также передается в вызывающий код.
В следующем примере определена функция welcome().
Пример созданной пользователем функции:
def welcome():
"""This function prints 'Welcome!'"""
print('Welcome!')
Выше мы определили функцию welcome(). Первая инструкция — это docstring, в котором сообщается о том, что делает эта функция. Вторая — это метод print, который выводит указанную строку на консоль. Обратите внимание, что welcome() не содержит оператор return.
Чтобы вызвать определенную ранее функцию, просто используйте выражение, состоящее из ее имени и двух круглых скобок ‘()’, в любом месте кода. Например, приведенная выше функция может быть вызвана так: welcome().
Пример вызова определенной пользователем функции:
welcome()
Вывод:
Welcome!
По умолчанию все функции возвращают None, если отсутствует оператор return.
returned_value = welcome()
print(returned_value)
Вывод:
Welcome!
None
Функция help() выводит docstring, как показано ниже.
>>> help(welcome)
Help on function welcome in module __main__:
welcome()
This function prints 'Welcome!'
Параметры функции
Функции также могут принимать на вход один или несколько параметров (они же аргументы) и использовать их для вычислений, определенных внутри функционального блока. В таком случае параметрам/аргументам даются подходящие формальные имена. Для примера изменим функцию welcome(): теперь она принимает в качестве параметра строку user_name; также изменена инструкция с функцией print() для отображения более персонализированного приветствия.
Пример функции с аргументами:
def welcome(user_name):
print('Welcome, ' + user_name + '!')
welcome('Anon') # вызов функции с параметром
Вывод:
Welcome, Anon!
Именованные аргументы, используемые в определении функции, называются формальными параметрами. В свою очередь, объекты, передаваемые в функцию при ее вызове, называются фактическими аргументами/параметрами.
Параметры функции могут иметь аннотацию для указания типа аргумента с использованием синтаксиса parameter:type. Например, следующая аннотация указывает тип параметра string.
Пример использования аннотации типов:
def welcome(user_name:str):
print('Welcome, ' + user_name + '!')
welcome('Anon') # передача строки в функцию
# пройдет нормально
welcome(42) # а передача числа в функцию
# вызовет ошибку
Передача нескольких параметров
Функция может иметь множество параметров. Представленная ниже вариация welcome() принимает три аргумента.
Пример определения функции с несколькими параметрами:
def welcome(first_name:str, last_name:str):
print('Welcome, ' + first_name + ' ' + last_name + '!')
welcome('Anton', 'Chekhov') # передача аргументов в функцию
Вывод:
Welcome, Anton Chekhov!
Неизвестное количество аргументов
Функция в Python может иметь неизвестное заранее число параметров. Укажите * перед аргументом, если вы не знаете, какое количество параметров передаст пользователь.
Пример функции с неизвестным числом параметров (используются только первые 3):
def welcome(*name_parts):
message = 'Welcome, ' + name_parts[0] + " "
message += name_parts[1] + " " + name_parts[2]
print(message + "!")
welcome('Anton', 'Pavlovich', 'Chekhov')
Вывод:
Welcome, Anton Pavlovich Chekhov!
Следующая функция работает с любым количеством аргументов.
Пример функции, использующей все переданные ей параметры:
def welcome(*name_parts):
message = 'Welcome,'
for part in name_parts:
message += " " + part
print(message + "!")
welcome('Anton', 'Pavlovich', 'Chekhov',
'and', 'Fyodor', 'Mikhailovich', 'Dostoevsky')
Вывод:
Welcome, Anton Pavlovich Chekhov and Fyodor Mikhailovich Dostoevsky!
Аргументы-ключевые слова
Чтобы использовать функцию с параметрами, необходимо предоставить ей фактические аргументы в количестве, соответствующем числу формальных. С другой стороны, при вызове функции мы не обязаны соблюдать указанный в определении порядок параметров. Но в таком случае при передаче значений аргументов мы должны явно указать имена соответствующих формальных параметров. В следующем примере фактические значения передаются с использованием имен параметров.
def welcome(first_name:str, last_name:str):
print('Welcome, ' + first_name + ' ' + last_name + '!')
welcome(last_name='Chekhov', first_name='Anton') # передача
# аргументов в функцию в произвольном порядке
Вывод:
Welcome, Anton Chekhov!
Аргументы-ключевые слова **kwarg
Функция может иметь только один параметр с префиксом **. Он инициализирует новое упорядоченное отображение (словарь), содержащее все оставшееся без соответствующего формального параметра аргументы-ключевые слова.
Пример использования **kwarg:
def welcome(**name_parts):
print('Welcome, ' + name_parts['first_name'] + ' ' + name_parts['last_name'] + '!')
welcome(last_name='Chekhov', first_name='Anton')
welcome(last_name='Chekhov', first_name='Anton', age='28')
welcome(last_name='Chekhov') # вызовет KeyError
Вывод:
Welcome, Anton Chekhov!
Welcome, Anton Chekhov!
При использовании параметра ** порядок аргументов не имеет значения. Однако их имена должны быть идентичными. Доступ к аргументам-ключевым словам для получения переданных значений осуществляется с помощью такого выражения: имя_параметра_kwarg[‘имя_переданного_аргумента’].
Если функция обращается к аргументу-ключевому слову, но вызывающий код не передает этот параметр, то она вызовет исключение KeyError, как показано ниже.
Пример функции, вызывающей KeyError:
def welcome(**name_parts):
print('Welcome, ' + name_parts['first_name'] + ' ' + name_parts['last_name'] + '!')
welcome(last_name='Chekhov') # вызывет KeyError: необходимо предоставить аргумент 'first_name'
Вывод:
Traceback (most recent call last):
...
line 2, in welcome
print('Welcome, ' + name_parts['first_name'] + ' ' + name_parts['last_name'] + '!')
KeyError: 'first_name'
Параметры со значением по умолчанию
При определении функции ее параметрам могут быть присвоены значения по умолчанию. Такое значение заменяется на соответствующий фактический аргумент, если он был передан при вызове функции. Однако если фактический параметр не был предоставлен, то внутри функции будет использоваться значение по умолчанию.
Представленная ниже функция welcome() определена с параметром name, имеющим значение по умолчанию ‘Anon’. Оно будет заменено только в том случае, если вызывающей стороной будет передан какой-либо фактический аргумент.
Пример функции со значением по умолчанию:
def welcome(user:str = 'Anon'):
print('Welcome, ' + user + '!')
welcome()
welcome('Chekhov')
Вывод:
Welcome, Anon!
Welcome, Chekhov!
Функция с возвращаемым значением
Чаще всего нам нужен результат работы функции для использования в дальнейших вычислениях. Следовательно, когда функция завершает выполнение, она также должна возвращать какое-то результирующее значение.
Для того, чтобы передать подобное значение внешнему коду, функция должна содержать инструкцию с оператором return. В этом случае возвращаемое значение должно быть указано после return.
Пример функции с возвращаемым значением:
def get_product(a, b):
return a * b
Ниже показано, как при вызове функции get_product() получить результат ее работы.
Пример использования функции с возвращаемым значением:
result = get_product(6, 7)
print(result)
result = get_product(3, get_product(4, 5))
print(result)
Вывод:
42
60