Функции с переменным числом аргументов
Распаковка и запаковка значений
В конце урока про возврат значений из функции мы коснулись темы возврата нескольких значений и множественного присваивания получившихся значений нескольким переменным.
Хотя этот прием с присваиванием результата нескольким значениям часто используется именно в применении к функциям, на самом деле никакого отношения к механике работы функций не имеет. В приведенном примере функция просто возвращает кортеж, а всю дальнейшую работу делает механизм множественного присваивания, а точнее, процедура «распаковывания». Вы с ней уже сталкивались, когда обсуждали кортежи. Сейчас мы посмотрим на возможности множественного присваивания внимательнее.
Итак, вы можете написать:
В момент присваивания кортеж будет распакован, его первый элемент будет записан в x, второй — в y. Распаковать можно не только кортежи, но и списки: x, y = [1.5, 2.5] будет работать точно так же.
Если при множественном присваивании (когда слева больше одной переменной) число элементов слева и справа не совпадает, возникает ошибка времени исполнения. Вы это видели, когда разбирали запись трех координат в две переменные или двух — в три.
Есть способ собрать сразу несколько значений в одну переменную. Это делается при помощи звездочки перед именем переменной:
В этом случае в x будет записана единица, в y — 2, а в rest — список, состоящий из всех аргументов, которые не попали в обычные переменные. В данном случае rest будет равен [3, 4, 5, 6].
Учтите, что rest всегда будет списком, даже когда в него попадает лишь один элемент или даже ноль:
Звездочка может быть только у одного аргумента, но необязательно у последнего:
Такой аргумент может стоять и посередине:
Также есть возможность распаковывать вложенные списки. Например:
запишет в переменные a, b, c, d значения 1, 2, 3 и 4 соответственно.
Если вы хотите распаковать единственное значение в кортеже, после имени переменной должна идти запятая:
Помимо распаковывания, есть и операция запаковывания. Она выполняется всегда, когда справа от знака равенства стоит больше одного значения. Например, можно написать: values = 1, 2, 3. Тогда значения в правой части автоматически будут запакованы в кортеж (1, 2, 3).
Запаковывание можно комбинировать с распаковыванием:
Общее правило такое: при любых нестандартных присваиваниях сначала происходит запаковывание значений в правой части, а затем распаковка их в переменные, стоящие в левой части.
Вообще, лучший способ понять операции с запаковыванием и распаковыванием значений — поэкспериментировать с ними.
Техника запаковывания и распаковывания переменных со звездочкой используется не только в операциях присваивания. Похожий механизм применяется для написания функций, которые могут принимать переменное число аргументов. И синтаксис для этого используется похожий на тот, который применяется в множественном присваивании. В списке аргументов функции один из аргументов может быть помечен звездочкой, тогда в него попадут все значения на соответствующей позиции, которые еще не присвоены другим аргументам.
Но есть и отличие. При множественном присваивании переменная со звездочкой получает список значений. А когда аргумент функции указан со звездочкой, он получает кортеж значений.
Например, функция print принимает сколько угодно аргументов и дает таким образом возможность выводить на экран неограниченное число значений.
Разработчики языка Python могли поступить иначе и сделать функцию, принимающую всегда ровно один аргумент-список, и выводить на экран элементы этого списка. С точки зрения функциональности результат был бы аналогичным, но такую функцию было бы не так удобно использовать.
Мы сделаем свою функцию для вычисления произведения всех аргументов.
Эта функция принимает как минимум один аргумент — first. Это не позволяет вызвать функцию без аргументов, что было бы бессмысленно. Все аргументы, кроме первого, попадают в кортеж rest.
Не всем функциям необходимо произвольное число элементов. Бывает так, что функции требуется просто разное число аргументов. В этом случае можно поступить следующим образом: поставить звездочку, которая формально позволяет использовать любое число аргументов, а внутри функции вручную проверять, что число переданных элементов — правильное.
Звездочку можно использовать не только для того, чтобы запаковать аргументы. Распаковать их тоже можно. Если при вызове функции вы поставите звездочку перед переданным аргументом-списком, список раскроется и как бы «потеряет границы». Элементы списка станут аргументами функции.
Такую технику применяют, когда вам надо передать в функцию заранее неизвестное число аргументов. Вы делаете отдельную переменную, хранящую список аргументов, а затем просто раскрываете ее при помощи звездочки. На следующем уроке нам придется написать несколько таких функций.
Мы будем делать функции-обертки для функции print. Поскольку print принимает неограниченное число аргументов, обертка тоже должна будет принимать неограниченное число аргументов (запаковка) и передавать их в оригинальный print (распаковка).
Аргументы по умолчанию
Бывает так, что какой-то параметр функции часто принимает одно и то же значение. Например, хорошо известная вам функция int принимает два параметра: строка, которую нужно преобразовать в число, а также основание системы счисления. Это позволяет ей считывать числа в различных системах счисления, например, двоичное число 101 мы можем считать так:
Но чаще всего эта функция используется для считывания из строки чисел, записанных в десятичной системе счисления. Было бы неудобно каждый раз писать 10 вторым аргументом. На такой случай Python позволяет задавать некоторым аргументам значения по умолчанию. У функции int второй аргумент по умолчанию равен 10, и потому можно вызывать эту функцию с одним аргументом. Значение второго подставится автоматически.
Для того чтобы определить аргумент по умолчанию, в списке аргументов функции достаточно после имени переменной написать знак равенства и нужное значение. Аргументы, имеющие значение по умолчанию, должны идти в конце, ведь иначе интерпретатор не смог бы понять, какой из аргументов указан, а какой пропущен (и значит, для него нужно использовать значение по умолчанию).
В качестве примера сделаем функцию, которая будет готовить бургеры с котлетами разного типа и по умолчанию добавлять туда помидоры, но не добавлять лук. Тогда функция приготовления будет выглядеть так:
Теперь команда make_burger('свинина') будет делать бургер из свинины, в котором нет колечек и есть помидоры. Но если вам хочется поменять состав бургера, вы легко можете это сделать: make_burger('свинина', True) сделает вам бургер и с луком, и с помидорами (они по умолчанию включены), а make_burger('свинина', False, False) сделает вам бургер, в котором, кроме булочки и котлеты, ничего нет.
Первыми стоит указывать более важные аргументы (в нашем примере мы считаем, что класть или не класть лук, — более важное решение, чем класть или не класть помидор). Если вы укажете только одно дополнительное значение, оно будет присвоено первому аргументу по умолчанию, а второй аргумент так и останется со значением по умолчанию. Если укажете два значения, значения будут присвоены обеим переменным.
Именованные аргументы
Еще одна проблема функций заключается в том, что программист вынужден помнить (или каждый раз узнавать в документации) порядок аргументов. В некоторых случаях тяжело угадать логичный порядок аргументов. Чтобы не запоминать эти малозначительные детали, можно передавать аргументы в функцию с указанием имени аргумента, в таком случае порядок аргументов неважен. Вы уже сталкивались с именованными аргументами. Встроенная функция print часто используется с несколькими такими параметрами: sep=' ' - для разделения аргументов при выводе (по умолчанию — пробелами) и end='\n' для того, чтобы в конце добавлялся символ перевода строки. Так, нам не надо беспокоиться о том, какой параметр — sep или end — указывать первым.
Аргументы, которые передаются без указания имен, называются позиционными, потому что функция по положению аргумента понимает, какому параметру он соответствует. Аргументы, которые передаются с именами, называются именованными.
Чтобы вашу функцию можно было вызывать, используя именованные аргументы, буквально ничего не нужно делать. Все функции, которые вы писали на предыдущих уроках, уже можно вызывать, передавая им именованные аргументы.
Если у функции есть аргументы, при вызове можно использовать имена параметров, которые вы использовали в определении функции (исключение составляют списки аргументов неопределенной длины, в которых используются аргументы со звездочкой). Это еще один повод давать аргументам значащие, а не однобуквенные имена. Можно вспомнить или догадаться, что функция matrix_has_value имеет параметры matrix и value, но совершенно невозможно будет вспомнить про имена параметров, такие как a, b или m, v.
Именованные аргументы можно использовать вместе со значениями по умолчанию. Например, мы можем вызвать нашу функцию для создания бургеров, передав ей нужные именованные аргументы, а остальные оставив значениями по умолчанию (так как мы используем именованные аргументы, нам теперь неважно, в каком порядке мы их определяли):
Именованные и позиционные аргументы не всегда хорошо ладят друг с другом. При вызове функции позиционные аргументы должны обязательно идти перед именованными аргументами. Достаточно сложно сформулировать точные правила поведения аргументов функции при использовании одновременно аргументов со звездочкой и именованных аргументов. Чем запоминать точные правила, в таких случаях лучше пользоваться здравым смыслом.
Если вам приходится долго думать о том, как оформить список аргументов, чтобы он работал корректно, лучше использовать более простую версию. Ведь код, который тяжело писать, с большой вероятностью будет тяжело читать
Если ваш вызов функции не работает, попробуйте прочитать его глазами интерпретатора. Однозначно ли он читается или вы можете придумать несколько вариантов разложить переданные в вызове функции параметры по аргументам? Если вы можете трактовать код несколькими способами, с большой вероятностью интерпретатор столкнется с теми же трудностями. В ситуации, когда код неоднозначен, интерпретатор Python не пытается угадать, что программист имел ввиду, а сообщает об ошибке. Часто это считается синтаксической ошибкой, и ошибка возникает еще до того, как программа начинает выполняться
При указании значения именованных аргументов при вызове функции знак равенства, как вы наверняка помните из необязательных параметров функции print, не окружается пробелами.
Инструкция pass. Согласованность аргументов
В языке Python есть эталонно бесполезная инструкция pass. Инструкция pass — инструкция-заглушка, которая не делает ничего. Дело в том, что синтаксис языка Python не позволяет в некоторых местах обойтись без команд.
Например, не может быть функции с пустым телом. Ветвь условного оператора или тело цикла тоже должны выполнять какие-либо действия, но иногда программист хочет отложить их написание и ставит такую заглушку.
На этом примере можно показать, что PyCharm выделяет TODO комментарии и даже позволяет просмотреть все такие комментарии в проекте в специальном окне, которое можно вызвать комбинацией клавиш Alt + 6.
Давайте теперь напишем функцию, которая при вызове не делает ничего. Наша первая попытка будет такой:
Было бы удобно, если можно было завести функцию, которая принимает любые аргументы и, игнорируя их все, не делает ничего. Для захвата произвольного числа параметров, воспользуемся аргументом со звездочкой:
Чтобы написать функцию, которая игнорирует любой список аргументов, необходимо разрешить ей принимать произвольное число позиционных аргументов и произвольное число именованных аргументов:
**kwargs
Аргумент с двумя звездочками **kwargs — специальный аргумент, который может перехватить все «лишние» именованные аргументы, переданные в функцию. Лишними аргументами будут все именованные аргументы в команде вызова функции, для которых нет соответствующего параметра в определении функции.
Этот аргумент, как и аргумент с одной звездочкой, захватывающий «лишние» позиционные аргументы, можно использовать в комбинации с обычными аргументами. Например, сделаем и вызовем функцию, распечатывающую информацию о пользователе:
Как вы уже знаете, параметр children будет списком лишних позиционных аргументов. А вот additional_info будет словарем лишних именованных аргументов. В последней строке мы распечатали переданный словарь, он выглядит так:
Вы уже знаете, что звездочка может не только запаковывать аргументы, но и распаковывать их, если передать в функцию список со звездочкой перед ним:
Две звездочки также позволяют не только запаковывать именованные аргументы в словарь, но и распаковывать словарь в набор именованных аргументов.
Вы можете использовать распаковывание только что запакованных аргументов для того, чтобы усложнять поведение функции, подобно тому, как мы добавили черту к функции print. В дополнительных материалах вы узнаете, как создавать декораторы и модифицировать поведение уже существующих функций.