Вопрос: Что делает ** (двойная звезда / звездочка) и * (звезда / звездочка) для параметров?


В следующих определениях методов, что *а также **делать для param2?

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

1519


источник


Ответы:


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

*argsдаст вам все функциональные параметры как кортеж :

In [1]: def foo(*args):
   ...:     for a in args:
   ...:         print a
   ...:         
   ...:         

In [2]: foo(1)
1


In [4]: foo(1,2,3)
1
2
3

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

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

In [6]: bar(name='one', age=27)
age 27
name one

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

def foo(kind, *args, **kwargs):
   pass

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

In [9]: def foo(bar, lee):
   ...:     print bar, lee
   ...:     
   ...:     

In [10]: l = [1,2]

In [11]: foo(*l)
1 2

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

first, *rest = [1,2,3,4]
first, *l, last = [1,2,3,4]

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

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

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


1501



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

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'

433



Единый * означает, что может быть любое количество дополнительных позиционных аргументов. 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}

123



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

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

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

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

**kwargsдопускает любое количество необязательных аргументов (параметров) ключевого слова, которые будут в 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», но быть явными с «двойными звездами») являются общими идиомами Python для использования *а также **нотации. Эти конкретные имена переменных не требуются (например, вы можете использовать *foosа также **bars), но отход от конвенции, вероятно, вызовет поражение ваших коллег-питонов.

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

Пример 1

Следующая функция описывает, как их можно использовать и демонстрирует поведение. Обратите внимание на 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позволяет нам делать, мы сокращаем строки кода, улучшаем читаемость и ремонтопригодность, и имеем единственные канонические места для логики нашей программы. Если нам нужно изменить какую-либо часть этой структуры, у нас есть одно место, в котором можно произвести каждое изменение.


103



Давайте сначала поймем, что такое позиционные аргументы и аргументы ключевых слов. Ниже приведен пример определения функции с Позиционные аргументы.

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

test(1,2,3)
#output:
1
2
3

Таким образом, это определение функции с позиционными аргументами. Вы также можете вызвать его с помощью ключевых слов / названных аргументов:

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

test(a=1,b=2,c=3)
#output:
1
2
3

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

def test(a=0,b=0,c=0):
     print(a)
     print(b)
     print(c)
     print('-------------------------')

test(a=1,b=2,c=3)
#output :
1
2
3
-------------------------

Вы можете также вызвать эту функцию с помощью позиционных аргументов:

def test(a=0,b=0,c=0):
    print(a)
    print(b)
    print(c)
    print('-------------------------')

test(1,2,3)
# output :
1
2
3
---------------------------------

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

Теперь рассмотрим оператор «*» и оператор «**».

Обратите внимание, что эти операторы могут использоваться в двух областях:

а) вызов функции

б) определение функции

Использование оператора «*» и оператора «**» в вызов функции.

Обратимся к примеру, а затем обсудим его.

def sum(a,b):  #receive args from function calls as sum(1,2) or sum(a=1,b=2)
    print(a+b)

my_tuple = (1,2)
my_list = [1,2]
my_dict = {'a':1,'b':2}

# Let us unpack data structure of list or tuple or dict into arguments with help of '*' operator
sum(*my_tuple)   # becomes same as sum(1,2) after unpacking my_tuple with '*'
sum(*my_list)    # becomes same as sum(1,2) after unpacking my_list with  '*'
sum(**my_dict)   # becomes same as sum(a=1,b=2) after unpacking by '**' 

# output is 3 in all three calls to sum function.

Так что помните

когда оператор '*' или '**' используется в вызов функции -

Оператор '*' распаковывает структуру данных, такую ​​как список или кортеж, в аргументы, необходимые для определения функции.

Оператор «**» распаковывает словарь в аргументы, необходимые для определения функции.

Теперь давайте изучим использование оператора «*» в определение функции , Пример:

def sum(*args): #pack the received positional args into data structure of tuple. after applying '*' - def sum((1,2,3,4))
    sum = 0
    for a in args:
        sum+=a
    print(sum)

sum(1,2,3,4)  #positional args sent to function sum
#output:
10

В функции определение оператор '*' упаковывает полученные аргументы в кортеж.

Теперь давайте рассмотрим пример «**», используемый в определении функции:

def sum(**args): #pack keyword args into datastructure of dict after applying '**' - def sum({a:1,b:2,c:3,d:4})
    sum=0
    for k,v in args.items():
        sum+=v
    print(sum)

sum(a=1,b=2,c=3,d=4) #positional args sent to function sum

В функции определение Оператор '**' упаковывает полученные аргументы в словарь.

Поэтому помните:

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

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

В определение функции '*' пакеты позиционные аргументы в кортеж.

В определение функции '**' пакеты ключевые слова в словаре.


34



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


20



From the Python documentation:

If there are more positional arguments than there are formal parameter slots, a TypeError exception is raised, unless a formal parameter using the syntax "*identifier" is present; in this case, that formal parameter receives a tuple containing the excess positional arguments (or an empty tuple if there were no excess positional arguments).

