Как использовать *args и **kwargs в Python 3

*args и **kwargs в Python 3

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

Содержание статьи

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

Для чего используется *args в Python?

В Python форма *args с одной звездочкой используется в качестве параметра для отправки функциями списка аргументов, которые не являются ключевыми словами с переменной длиной. Стоит отметить, что звездочка (*) является важным элементом, так как args представляет собой общепринятую идиому, хотя она и не принуждается к использованию языком.

Посмотрим на типичную функцию, которая использует два аргумента:

В коде выше создается функция с аргументами х и y, и затем при вызове функции нам нужно использовать числа соответствующие х и y. В данном случае мы передаем числа типа integer — 5 для х и 4  для у:

Сейчас мы можем запустить код:

Мы получим следующий результат, показывающий, что целые числа 5 и 4 были умножены функцией multiply(x,y):

Что, если позже мы решим умножить три числа, а не два? Если мы попытаемся добавить к функции дополнительное число, как показано ниже, мы получим ошибку TypeError.

Вывод:

Итак, если вам позже нужно будет использовать больше аргументов, вы можете использовать *args в качестве параметра.

По сути, мы можем создать ту же функцию и код, которые показали в первом примере, убрав x и y как параметры функции и вместо этого заменив их на *args:

При запуске данного кода мы получим результат вызова каждой функции:

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

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

Для чего используется **kwargs в Python?

Форма **kwargs с двумя звездочками используется в качестве параметра для отправки в функции списка аргументов переменной длины без ключевого слова. Две звездочки (**) также являются важным элементом, так как kwargs представляет собой общепринятую идиому, хотя она и не принуждается к использованию языком.

Как и *args, **kwargs может принимать столько аргументов, сколько вам нужно. Однако **kwargs отличается от *args тем, что здесь требуется назначить ключевые слова.

Сначала просто выведем аргументы из **kwargs, которые мы передаем функции. Создаем для этого короткую функцию:

Затем мы вызываем функцию с разными аргументами которые передаются в функцию:

Запустим код и посмотрим на результат вывода:

Вывод:

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

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

Создадим еще одну короткую программу, чтобы показать, как можно использовать **kwargs. Здесь мы создадим функцию приветствия для словаря с именами. Начнем со словаря с двумя именами:

Теперь мы можем запустить программу и посмотреть на результат вывода:

Вывод:

Так как словари могут быть в хаотичном порядке, ваш вывод может начинаться с имени Casey вместо Sammy.

Передадим дополнительные аргументы для функции, чтобы показать, что **kwargs примет столько аргументов, сколько вам нужно:

Сейчас при запуске программы мы получим следующий вывод, порядок которого у вас может отличаться:

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

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

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

  • Формально позиционные аргументы;
  • *args;
  • Аргументы с ключевыми словами;
  • **kwargs.

На практике при работе с явными позиционными параметрами вместе с *args и **kwargs ваша функция будет выглядеть следующим образом:

При работе с позиционными параметрами вместе с именованными параметрами с ключевыми словами в дополнение к *args и **kwargs, ваша функция должна выглядеть следующим образом:

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

Использование *args и **kwargs при вызове функции

Мы также можем использовать *args и **kwargs для передачи аргументов в функции.

Сначала рассмотрим пример с *args.

В функции выше есть три параметра, определенные как arg_1, arg_2 и arg_3. Функция выводит каждый из этих трех аргументов. Затем мы создаем переменную, для которой задается итерация (в данном случае кортеж), и можем передать эту переменную в функцию с синтаксисом со звездочкой.

При запуске программы с помощью команды python some_args.py мы получим следующий результат:

Мы также можем изменить программу выше для итерации списка с другим названием переменной. Давайте также объединим синтаксис *args с именованным параметром:

При запуске программы будет получен следующий результат:

Аналогичным образом аргументы **kwargs с ключевыми словами можно использовать для вызова функции. Мы создадим переменную, равную словарю с 3 парами ключ-значение (здесь мы будем использовать kwargs, но его можно называть как угодно) и передадим ее функции с 3 аргументами:

Запустим программу выше с помощью команды python some_kwargs.py:

При вызове функции вы можете использовать *args и **kwargs для передачи аргументов.

Заключение

Мы можем использовать специальный синтаксис *args и **kwargs внутри функции для передачи переменного количества аргументов.

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

Использование *args и **kwargs по сути обеспечивает читабельность и удобство, но их следует использовать с осторожностью.