Позиционные аргументы — Python: Функции

Функции, которые вы видели до этого, в основном имели позиционные аргументы. При вызове функций значения в такие аргументы подставляются согласно позиции имён аргументов в определении функции. Так, при вызове функции

def add(x, y):
    return x + y

с аргументами (10, 20) аргумент x получит значение 10, а y — 20.

Переменное количество аргументов

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

Вспомните, известная вам функция print принимает столько аргументов, сколько вы ей передадите. Она делает полезную работу даже тогда, когда вы вызываете её вообще без аргументов! Как же мы можем научить нашу собственную функцию так же терпимо относиться к количеству аргументов? Потребуется специальный синтаксис:

def f(*args):
    print(type(args))
    print(args)

f()
# => tuple
# => ()

f(1, 'a', None, False)
# => tuple
# => (1, 'a', None, False)

Здесь в заголовке функции (так называют строчку, в которой описываются имя функции и её аргументы) указан ровно один аргумент args, но записанный со звёздочкой впереди. Звездочка означает "эта переменная получит в виде кортежа все аргументы, от текущей позиции и до конца". Из чего следует, что такой "прожорливый" аргумент может быть только один (первый же "прожорливый" аргумент съест всё) и может располагаться только в конце списка аргументов (иначе последующим аргументам не достанется значений). А ещё пример показывает, что *args нормально переживает и отсутствие аргументов, обычные же аргументы всегда обязательны. Рассмотрим же пример посложнее:

def greet(name, *args):
    for n in (name,) + args:
        print(f'Hello, {n}!')

greet('Tom', 'Ann')
# => Hello, Tom!
# => Hello, Ann!
greet()
# TypeError: greet() missing 1 required positional argument: 'name'

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

Передача аргументов в форме коллекции

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

names = ['Tom', 'Ann']
greet(*names)
# => Hello, Tom!
# => Hello, Ann!

Более того, часть аргументов можно передавать непосредственно и даже коллекции подставлять не только по одной:

…
greet(
   'Bob', *['Mary', 'Clair'], 'Sam',
   *('Henry', 'John')
)
# => Hello, Bob!
# => Hello, Mary!
# => Hello, Clair!
# => Hello, Sam!
# => Hello, Henry!
# => Hello, John!

Соглашения об именовании *args

Напоследок отмечу, что среди питонистов принято называть упомянутый аргумент именно *args (от слова "arguments"). Старайтесь придерживаться этого соглашения и вы.

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

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