What does ** (double star/asterisk) and * (star/asterisk) do for parameters?

Что *args и **kwargs означают в этих определениях функций?

def foo(x, y, *args):
    pass

def bar(x, y, **kwargs):
    pass

_{Смотрите Что означают ** (двойная звезда / asterisk) и * (звезда / asterisk) в вызове функции? дополнительный вопрос об аргументах.}

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

*args Предоставит вам все позиционные аргументы в виде кортежа:

def foo(*args):
    for a in args:
        print(a)        

foo(1)
# 1

foo(1, 2, 3)
# 1
# 2
# 3

Интернет **kwargs даст вам все
аргументы ключевого слова в словарь:

def bar(**kwargs):
    for a in kwargs:
        print(a, kwargs[a])  

bar(name='one', age=27)
# name one
# age 27

Обе идиомы можно смешивать с обычными аргументами, чтобы разрешить набор фиксированных и некоторых переменных аргументов:

def foo(kind, *args, bar=None, **kwargs):
    print(kind, args, bar, kwargs)

foo(123, 'a', 'b', apple='red')
# 123 ('a', 'b') None {'apple': 'red'}

Также возможно использовать это наоборот:

def foo(a, b, c):
    print(a, b, c)

obj = {'b':10, 'c':'lee'}

foo(100, **obj)
# 100 10 lee

Другое использование *l идиомы - распаковывать списки аргументов при вызове функции.

def foo(bar, lee):
    print(bar, lee)

baz = [1, 2]

foo(*baz)
# 1 2

В Python 3 можно использовать *l в левой части присваивания (расширенная итеративная распаковка), хотя в данном контексте это дает список вместо кортежа:

first, *rest = [1, 2, 3, 4]
# first = 1
# rest = [2, 3, 4]

Также Python 3 добавляет новую семантику (см. PEP 3102):

def func(arg1, arg2, arg3, *, kwarg1, kwarg2):
    pass

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

Примечание:

Python dict, семантически используемый для передачи аргументов ключевых слов, имеет произвольный порядок. Однако в Python 3.6+ аргументы ключевых слов гарантированно запоминают порядок вставки. "Порядок элементов в **kwargs теперь соответствует порядку, в котором аргументы ключевых слов были переданы функции". - Что нового в Python 3.6. Фактически, все dicts в CPython 3.6 будут запоминать порядок вставки как деталь реализации, и это становится стандартом в Python 3.7.

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

def foo(x,y,z):
    print("x=" + str(x))
    print("y=" + str(y))
    print("z=" + str(z))

Вы можете делать такие вещи, как:

>>> mylist = [1,2,3]
>>> foo(*mylist)
x=1
y=2
z=3

>>> mydict = {'x':1,'y':2,'z':3}
>>> foo(**mydict)
x=1
y=2
z=3

>>> mytuple = (1, 2, 3)
>>> foo(*mytuple)
x=1
y=2
z=3

Примечание: Ключи в mydict должны называться точно так же, как параметры функции foo. В противном случае это вызовет TypeError:

>>> mydict = {'x':1,'y':2,'z':3,'badnews':9}
>>> foo(**mydict)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got an unexpected keyword argument 'badnews'

Одиночный * означает, что может быть любое количество дополнительных позиционных аргументов. foo() может вызываться как foo(1,2,3,4,5) . В теле foo() param2 - последовательность, содержащая 2-5 .

Двойная ** означает, что может быть любое количество дополнительных именованных параметров. bar() может вызываться как bar(1, a=2, b=3). В теле bar() param2 находится словарь, содержащий {'a':2, 'b':3 }

Со следующим кодом:

def foo(param1, *param2):
    print(param1)
    print(param2)

def bar(param1, **param2):
    print(param1)
    print(param2)

foo(1,2,3,4,5)
bar(1,a=2,b=3)

результат таков

1
(2, 3, 4, 5)
1
{'a': 2, 'b': 3}

Что ** (двойная звезда) и * (star) делают для параметров?

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

Определение функций

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

**kwargs допускает любое количество необязательных аргументов ключевого слова (parameters), которые будут находиться в dict с именем kwargs.

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

Расширение, передача любого количества аргументов

Вы также можете использовать *args и **kwargs для передачи параметров из списков (или любых итерируемых) и dicts (или любого сопоставления) соответственно.

Функция, получающая параметры, не обязательно должна знать, что они расширяются.

Например, xrange в Python 2 явно не ожидает *args, но поскольку он принимает 3 целых числа в качестве аргументов:

>>> x = xrange(3) # create our *args - an iterable of 3 integers
>>> xrange(*x)    # expand here
xrange(0, 2, 2)

В качестве другого примера мы можем использовать расширение dict в str.format:

>>> foo = 'FOO'
>>> bar = 'BAR'
>>> 'this is foo, {foo} and bar, {bar}'.format(**locals())
'this is foo, FOO and bar, BAR'

Новое в Python 3: определение функций с аргументами только для ключевых слов

У вас могут быть аргументы только для ключевых слов после *args - например, здесь, kwarg2 должно быть указано в качестве аргумента ключевого слова - не позиционно:

def foo(arg, kwarg=None, *args, kwarg2=None, **kwargs): 
    return arg, kwarg, args, kwarg2, kwargs

Использование:

>>> foo(1,2,3,4,5,kwarg2='kwarg2', bar='bar', baz='baz')
(1, 2, (3, 4, 5), 'kwarg2', {'bar': 'bar', 'baz': 'baz'})

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