If any keyword argument does not correspond to a formal parameter name, a TypeError exception is raised, unless a formal parameter using the syntax "**identifier" is present; in this case, that formal parameter receives a dictionary containing the excess keyword arguments (using the keywords as keys and the argument values as corresponding values), or a (new) empty dictionary if there were no excess keyword arguments.


11



I want to give an example which others haven't mentioned

* can also unpack a generator

An example from Python3 Document

x = [1, 2, 3]
y = [4, 5, 6]

unzip_x, unzip_y = zip(*zip(x, y))

unzip_x will be [1, 2, 3], unzip_y will be [4, 5, 6]

The zip() receives multiple iretable args, and return a generator.

zip(*zip(x,y)) -> zip((1, 4), (2, 5), (3, 6))

7



While uses for the star/splat operators have been expanded in Python 3, I like the following table as it relates to use of these operators with functions. The splat operator(s) can be used both within function construction and in the function call:

            In function *construction*      In function *call*
=======================================================================
          |  def f(*args):                 |  def f(a, b):
*args     |      for arg in args:          |      return a + b
          |          print(arg)            |  args = (1, 2)
          |  f(1, 2)                       |  f(*args)
----------|--------------------------------|---------------------------
          |  def f(a, b):                  |  def f(a, b):
**kwargs  |      return a + b              |      return a + b
          |  def g(**kwargs):              |  kwargs = dict(a=1, b=2)
          |      return f(**kwargs)        |  f(**kwargs)
          |  g(a=1, b=2)                   |
-----------------------------------------------------------------------

This really just serves to summarize Lorin Hochstein's answer but I find it helpful.


6



In Python 3.5, you can also use this syntax in list, dict, tuple, and set displays (also sometimes called literals). See PEP 488: Additional Unpacking Generalizations.

>>> (0, *range(1, 4), 5, *range(6, 8))
(0, 1, 2, 3, 5, 6, 7)
>>> [0, *range(1, 4), 5, *range(6, 8)]
[0, 1, 2, 3, 5, 6, 7]
>>> {0, *range(1, 4), 5, *range(6, 8)}
{0, 1, 2, 3, 5, 6, 7}
>>> d = {'one': 1, 'two': 2, 'three': 3}
>>> e = {'six': 6, 'seven': 7}
>>> {'zero': 0, **d, 'five': 5, **e}
{'five': 5, 'seven': 7, 'two': 2, 'one': 1, 'three': 3, 'six': 6, 'zero': 0}

It also allows multiple iterables to be unpacked in a single function call.

>>> range(*[1, 10], *[2])
range(1, 10, 2)

(Thanks to mgilson for the PEP link.)


5



In addition to function calls, *args and **kwargs are useful in class hierarchies and also avoid having to write __init__ method in Python. Similar usage can seen in frameworks like Django code.

For example,

def __init__(self, *args, **kwargs):
    for attribute_name, value in zip(self._expected_attributes, args):
        setattr(self, attribute_name, value)
        if kwargs.has_key(attribute_name):
            kwargs.pop(attribute_name)

    for attribute_name in kwargs.viewkeys():
        setattr(self, attribute_name, kwargs[attribute_name])

A subclass can then be

class RetailItem(Item):
    _expected_attributes = Item._expected_attributes + ['name', 'price', 'category', 'country_of_origin']

class FoodItem(RetailItem):
    _expected_attributes = RetailItem._expected_attributes +  ['expiry_date']

The subclass then be instantiated as

food_item = FoodItem(name = 'Jam', 
                     price = 12.0, 
                     category = 'Foods', 
                     country_of_origin = 'US', 
                     expiry_date = datetime.datetime.now())

Also, a subclass with a new attribute which makes sense only to that subclass instance can call the Base class __init__ to offload the attributes setting. This is done through *args and **kwargs. kwargs mainly used so that code is readable using named arguments. For example,

class ElectronicAccessories(RetailItem):
    _expected_attributes = RetailItem._expected_attributes +  ['specifications']
    # Depend on args and kwargs to populate the data as needed.
    def __init__(self, specifications = None, *args, **kwargs):
        self.specifications = specifications  # Rest of attributes will make sense to parent class.
        super(ElectronicAccessories, self).__init__(*args, **kwargs)

which can be instatiated as

usb_key = ElectronicAccessories(name = 'Sandisk', 
                                price = '$6.00', 
                                category = 'Electronics',
                                country_of_origin = 'CN',
                                specifications = '4GB USB 2.0/USB 3.0')

The complete code is here


3



A good example of using both in a function is:

>>> def foo(*arg,**kwargs):
...     print arg
...     print kwargs
>>>
>>> a = (1, 2, 3)
>>> b = {'aa': 11, 'bb': 22}
>>>
>>>
>>> foo(*a,**b)
(1, 2, 3)
{'aa': 11, 'bb': 22}
>>>
>>>
>>> foo(a,**b) 
((1, 2, 3),)
{'aa': 11, 'bb': 22}
>>>
>>>
>>> foo(a,b) 
((1, 2, 3), {'aa': 11, 'bb': 22})
{}
>>>
>>>
>>> foo(a,*b)
((1, 2, 3), 'aa', 'bb')
{}

1