Функции в Python
В программировании вы используете функции, чтобы объединить набор инструкций, которые вы хотите многократно применять, или которые из-за своей сложности лучше изолировать в подпрограмме и вызывать по мере необходимости. Иными словами, функция — это фрагмент кода, написанный для выполнения конкретной задачи. Для её выполнения функция может требовать один или несколько входов, а может и не требовать. По завершении задачи функция может возвращать одно или несколько значений либо ничего не возвращать.
В Python есть три типа функций:
-
Встроенные функции, такие как
help()для получения справки,min()для нахождения минимального значения,print()для вывода объекта в терминал и т. д. Обзор таких функций можно найти здесь. -
Пользовательские функции (UDF), то есть функции, которые пользователи создают для своих задач; и
-
Анонимные функции, которые также называют лямбда-функциями, поскольку они объявляются не с помощью стандартного ключевого слова
def.
Функции и методы
Метод — это функция, являющаяся частью класса. Доступ к нему осуществляется через экземпляр или объект класса. Функции такого ограничения не имеют: это самостоятельные функции. То есть все методы — это функции, но не все функции — методы.
Рассмотрим пример, где вы сначала определяете функцию plus(), а затем класс Summation с методом sum():
# Define a function `plus()`
def plus(a,b):
return a + b
# Create a `Summation` class
class Summation(object):
def sum(self, a, b):
self.contents = a + b
return self.contents Если теперь вы хотите вызвать метод sum(), который является частью класса Summation, вам сначала нужно создать экземпляр или объект этого класса. Давайте создадим такой объект:
# Instantiate `Summation` class to call `sum()`
sumInstance = Summation()
sumInstance.sum(1,2)Помните, что такая инициализация не нужна, когда вы хотите вызвать функцию plus()! Вы сможете выполнить plus(1,2) в блоке кода DataCamp Light без каких-либо проблем!
Параметры и аргументы
Параметры — это имена, используемые при определении функции или метода, к которым сопоставляются аргументы. Иными словами, аргументы — это значения, которые передаются при вызове функции или метода, а код функции или метода обращается к этим значениям по именам параметров.
Рассмотрите следующий пример и вернитесь к блоку DataCamp Light выше: вы передаёте два аргумента методу sum() класса Summation, хотя ранее определили три параметра: self, a и b.
Что произошло с self?
Первый аргумент каждого метода класса — это всегда ссылка на текущий экземпляр класса, в данном случае Summation. По соглашению этот аргумент называется self.
Это означает, что вы не передаёте ссылку на self явно, поскольку self — это имя параметра для неявно передаваемого аргумента, ссылающегося на экземпляр, через который вызывается метод. Он вставляется в список аргументов автоматически.
Как определить функцию: пользовательские функции (UDF)
Четыре шага для определения функции в Python:
-
Используйте ключевое слово
defдля объявления функции и укажите имя функции. -
Добавьте параметры функции: они должны быть в круглых скобках. Завершите строку двоеточием.
-
Добавьте инструкции, которые должна выполнять функция.
-
Завершите функцию оператором return, если функция должна что-то вернуть. Без оператора return функция вернёт объект
None.
def hello():
print("Hello World")
return Конечно, по мере продвижения ваши функции будут становиться сложнее: вы можете добавлять циклы for, управляющие конструкции и многое другое, чтобы сделать их более тонкими:
def hello():
name = input("Enter your name: ")
if name:
print(f"Hello {name}")
else:
print("Hello World")
hello()
В приведённой выше функции вы просите пользователя ввести имя. Если имя не задано, функция выведет «Hello World». В противном случае пользователь получит персонализированное «Hello».
Помните, что вы можете определить один или несколько параметров функции для своей UDF. Вы узнаете больше об этом в разделе «Аргументы функции». Кроме того, вы можете возвращать одно или несколько значений как результат работы функции либо ничего не возвращать.
Оператор return
Обратите внимание: так как в вашей UDF hello() происходит вывод с помощью print, возвращать значение не обязательно. Разницы между функцией выше и этой не будет:
def hello_noreturn():
print("Hello World") Однако, если вы хотите дальше работать с результатом функции и пробовать над ним операции, нужно использовать оператор return, чтобы действительно вернуть значение, например строку, целое число и т. п. Рассмотрим сценарий, где hello() возвращает строку "hello", а функция hello_noreturn() возвращает None:
def hello():
print("Hello World")
return("hello")
def hello_noreturn():
print("Hello World")
# Multiply the output of `hello()` with 2
elloo() * 2
# (Try to) multiply the output of `hello_noreturn()` with 2
hello_noreturn() * 2Вторая функция выдаст ошибку, потому что с None нельзя выполнять операции. Вы получите TypeError с сообщением, что нельзя выполнить операцию умножения для NoneType (того самого None, который возвращает hello_noreturn()) и int (2).
Совет: функции немедленно завершают выполнение при встрече оператора return, даже если при этом они ничего не возвращают:
def run():
for x in range(10):
if x == 2:
return
print("Run!")
run()Ещё один момент, который стоит упомянуть при работе с оператором return: с его помощью можно возвращать несколько значений. Для этого используются кортежи.
Помните, что эта структура данных очень похожа на список: она может содержать несколько значений. Однако кортежи неизменяемы, то есть вы не можете изменять значения, хранящиеся в них! Они создаются с помощью парных круглых скобок (). Кортежи можно распаковывать в несколько переменных с помощью запятой и оператора присваивания.
Посмотрите следующий пример, чтобы понять, как функция может возвращать несколько значений:
# Define `plus()`
def plus(a,b):
sum = a + b
return (sum, a)
# Call `plus()` and unpack variables
sum, a = plus(3,4)
# Print `sum()`
print(sum)Замечание: оператор return с записью return sum, a даст тот же результат, что и return (sum, a): в первом случае sum и a под капотом упаковываются в кортеж!
Как вызывать функцию
В предыдущих разделах вы уже видели множество примеров того, как можно вызывать функцию. Вызвать функцию — значит выполнить определённую вами функцию — либо напрямую из интерактивной оболочки Python, либо из другой функции (как вы увидите в разделе «Вложенные функции»).
Вызовите вашу новую функцию hello(), просто выполнив hello(), как в блоке DataCamp Light ниже:
hello()Как добавить docstring к функции Python
Ещё один важный аспект написания функций в Python: docstring. Docstring описывает, что делает ваша функция: какие вычисления выполняет или какие значения возвращает. Эти описания служат документацией функции, чтобы любой, кто прочитает docstring, понял назначение функции, не просматривая весь её код.
Docstring функции размещается сразу после заголовка функции и заключается в тройные кавычки. Подходящий docstring для вашей функции hello() — «Печатает “Hello World”».
def hello() -> None:
"""Prints "Hello World"."""
print("Hello World")
Функции — неотъемлемая часть языка программирования Python: вы наверняка уже встречались и пользовались множеством замечательных встроенных функций Python или функций из библиотек его экосистемы. Однако как дата-сайентист вам постоянно придётся писать собственные функции, чтобы решать задачи, которые ставят перед вами данные.
В этом руководстве используется синтаксис Python 3. Все примеры работают на Python 3.10+ и обновлены с учётом современных соглашений (f-строки, подсказки типов, параметры только позиционные и только по ключу). Текущий стабильный релиз — Python 3.14.
Чтобы легко запустить весь пример кода из этого руководства самостоятельно, вы можете бесплатно создать рабочую тетрадь DataLab с предустановленным Python и всеми образцами кода. Для дополнительной практики по написанию функций в Python загляните в это практическое упражнение DataCamp или пройдите наш курс Python Data Science Toolbox!