Что ** (двойная звезда / звездочка) и * (звездочка / звездочка) делают для параметров? - PullRequest
1952 голосов
/ 31 августа 2008

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

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

Ответы [ 18 ]

1870 голосов
/ 31 августа 2008

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

532 голосов
/ 31 августа 2008

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

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'
156 голосов
/ 31 августа 2008

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

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

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

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

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

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

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

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

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

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

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

43 голосов
/ 20 января 2016

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

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 областях:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

21 голосов
/ 11 сентября 2012

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

16 голосов
/ 30 ноября 2017

Хотя в Python 3 используются операторы типа «звезда» / «splat» расширен , мне нравится следующая таблица, поскольку она касается использования этих операторов с функциями . Оператор сплат может использоваться как внутри функции конструкция , так и в функции вызов :

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

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

15 голосов
/ 22 мая 2018

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

  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. Если применимо, ** должно идти после *, всегда.
12 голосов
/ 31 августа 2008

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

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

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

7 голосов
/ 08 ноября 2016

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

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

Пример из документа 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))
...