Co robi **
(podwójna gwiazda) i *
(gwiazda) dla parametrów
Umożliwiają zdefiniowanie funkcji do zaakceptowania, a użytkownikom przekazanie dowolnej liczby argumentów, pozycyjnej ( *
) i słowa kluczowego ( **
).
Definiowanie funkcji
*args
dopuszcza dowolną liczbę opcjonalnych argumentów pozycyjnych (parametrów), które zostaną przypisane do krotki o nazwie args
.
**kwargs
dopuszcza dowolną liczbę opcjonalnych argumentów (parametrów) słowa kluczowego, które będą w nazwie o nazwie kwargs
.
Możesz (i powinieneś) wybrać dowolną odpowiednią nazwę, ale jeśli intencją jest, aby argumenty miały nieswoistą semantykę args
i kwargs
były standardowymi nazwami.
Rozbudowa, przekazanie dowolnej liczby argumentów
Możesz także użyć *args
i **kwargs
do przekazania parametrów odpowiednio z list (lub dowolnej iterowalnej) i dykt (lub dowolnego odwzorowania).
Funkcja odbierająca parametry nie musi wiedzieć, że są one rozszerzane.
Na przykład xrange w Pythonie 2 nie oczekuje wprost *args
, ale ponieważ jako argument przyjmuje 3 liczby całkowite:
>>> x = xrange(3) # create our *args - an iterable of 3 integers
>>> xrange(*x) # expand here
xrange(0, 2, 2)
Jako kolejny przykład możemy użyć rozszerzenia dict w str.format
:
>>> foo = 'FOO'
>>> bar = 'BAR'
>>> 'this is foo, {foo} and bar, {bar}'.format(**locals())
'this is foo, FOO and bar, BAR'
Nowość w Python 3: Definiowanie funkcji za pomocą argumentów zawierających tylko słowa kluczowe
Możesz mieć tylko słowa kluczowe jako argumenty - po, *args
na przykład, tutaj kwarg2
musisz podać jako słowo kluczowe - nie pozycjonować:
def foo(arg, kwarg=None, *args, kwarg2=None, **kwargs):
return arg, kwarg, args, kwarg2, kwargs
Stosowanie:
>>> foo(1,2,3,4,5,kwarg2='kwarg2', bar='bar', baz='baz')
(1, 2, (3, 4, 5), 'kwarg2', {'bar': 'bar', 'baz': 'baz'})
Ponadto, *
może być stosowany przez siebie słów kluczowych, aby wskazać, że tylko argumenty naśladowania, nie pozwalając na nieograniczone pozycyjnych argumentów.
def foo(arg, kwarg=None, *, kwarg2=None, **kwargs):
return arg, kwarg, kwarg2, kwargs
Tutaj kwarg2
znowu musi być jawnie nazwany argument słowa kluczowego:
>>> foo(1,2,kwarg2='kwarg2', foo='foo', bar='bar')
(1, 2, 'kwarg2', {'foo': 'foo', 'bar': 'bar'})
Nie możemy dłużej akceptować nieograniczonej liczby argumentów pozycyjnych, ponieważ nie mamy *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
Ponownie, prościej, tutaj wymagamy kwarg
podania imienia, a nie pozycji:
def bar(*, kwarg=None):
return kwarg
W tym przykładzie widzimy, że jeśli spróbujemy przekazać kwarg
pozycję, otrzymujemy błąd:
>>> bar('kwarg')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: bar() takes 0 positional arguments but 1 was given
Musimy jawnie przekazać kwarg
parametr jako argument słowa kluczowego.
>>> bar(kwarg='kwarg')
'kwarg'
Dema kompatybilne z Python 2
*args
(zwykle mówi się „star-args”) i **kwargs
(gwiazdy można sugerować, mówiąc „kwargs”, ale wyraźne w przypadku „podwójnej gwiazdy kwargs”) są powszechnymi idiomami Pythona do używania *
i **
notacji. Te specyficzne nazwy zmiennych nie są wymagane (np. Możesz użyć *foos
i **bars
), ale odejście od konwencji prawdopodobnie rozwścieczy innych koderów Pythona.
Zazwyczaj używamy ich, gdy nie wiemy, co otrzyma nasza funkcja lub ile argumentów możemy przekazać, a czasami nawet gdy nazewnictwo każdej zmiennej osobno byłoby bardzo nieporządne i zbędne (ale jest to przypadek, w którym zwykle jawne jest lepszy niż dorozumiany).
Przykład 1
Poniższa funkcja opisuje, w jaki sposób można ich używać, i pokazuje zachowanie. Uwaga: nazwany b
argument zostanie wykorzystany przez drugi argument pozycyjny przed:
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))
Możemy sprawdzić pomoc online dla podpisu funkcji, za pomocą help(foo)
, który nam to mówi
foo(a, b=10, *args, **kwargs)
Nazwijmy tę funkcję za pomocą foo(1, 2, 3, 4, e=5, f=6, g=7)
który drukuje:
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}
Przykład 2
Możemy również wywołać go za pomocą innej funkcji, w której zapewniamy 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)
drukuje:
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}
Przykład 3: praktyczne zastosowanie w dekoratorach
OK, więc może jeszcze nie widzimy narzędzia. Wyobraź sobie, że masz kilka funkcji z kodem nadmiarowym przed i / lub po kodzie różnicującym. Poniższe nazwane funkcje to tylko pseudo-kod do celów ilustracyjnych.
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
Możemy być w stanie poradzić sobie z tym inaczej, ale z pewnością możemy wydobyć nadmiarowość za pomocą dekoratora, dlatego nasz poniższy przykład pokazuje, jak *args
i **kwargs
może być bardzo przydatny:
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
A teraz każdą zawiniętą funkcję można napisać o wiele bardziej zwięźle, ponieważ uwzględniliśmy redundancję:
@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)
Oraz faktoringu nasz kod, który *args
i **kwargs
pozwala nam zrobić, to zmniejszyć linii kodu, poprawiają czytelność i łatwość konserwacji i mają wyłączne kanoniczne lokalizacje dla logiki w naszym programie. Jeśli potrzebujemy zmienić dowolną część tej struktury, mamy jedno miejsce, w którym można dokonać każdej zmiany.