def foo(arg, kwarg=None, *, kwarg2=None, **kwargs): 
    return arg, kwarg, kwarg2, kwargs

Здесь, kwarg2 снова должно быть явно названное ключевое слово-аргумент:

>>> foo(1,2,kwarg2='kwarg2', foo='foo', bar='bar')
(1, 2, 'kwarg2', {'foo': 'foo', 'bar': 'bar'})

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

>>> foo(1,2,3,4,5, kwarg2='kwarg2', foo='foo', bar='bar')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() takes from 1 to 2 positional arguments 
    but 5 positional arguments (and 1 keyword-only argument) were given

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

def bar(*, kwarg=None): 
    return kwarg

В этом примере мы видим, что если мы попытаемся передать kwarg позиционно, мы получим ошибку:

>>> bar('kwarg')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: bar() takes 0 positional arguments but 1 was given

Мы должны явно передать kwarg параметр в качестве ключевого аргумента.

>>> bar(kwarg='kwarg')
'kwarg'

Демонстрации, совместимые с Python 2

*args (обычно говорят "звездные аргументы") и **kwargs (звездочки могут подразумеваться при слове "kwargs", но должны быть явно выражены с помощью "double-star kwargs") являются распространенными идиомами Python для использования обозначений * и **. Эти конкретные имена переменных не требуются (например, вы могли бы использовать *foos и **bars), но отход от соглашения, вероятно, приведет в ярость ваших коллег-программистов на Python.

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

Пример 1

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

def foo(a, b=10, *args, **kwargs):
    '''
    this function takes required argument a, not required keyword argument b
    and any number of unknown positional arguments and keyword arguments after
    '''
    print('a is a required argument, and its value is {0}'.format(a))
    print('b not required, its default value is 10, actual value: {0}'.format(b))
    # we can inspect the unknown arguments we were passed:
    #  - args:
    print('args is of type {0} and length {1}'.format(type(args), len(args)))
    for arg in args:
        print('unknown arg: {0}'.format(arg))
    #  - kwargs:
    print('kwargs is of type {0} and length {1}'.format(type(kwargs),
                                                        len(kwargs)))
    for kw, arg in kwargs.items():
        print('unknown kwarg - kw: {0}, arg: {1}'.format(kw, arg))
    # But we don't have to know anything about them 
    # to pass them to other functions.
    print('Args or kwargs can be passed without knowing what they are.')
    # max can take two or more positional args: max(a, b, c...)
    print('e.g. max(a, b, *args) \n{0}'.format(
      max(a, b, *args))) 
    kweg = 'dict({0})'.format( # named args same as unknown kwargs
      ', '.join('{k}={v}'.format(k=k, v=v) 
                             for k, v in sorted(kwargs.items())))
    print('e.g. dict(**kwargs) (same as {kweg}) returns: \n{0}'.format(
      dict(**kwargs), kweg=kweg))

Мы можем проверить онлайн-справку на предмет подписи функции с помощью help(foo), которая сообщает нам

foo(a, b=10, *args, **kwargs)

Давайте вызовем эту функцию с помощью foo(1, 2, 3, 4, e=5, f=6, g=7)

который выводит:

a is a required argument, and its value is 1
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 2
unknown arg: 3
unknown arg: 4
kwargs is of type <type 'dict'> and length 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: g, arg: 7
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args) 
4
e.g. dict(**kwargs) (same as dict(e=5, f=6, g=7)) returns: 
{'e': 5, 'g': 7, 'f': 6}

Пример 2

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

def bar(a):
    b, c, d, e, f = 2, 3, 4, 5, 6
    # dumping every local variable into foo as a keyword argument 
    # by expanding the locals dict:
    foo(**locals()) 

bar(100) С принтами:

a is a required argument, and its value is 100
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 0
kwargs is of type <type 'dict'> and length 4
unknown kwarg - kw: c, arg: 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: d, arg: 4
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args) 
100
e.g. dict(**kwargs) (same as dict(c=3, d=4, e=5, f=6)) returns: 
{'c': 3, 'e': 5, 'd': 4, 'f': 6}

Пример 3: практическое использование в декораторах

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

def foo(a, b, c, d=0, e=100):
    # imagine this is much more code than a simple function call
    preprocess() 
    differentiating_process_foo(a,b,c,d,e)
    # imagine this is much more code than a simple function call
    postprocess()

def bar(a, b, c=None, d=0, e=100, f=None):
    preprocess()
    differentiating_process_bar(a,b,c,d,e,f)
    postprocess()

def baz(a, b, c, d, e, f):
    ... and so on

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

def decorator(function):
    '''function to wrap other functions with a pre- and postprocess'''
    @functools.wraps(function) # applies module, name, and docstring to wrapper
    def wrapper(*args, **kwargs):
        # again, imagine this is complicated, but we only write it once!
        preprocess()
        function(*args, **kwargs)
        postprocess()
    return wrapper

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

@decorator
def foo(a, b, c, d=0, e=100):
    differentiating_process_foo(a,b,c,d,e)

@decorator
def bar(a, b, c=None, d=0, e=100, f=None):
    differentiating_process_bar(a,b,c,d,e,f)

@decorator
def baz(a, b, c=None, d=0, e=100, f=None, g=None):
    differentiating_process_baz(a,b,c,d,e,f, g)

@decorator
def quux(a, b, c=None, d=0, e=100, f=None, g=None, h=None):
    differentiating_process_quux(a,b,c,d,e,f,g,h)

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