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

2353

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

def foo(param1, *param2):
def bar(param1, **param2):
Тодд
источник
4
см. также stackoverflow.com/questions/6967632/…
Аарон Холл
См. Также stackoverflow.com/questions/14301967/… для голой звездочки
naught101
24
Этот вопрос является очень популярной двойной целью, но, к сожалению, он часто используется неправильно. Имейте в виду, что этот вопрос задает вопрос об определении функций с помощью varargs ( def func(*args)). Для вопроса , спрашивая , что это означает , что в функции вызовов ( func(*[1,2])) см здесь . С вопросом, как распаковать списки аргументов, можно ознакомиться здесь . С вопросом о том, что *означает литерал ( [*[1, 2]]), можно ознакомиться здесь .
Аран-Фей
Вы можете узнать о его использовании в определении функции и вызове функции здесь: pythontips.com/2013/08/04/args-and-kwargs-in-python-explained
Акшай Анураг

Ответы:

2239

*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)
# age 27
# name one

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

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

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

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)

l = [1,2]

foo(*l)
# 1 2

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

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

Питер Хоффманн
источник
9
Выходные данные [6] находятся в обратном порядке. назвать один возраст 27
thanos.a
54
@ thanos.a Диконы Python, семантически используемые для передачи аргументов ключевых слов, произвольно упорядочены. Однако в Python 3.6 аргументы ключевых слов гарантированно запоминают порядок вставки. «Порядок элементов **kwargsтеперь соответствует порядку, в котором аргументы ключевых слов были переданы функции». - docs.python.org/3/whatsnew/3.6.html Фактически, все диктанты в CPython 3.6 будут помнить порядок вставки в качестве детали реализации, это становится стандартным в Python 3.7.
Аарон Холл
13
Очень точный, чистый и понятный. Я ценю, что вы заметили, что это «оператор распаковки», так что я могу отличить его от передачи по ссылке в C. +1
bballdave025
Как проверить последнюю функцию с помощью PEP 3102? Я называю это с помощью func (1,2,3, name = "me", age = 10), и оно выдает исключение:got an unexpected keyword argument 'name'
Kok How Teh
@KokHowTeh Вы должны передать именованные kwargs, как они есть в функции: func (1, 2, 3, kwarg1 = 'me', kwarg2 = 10)
Джон Аарон
622

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

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'
Лорин Хохштайн
источник
175

Один * означает, что может быть любое количество дополнительных позиционных аргументов. 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}
nickd
источник
5
Возможно, foobar(param1, *param2, **param3)для полноты ответа необходим дополнительный пример с .
Аникет Тхакур
1
@AniketThakur добавил оставшуюся часть здесь .
Радж
148

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

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

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

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

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

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

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

Аарон Холл
источник
48

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

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
---------------------------------

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

Теперь давайте изучим оператор '*' и оператор **.

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

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

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

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

Давайте перейдем непосредственно к примеру и обсудим его.

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

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

Итак, помните:

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

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

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

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

Каран Ахуджа
источник
Действительно чистое, пошаговое и понятное объяснение!
Александар
Спасибо! Держите поднятые голоса. [Также для дальнейших заметок от меня, я на @mrtechmaker в твиттере]
Каран Ахуджа
32

Эта таблица удобна для использования *и **при построении функций, и при вызове функций :

            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)                   |
-----------------------------------------------------------------------

Это действительно просто, чтобы подвести итог ответа Лорин Хохштайн, но я считаю его полезным.

В связи с этим: использование для операторов star / splat было расширено в Python 3

Брэд Соломон
источник
22

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

Ронак
источник
17

Для тех из вас, кто учится на примерах!

  1. Цель * состоит в том, чтобы дать вам возможность определить функцию, которая может принимать произвольное количество аргументов, представленных в виде списка (например,f(*myList) ).
  2. Цель **состоит в том, чтобы дать вам возможность передать аргументы функции, предоставив словарь (например f(**{'x' : 1, 'y' : 2})).

Покажем это, определив функцию , которая принимает два нормальных переменных x, yи может принять больше аргументов , как myArgs, и может принять еще больше аргументов , как myKW. Позже мы покажем, как кормить yс помощью myArgDict.

