Параметры по умолчанию и способы передачи аргументов в Python

Обновлено:

1. Параметр и аргумент

Ранее мы уже познакомились с параметрами функций.

def calculate_square(number):
    return number ** 2

Здесь:

number

— параметр функции.

При вызове:

calculate_square(5)

число:

5

— аргумент.

То есть:

  • параметр записывается при определении функции;
  • аргумент передаётся при вызове функции.

Обязательные параметры

2. Обязательный параметр

Рассмотрим функцию:

def create_greeting(name):
    return f'Привет, {name}!'


print(create_greeting('Alex'))

Результат:

Привет, Alex!

Параметр:

name

является обязательным.

Если вызвать функцию без аргумента:

create_greeting()

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


Необязательные параметры

3. Значение по умолчанию

Параметру можно сразу назначить значение:

def create_greeting(name='Guest'):
    return f'Привет, {name}!'

Теперь функцию можно вызвать без аргументов:

print(create_greeting())

Результат:

Привет, Guest!

В этом случае используется значение по умолчанию:

'Guest'

Но его можно заменить:

print(create_greeting('Anna'))

Результат:

Привет, Anna!

Такой параметр называют:

  • необязательным параметром;
  • параметром со значением по умолчанию.

4. Обязательные и необязательные параметры вместе

def create_order_message(product, quantity=1):
    return f'Товар: {product}. Количество: {quantity}.'


print(create_order_message('Keyboard'))
print(create_order_message('Keyboard', 3))

Результат:

Товар: Keyboard. Количество: 1.
Товар: Keyboard. Количество: 3.

Здесь:

product

— обязательный параметр.

А:

quantity=1

— необязательный параметр.


None как значение по умолчанию

5. Необязательный параметр со значением None

Очень часто в качестве значения по умолчанию используется:

None

Например:

def create_delivery_message(product, address=None):
    if address is None:
        return f'{product}: самовывоз'

    return f'{product}: доставка по адресу {address}'

Вызов без адреса:

print(create_delivery_message('Laptop'))

Результат:

Laptop: самовывоз

Вызов с адресом:

print(
    create_delivery_message(
        'Laptop',
        'Tbilisi',
    )
)

Результат:

Laptop: доставка по адресу Tbilisi

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


Учебный аналог pow()

6. Функция с несколькими обязательными и необязательными параметрами

У встроенной функции pow() есть форма с двумя аргументами:

pow(base, exp)

и форма с третьим аргументом:

pow(base, exp, mod)

Третий аргумент позволяет получить результат возведения в степень по модулю. Встроенная pow() реализует эту операцию эффективнее, чем простое вычисление base ** exp % mod.

Напишем упрощённый учебный аналог:

def my_pow(base, exp, mod=None):
    result = base ** exp

    if mod is None:
        return result

    return result % mod

Без третьего аргумента:

print(my_pow(5, 4))
print(pow(5, 4))

Результат:

625
625

С третьим аргументом:

print(my_pow(5, 4, 100))
print(pow(5, 4, 100))

Результат:

25
25

В нашей функции:

base
exp

— обязательные параметры.

А:

mod=None

— необязательный параметр.


Позиционные аргументы

7. Передача по позиции

Рассмотрим функцию:

def create_user_report(name, age, city):
    return f'{name}, {age}, {city}'

Обычный вызов:

create_user_report(
    'Alex',
    25,
    'Tbilisi',
)

Аргументы передаются по позиции:

'Alex'     → name
25         → age
'Tbilisi'  → city

Порядок имеет значение.

create_user_report(
    25,
    'Tbilisi',
    'Alex',
)

синтаксически допустим, но значения попадут не в те параметры, для которых мы их предназначали.


Именованные аргументы

8. Передача по имени

Для обычной функции параметры можно указывать при вызове явно:

create_user_report(
    name='Alex',
    age=25,
    city='Tbilisi',
)

Такие аргументы называются:

именованными аргументами

или:

keyword arguments

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


9. Порядок именованных аргументов

При передаче по имени Python ориентируется на название параметра, поэтому порядок можно изменить:

create_user_report(
    city='Tbilisi',
    name='Alex',
    age=25,
)

Результат будет таким же.

Python понимает:

city='Tbilisi'
name='Alex'
age=25

именно по именам параметров.


Комбинирование способов передачи

10. Позиционные и именованные аргументы вместе

Можно комбинировать оба способа:

create_user_report(
    'Alex',
    age=25,
    city='Tbilisi',
)

Первый аргумент передан по позиции:

'Alex'

Остальные — по имени.

Можно оставить два позиционных:

create_user_report(
    'Alex',
    25,
    city='Tbilisi',
)

Оба варианта правильные.


11. Сначала позиционные, потом именованные

При обычном вызове позиционные аргументы должны находиться перед именованными.

Правильно:

create_user_report(
    'Alex',
    age=25,
    city='Tbilisi',
)

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

create_user_report(
    name='Alex',
    25,
    city='Tbilisi',
)

Такой код является синтаксически неправильным.

Основное правило:

Сначала записываются позиционные аргументы, после них — именованные.


12. Нельзя передать одному параметру два значения

Например:

def create_user_report(name, age):
    return f'{name}, {age}'

Вызов:

create_user_report(
    'Alex',
    name='Anna',
    age=25,
)

тоже неправильный.

Строка:

'Alex'

уже попала в параметр:

name

по позиции.

После этого мы пытаемся ещё раз передать значение тому же параметру:

name='Anna'

При вызове возникнет TypeError.


Обязательные и необязательные параметры в определении функции

13. Параметры со значениями по умолчанию располагаются после обязательных

Правильно:

def create_order(
    product,
    price,
    quantity=1,
    currency='GEL',
):
    return (
        f'{product}: '
        f'{quantity} шт., '
        f'{price} {currency}'
    )

