Що робить **
(подвійна зірка) і *
(зірка) для параметрів
Вони дозволяють визначати функції, які приймають, а користувачі передають будь-яку кількість аргументів, позиційних ( *
) та ключових слів ( **
).
Визначення функцій
*args
дозволяє будь-яку кількість необов'язкових позиційних аргументів (параметрів), які будуть присвоєні кордону з назвою args
.
**kwargs
допускає будь-яку кількість необов'язкових аргументів ключових слів (параметрів), які будуть міститись у назвою dict 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", але бути явними з "double-star 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
дозволяє нам це робити, ми зменшуємо рядки коду, покращуємо читабельність та ремонтопридатність та маємо єдині канонічні місця для логіки в нашій програмі. Якщо нам потрібно змінити будь-яку частину цієї структури, у нас є одне місце, в якому можна внести кожну зміну.