Сигнатура функции — Основы Python

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

Функция pow()

Функция pow() возводит число в степень. Она принимает два параметра: какое число возводить и в какую степень возводить. Если вызывать pow() без параметров, то Python выдаст следующее: "TypeError: pow expected at least 2 arguments, got 0". Интерпретатор сообщает, что функция ожидает два параметра, а вы вызвали ее без них.

Функция pow() всегда имеет два обязательных параметра, поэтому ее невозможно вызвать с другим количеством параметров.

Более того, параметрами pow() могут быть только числа. Например, если передать в нее пару строк, это приведет к следующей ошибке: "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'str'". Результат вызова функции — тоже всегда число.

Другая функция может иметь другое число параметров и другие типы параметров. Например, может существовать функция, которая принимает три параметра: число, строку и еще одно число.

Чтобы знать такие подробности о конкретной функции, нужно изучать ее сигнатуру. Она определяет входные параметры и их типы, а также выходной параметр и его тип. Про функцию pow() можно почитать в официальной документации Python или в неофициальной документации на русском языке. Обычно документация для функции выглядит так:

pow(x, y[, z])

Возвращает x в степени y; если z присутствует, возвращает x в степени y, по модулю z

Первая строка здесь — это сигнатура функции. У функции два обязательных параметра — x и y. Необязательный параметр z указан в квадратных скобках. Следом поясняется, для чего функция нужна. Документация дает понять, сколько аргументов у функции и какого они типа. Также она описывает, что возвращает функция и какого типа будет возвращаемое значение.

Далее рассмотрим еще одну функцию — она округляет число.

Функция round()

Рассмотрим функцию round(), которая округляет переданное ей число:

result = round(10.25, 0)  # 10.0

Мы передали в нее два параметра:

• Число, которое нужно округлить
• Точность округления

Создатели функции round сделали второй параметр необязательным и задали ему внутри функции значение по умолчанию None. Если не указывать второй параметр, то результат будет целым значением (int):

result = round(10.25)  # 10

А если нужна другая точность, то можно передать параметр:

# округление до одного знака после запятой
result = round(10.25, 1)  # 10.2

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

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.