Сначала находятся обязательные параметры:

product
price

После них — параметры со значениями по умолчанию:

quantity=1
currency='GEL'

14. Обязательный параметр нельзя поставить после параметра со значением по умолчанию

В обычной форме определения функции нельзя написать:

def create_order(product='Laptop', price):
    return price

Python не позволит определить такую функцию.

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

Сначала обязательные параметры, затем параметры со значениями по умолчанию.


15. Несколько значений по умолчанию

Можно постепенно добавлять значения по умолчанию справа:

def example(a, b, c=3):
    ...

Затем:

def example(a, b=2, c=3):
    ...

И даже:

def example(a=1, b=2, c=3):
    ...

Но нельзя сделать:

def example(a=1, b, c=3):
    ...

потому что обязательный b оказался после параметра со значением по умолчанию.


Один пример со всеми вариантами

16. Функция заказа

def create_order_report(
    product,
    price,
    quantity=1,
    delivery='standard',
):
    total_price = price * quantity

    return (
        f'Товар: {product}. '
        f'Количество: {quantity}. '
        f'Стоимость: {total_price}. '
        f'Доставка: {delivery}.'
    )

У функции два обязательных параметра:

product
price

и два необязательных:

quantity=1
delivery='standard'

Только обязательные аргументы

print(
    create_order_report(
        'Keyboard',
        2500,
    )
)

Используются значения по умолчанию:

quantity = 1
delivery = 'standard'

Необязательный аргумент по позиции

create_order_report(
    'Keyboard',
    2500,
    2,
)

Здесь:

2 → quantity

Комбинированный вызов

create_order_report(
    'Keyboard',
    2500,
    quantity=2,
    delivery='express',
)

Первые два аргумента переданы по позиции, остальные — по имени.


Все аргументы по имени

create_order_report(
    product='Keyboard',
    price=2500,
    quantity=2,
    delivery='express',
)

Для обычной функции такой вызов тоже разрешён.


Пример с тремя параметрами

17. Обязательные и необязательный параметр

def create_numbers_report(
    first_number,
    second_number,
    coefficient=3.0,
):
    return (
        f'first_number = {first_number}, '
        f'second_number = {second_number}, '
        f'coefficient = {coefficient}'
    )

Два обязательных параметра:

first_number
second_number

Один необязательный:

coefficient=3.0

18. Разные варианты вызова

Все аргументы по позиции:

create_numbers_report(
    10,
    20,
    5.0,
)

Необязательный аргумент не передан:

create_numbers_report(
    10,
    20,
)

Последний аргумент по имени:

create_numbers_report(
    10,
    20,
    coefficient=5.0,
)

Два последних по имени:

create_numbers_report(
    10,
    second_number=20,
    coefficient=5.0,
)

Все по имени:

create_numbers_report(
    first_number=10,
    second_number=20,
    coefficient=5.0,
)

Можно даже изменить порядок полностью именованных аргументов:

create_numbers_report(
    coefficient=5.0,
    first_number=10,
    second_number=20,
)

Порядок здесь не мешает Python определить, какое значение относится к какому параметру.


Встроенная функция print()

19. Позиционные и именованные аргументы в print()

Мы уже использовали:

print(
    'Python',
    'SQL',
    'Django',
)

Выводимые объекты передаются в print() позиционно.

Причём print() можно вызвать вообще без таких аргументов:

print()

или передать несколько:

print('Python', 'SQL', 'Django')

Параметры:

sep
end

являются необязательными и, если мы хотим изменить их значения, должны передаваться по имени:

print(
    'Python',
    'SQL',
    'Django',
    sep=' | ',
    end='.\n',
)

Официальная сигнатура print() требует передавать sep, end, file и flush именно как именованные аргументы.


Встроенная функция sorted()

20. Разные правила у разных параметров

Встроенная функция sorted() имеет обязательный параметр для итерируемого объекта:

sorted(numbers)

Например:

numbers = [5, 2, 10]

print(sorted(numbers))

Параметр iterable у sorted() является только позиционным, поэтому вызываем:

sorted(numbers)

а не передаём его по имени.

Параметр:

reverse

необязательный и передаётся только по имени:

sorted(
    numbers,
    reverse=True,
)

Сигнатура sorted() специально разделяет обязательный позиционный параметр и необязательные параметры, доступные только по имени.

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


Четыре характеристики, которые важно различать

21. Обязательный или необязательный

Это прежде всего характеристика параметра функции.

Обязательный:

def function(value):
    ...

Необязательный:

def function(value=None):
    ...

22. Позиционный или именованный

Это способ, которым аргумент передаётся при вызове.

По позиции:

function(10)

По имени:

function(value=10)

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


Основное по теме

При определении функции:

def create_order(
    product,
    price,
    quantity=1,
):
    ...
product       → обязательный параметр
price         → обязательный параметр
quantity=1    → необязательный параметр

При вызове:

create_order(
    'Laptop',
    5000,
    quantity=2,
)
'Laptop'     → позиционный аргумент
5000         → позиционный аргумент
quantity=2   → именованный аргумент

Основные правила:

  • параметр записывается в определении функции;
  • аргумент передаётся при вызове;
  • параметр без значения по умолчанию является обязательным;
  • параметр со значением по умолчанию можно не заполнять при вызове;
  • в обычной функции аргументы можно передавать по позиции или по имени;
  • при смешанном вызове сначала идут позиционные аргументы, затем именованные;
  • одному параметру нельзя одновременно передать два разных значения;
  • в изучаемой сейчас обычной форме функции обязательные параметры располагаются перед параметрами со значениями по умолчанию;
  • некоторые встроенные функции специально ограничивают способ передачи отдельных параметров — например, sorted().