def f(x, y, *myArgs, **myKW):
    print("# x      = {}".format(x))
    print("# y      = {}".format(y))
    print("# myArgs = {}".format(myArgs))
    print("# myKW   = {}".format(myKW))
    print("# ----------------------------------------------------------------------")

# Define a list for demonstration purposes
myList    = ["Left", "Right", "Up", "Down"]
# Define a dictionary for demonstration purposes
myDict    = {"Wubba": "lubba", "Dub": "dub"}
# Define a dictionary to feed y
myArgDict = {'y': "Why?", 'y0': "Why not?", "q": "Here is a cue!"}

# The 1st elem of myList feeds y
f("myEx", *myList, **myDict)
# x      = myEx
# y      = Left
# myArgs = ('Right', 'Up', 'Down')
# myKW   = {'Wubba': 'lubba', 'Dub': 'dub'}
# ----------------------------------------------------------------------

# y is matched and fed first
# The rest of myArgDict becomes additional arguments feeding myKW
f("myEx", **myArgDict)
# x      = myEx
# y      = Why?
# myArgs = ()
# myKW   = {'y0': 'Why not?', 'q': 'Here is a cue!'}
# ----------------------------------------------------------------------

# The rest of myArgDict becomes additional arguments feeding myArgs
f("myEx", *myArgDict)
# x      = myEx
# y      = y
# myArgs = ('y0', 'q')
# myKW   = {}
# ----------------------------------------------------------------------

# Feed extra arguments manually and append even more from my list
f("myEx", 4, 42, 420, *myList, *myDict, **myDict)
# x      = myEx
# y      = 4
# myArgs = (42, 420, 'Left', 'Right', 'Up', 'Down', 'Wubba', 'Dub')
# myKW   = {'Wubba': 'lubba', 'Dub': 'dub'}
# ----------------------------------------------------------------------

# Without the stars, the entire provided list and dict become x, and y:
f(myList, myDict)
# x      = ['Left', 'Right', 'Up', 'Down']
# y      = {'Wubba': 'lubba', 'Dub': 'dub'}
# myArgs = ()
# myKW   = {}
# ----------------------------------------------------------------------

Предостережения

  1. ** исключительно зарезервировано для словарей.
  2. Необязательное назначение аргумента происходит первым.
  3. Вы не можете использовать необязательный аргумент дважды.
  4. Если применимо, **должен прийти после *, всегда.
Miladiouss
источник
14

Из документации Python:

Если позиционных аргументов больше, чем слотов формальных параметров, возникает исключение TypeError, если только нет формального параметра, использующего синтаксис "* identifier"; в этом случае этот формальный параметр получает кортеж, содержащий избыточные позиционные аргументы (или пустой кортеж, если не было лишних позиционных аргументов).

Если какой-либо аргумент ключевого слова не соответствует формальному имени параметра, возникает исключение TypeError, если только не присутствует формальный параметр, использующий синтаксис «** идентификатор»; в этом случае этот формальный параметр получает словарь, содержащий избыточные аргументы ключевого слова (используя ключевые слова в качестве ключей и значения аргументов в качестве соответствующих значений), или (новый) пустой словарь, если не было избыточных аргументов ключевого слова.

Крис Упчерч
источник
10

* означает получить переменные аргументы как кортеж

** означает получать переменные аргументы как словарь

Используется как следующее:

1) одиночный *

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

foo("two", 3)

Вывод:

two
3

2) Сейчас **

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

bar(dic1="two", dic2=3)

Вывод:

dic1 two
dic2 3
ishandutta2007
источник
8

Я хочу привести пример, который другие не упомянули

* также можно распаковать генератор

Пример из Документа Python3

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

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

unzip_x будет [1, 2, 3], unzip_y будет [4, 5, 6]

Zip () получает несколько аргументов iretable и возвращает генератор.

zip(*zip(x,y)) -> zip((1, 4), (2, 5), (3, 6))
Лохуан Чанг
источник
7

В Python 3.5, вы также можете использовать этот синтаксис list, dict, tupleи setдисплеи (также иногда называемые литералов). См. PEP 488: Дополнительные обобщения распаковки .

>>> (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}

Это также позволяет распаковывать несколько итераций за один вызов функции.

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

(Спасибо mgilson за ссылку PEP.)

