Следующие аргументы функций, вероятно, самые распространенные, которые ставят вас в тупик, когда вы смотрите на код Python и говорите: «Что это?
*args**kwargs
Любое количество аргументов (аргументы переменной длины) можно указать, добавив звездочку к аргументу в определении функции следующим образом
***
Имена *args,**kwargs часто используются в качестве условного обозначения. Однако допустимы и другие имена, если в начале стоят * и **. В следующем примере кода используются имена *args,**kwargs.
Ниже приводится подробное описание.
*args:Принимает несколько аргументов в виде кортежа**kwargs:Принимает несколько аргументов ключевых слов в виде словаря
*args: Принимает несколько аргументов в виде кортежа
Произвольное количество аргументов может быть задано путем определения аргументов с помощью *, как в *args.
def my_sum(*args):
return sum(args)
print(my_sum(1, 2, 3, 4))
# 10
print(my_sum(1, 2, 3, 4, 5, 6, 7, 8))
# 36
Несколько аргументов принимаются в функцию в виде кортежа. В примере функции sum() передается кортеж для вычисления суммы.
def my_sum2(*args):
print('args: ', args)
print('type: ', type(args))
print('sum : ', sum(args))
my_sum2(1, 2, 3, 4)
# args: (1, 2, 3, 4)
# type: <class 'tuple'>
# sum : 10
Его также можно сочетать с аргументацией позиции.
Значение, указанное после (справа от) позиционного аргумента, передается в args в виде кортежа. Если имеется только позиционный аргумент, то это пустой кортеж.
def func_args(arg1, arg2, *args):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('args: ', args)
func_args(0, 1, 2, 3, 4)
# arg1: 0
# arg2: 1
# args: (2, 3, 4)
func_args(0, 1)
# arg1: 0
# arg2: 1
# args: ()
Аргументы, отмеченные *, могут быть определены первыми. Однако в этом случае аргументы, определенные позже *args, должны быть указаны в форме ключевого слова. Кстати, формат ключевого слова — это форма «имя аргумента = значение».
Последнее значение не передается автоматически в позиционный аргумент. Поэтому, если оно не указано в качестве аргумента ключевого слова, возникнет ошибка TypeError.
def func_args2(arg1, *args, arg2):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('args: ', args)
# func_args2(0, 1, 2, 3, 4)
# TypeError: func_args2() missing 1 required keyword-only argument: 'arg2'
func_args2(0, 1, 2, 3, arg2=4)
# arg1: 0
# arg2: 4
# args: (1, 2, 3)
Если указаны только * аргументы, последующие аргументы всегда должны быть указаны как аргументы ключевого слова.(keyword-only argument)
def func_args_kw_only(arg1, *, arg2):
print('arg1: ', arg1)
print('arg2: ', arg2)
# func_args_kw_only(100, 200)
# TypeError: func_args_kw_only() takes 1 positional argument but 2 were given
func_args_kw_only(100, arg2=200)
# arg1: 100
# arg2: 200
**kwargs: Принимает несколько аргументов ключевых слов в виде словаря
Произвольное количество ключевых аргументов может быть задано путем определения аргументов через ,**, как в **kwargs.
В функции имя аргумента принимается как словарь, ключ которого является ключом, а значение — значением.
def func_kwargs(**kwargs):
print('kwargs: ', kwargs)
print('type: ', type(kwargs))
func_kwargs(key1=1, key2=2, key3=3)
# kwargs: {'key1': 1, 'key2': 2, 'key3': 3}
# type: <class 'dict'>
Его также можно использовать в сочетании с аргументацией позиции.
def func_kwargs_positional(arg1, arg2, **kwargs):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('kwargs: ', kwargs)
func_kwargs_positional(0, 1, key1=1)
# arg1: 0
# arg2: 1
# kwargs: {'key1': 1}
Указав объект словаря с ** в качестве аргумента при вызове функции, можно расширить его и передать в качестве соответствующего аргумента.
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
Аргументы, помеченные **, могут быть определены только в конце аргумента. Определение другого аргумента после аргумента, помеченного **, приведет к ошибке SyntaxError.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax
