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