leewz
источник
1
Я не уверен, что это нарушение «есть только один способ сделать это». Нет другого способа инициализировать список / кортеж из нескольких итераций - вам нужно объединить их в одну итерацию, что не всегда удобно. Вы можете прочитать о рациональном в PEP-0448 . Кроме того, это не функция python3.x, а функция python3.5 + :-).
Мгилсон
@mgilson, это объясняет, почему это не упоминалось раньше.
leewz
6

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

Например,

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])

Подкласс может быть

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

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

Подкласс затем будет создан как

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

Кроме того, подкласс с новым атрибутом, который имеет смысл только для этого экземпляра подкласса, может вызывать базовый класс __init__для разгрузки настройки атрибутов. Это делается с помощью * args и ** kwargs. kwargs в основном используется для того, чтобы код читался с использованием именованных аргументов. Например,

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)

которые могут быть установлены как

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

Полный код здесь

quiet_penguin
источник
1
1. По сути, init - это метод, поэтому (в этом контексте) он на самом деле не отличается. 2. Используйте # для комментариев, а не "" ", который просто помечает буквенные строки. 3. Использование super должно быть предпочтительным способом, особенно для вашего примера с многоуровневым наследованием.
0xc0de
4

Опираясь на ответ Никда ...

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


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


def three_params(param1, *param2, **param3):
    print(param1)
    print(param2)
    print(param3)


foo(1, 2, 3, 4, 5)
print("\n")
bar(1, a=2, b=3)
print("\n")
three_params(1, 2, 3, 4, s=5)

Вывод:

1
(2, 3, 4, 5)

1
{'a': 2, 'b': 3}

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

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

Радж
источник
3

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

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

def args(normal_arg, *argv):
    print("normal argument:", normal_arg)

    for arg in argv:
        print("Argument in list of arguments from *argv:", arg)

args('animals', 'fish', 'duck', 'bird')

Будет производить:

normal argument: animals
Argument in list of arguments from *argv: fish
Argument in list of arguments from *argv: duck
Argument in list of arguments from *argv: bird

**kwargs*

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

def who(**kwargs):
    if kwargs is not None:
        for key, value in kwargs.items():
            print("Your %s is %s." % (key, value))

who(name="Nikola", last_name="Tesla", birthday="7.10.1856", birthplace="Croatia")  

Будет производить:

Your name is Nikola.
Your last_name is Tesla.
Your birthday is 7.10.1856.
Your birthplace is Croatia.
Харви
источник
2

Этот пример поможет вам вспомнить *args, **kwargsи даже superи наследование в Python сразу.

class base(object):
    def __init__(self, base_param):
        self.base_param = base_param


class child1(base): # inherited from base class
    def __init__(self, child_param, *args) # *args for non-keyword args
        self.child_param = child_param
        super(child1, self).__init__(*args) # call __init__ of the base class and initialize it with a NON-KEYWORD arg

class child2(base):
    def __init__(self, child_param, **kwargs):
        self.child_param = child_param
        super(child2, self).__init__(**kwargs) # call __init__ of the base class and initialize it with a KEYWORD arg

c1 = child1(1,0)
c2 = child2(1,base_param=0)
print c1.base_param # 0
print c1.child_param # 1
print c2.base_param # 0
print c2.child_param # 1
thanhtang
источник
1

Хороший пример использования обоих в функции:

>>> 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

TL; DR

Ниже приведены 6 различных вариантов использования для *и **в питона программирования:

  1. Чтобы принять любое количество позиционных аргументов, используя *args:, def foo(*args): pass здесь fooпринимает любое количество позиционных аргументов, т.е. допустимы следующие вызовы foo(1),foo(1, 'bar')
  2. Чтобы принять любое количество аргументов ключевого слова, используя **kwargs:, def foo(**kwargs): pass здесь 'foo' принимает любое количество аргументов ключевого слова, т. Е. Допустимы следующие вызовы foo(name='Tom'),foo(name='Tom', age=33)
  3. Чтобы принять любое количество позиционных и ключевых аргументов, используя *args, **kwargs:, def foo(*args, **kwargs): pass здесь fooпринимает любое количество позиционных и ключевых аргументов, т.е. допустимы следующие вызовы foo(1,name='Tom'),foo(1, 'bar', name='Tom', age=33)
  4. Чтобы принудительно использовать аргументы только для ключевых слов, используя *:, def foo(pos1, pos2, *, kwarg1): pass здесь *означает, что foo принимает аргументы только из ключевых слов после pos2, следовательно, foo(1, 2, 3)вызывает TypeError, но foo(1, 2, kwarg1=3)это нормально.
  5. Чтобы больше не интересоваться более позиционными аргументами, используя *_(Примечание: это только соглашение): def foo(bar, baz, *_): pass означает (по соглашению) fooтолько использование barиbaz аргументы в своей работе и игнорирование других.
  6. Чтобы больше не интересоваться дополнительными аргументами ключевых слов, используя \**_(Примечание: это только соглашение): def foo(bar, baz, **_): pass означает (по соглашению) fooтолько использование barи bazаргументы в своей работе и игнорирование других.

БОНУС: Начиная с Python 3.8, можно использовать /в определении функции для обеспечения только позиционных параметров. В следующем примере параметры a и b являются только позиционными , в то время как c или d могут быть позиционными или ключевыми словами, а e или f должны быть ключевыми словами:

def f(a, b, /, c, d, *, e, f):
    pass
Мейсам Садеги
источник
0

TL; DR

Он упаковывает аргументы, переданные функции, в тело функции listи, dictсоответственно, внутри него. Когда вы определяете сигнатуру функции следующим образом:

def func(*args, **kwds):
    # do stuff

он может быть вызван с любым количеством аргументов и аргументов ключевого слова. Аргументы без ключевых слов упаковываются в список, вызываемый argsвнутри тела функции, а аргументы с ключевыми словами упаковываются в dict, вызываемый kwdsвнутри тела функции.

func("this", "is a list of", "non-keyowrd", "arguments", keyword="ligma", options=[1,2,3])

Теперь внутри тела функции, когда функция вызывается, есть две локальные переменные, argsкоторая представляет собой список , имеющий значение ["this", "is a list of", "non-keyword", "arguments"]и kwdsкоторый представляет собой dictимеющее значение{"keyword" : "ligma", "options" : [1,2,3]}


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

def f(a, b, c, d=1, e=10):
    # do stuff

Вы можете вызвать его, распаковав итерации или сопоставления, которые есть в области вызова:

iterable = [1, 20, 500]
mapping = {"d" : 100, "e": 3}
f(*iterable, **mapping)
# That call is equivalent to
f(1, 20, 500, d=100, e=3)
RBF06
источник
0

контекст

  • Python 3.x
  • распаковка с **
  • использовать с форматированием строки

Использовать с форматированием строки

В дополнение к ответам в этой теме, здесь есть еще одна деталь, которая не упоминалась где-либо еще. Это расширяет ответ Брэда Соломона

Распаковка с помощью **также полезна при использовании python str.format.

Это несколько похоже на то, что вы можете сделать с Python f-strings F-строки но с дополнительными накладными расходами объявления объявления для хранения переменных (f-строка не требует dict).

Быстрый пример

  ## init vars
  ddvars = dict()
  ddcalc = dict()
  pass
  ddvars['fname']     = 'Huomer'
  ddvars['lname']     = 'Huimpson'
  ddvars['motto']     = 'I love donuts!'
  ddvars['age']       = 33
  pass
  ddcalc['ydiff']     = 5
  ddcalc['ycalc']     = ddvars['age'] + ddcalc['ydiff']
  pass
  vdemo = []

  ## ********************
  ## single unpack supported in py 2.7
  vdemo.append('''
  Hello {fname} {lname}!

  Today you are {age} years old!

  We love your motto "{motto}" and we agree with you!
  '''.format(**ddvars)) 
  pass

  ## ********************
  ## multiple unpack supported in py 3.x
  vdemo.append('''
  Hello {fname} {lname}!

  In {ydiff} years you will be {ycalc} years old!
  '''.format(**ddvars,**ddcalc)) 
  pass

  ## ********************
  print(vdemo[-1])
dreftymac
источник
-2
  • def foo(param1, *param2):метод может принимать произвольное количество значений для *param2,
  • def bar(param1, **param2): метод может принимать произвольное количество значений с ключами для *param2
  • param1 это простой параметр.

Например, синтаксис для реализации varargs в Java выглядит следующим образом:

accessModifier methodName(datatype arg) {
    // method body
}
Premraj
источник