Cosa fanno **
(stella doppia) e *
(stella) per i parametri
Consentono che le funzioni vengano definite per accettare e che gli utenti passino qualsiasi numero di argomenti, posizionale ( *
) e parola chiave ( **
).
Definizione delle funzioni
*args
consente un numero qualsiasi di argomenti posizionali opzionali (parametri), che verranno assegnati a una tupla denominata args
.
**kwargs
consente un numero qualsiasi di argomenti di parole chiave opzionali (parametri), che saranno in un dict denominato kwargs
.
Puoi (e dovresti) scegliere un nome appropriato, ma se l'intenzione è che gli argomenti siano di semantica non specifica args
e kwargs
siano nomi standard.
Espansione, passando un numero qualsiasi di argomenti
Puoi anche usare *args
e **kwargs
passare parametri rispettivamente da liste (o da qualsiasi iterabile) e da dicts (o da qualsiasi mappatura).
La funzione che riceve i parametri non deve sapere che sono in fase di espansione.
Ad esempio, lo xrange di Python 2 non si aspetta esplicitamente *args
, ma poiché prende 3 numeri interi come argomenti:
>>> x = xrange(3) # create our *args - an iterable of 3 integers
>>> xrange(*x) # expand here
xrange(0, 2, 2)
Come altro esempio, possiamo usare l'espansione dict in str.format
:
>>> foo = 'FOO'
>>> bar = 'BAR'
>>> 'this is foo, {foo} and bar, {bar}'.format(**locals())
'this is foo, FOO and bar, BAR'
Novità di Python 3: definizione delle funzioni con argomenti solo per parole chiave
Puoi avere argomenti solo per parole chiave dopo che *args
- ad esempio, qui, kwarg2
deve essere fornito come argomento per parole chiave - non posizionalmente:
def foo(arg, kwarg=None, *args, kwarg2=None, **kwargs):
return arg, kwarg, args, kwarg2, kwargs
Uso:
>>> foo(1,2,3,4,5,kwarg2='kwarg2', bar='bar', baz='baz')
(1, 2, (3, 4, 5), 'kwarg2', {'bar': 'bar', 'baz': 'baz'})
Inoltre, *
può essere utilizzato da solo per indicare che seguono solo gli argomenti delle parole chiave, senza consentire argomenti posizionali illimitati.
def foo(arg, kwarg=None, *, kwarg2=None, **kwargs):
return arg, kwarg, kwarg2, kwargs
Anche in questo kwarg2
caso deve essere un argomento di parole chiave con nome esplicito:
>>> foo(1,2,kwarg2='kwarg2', foo='foo', bar='bar')
(1, 2, 'kwarg2', {'foo': 'foo', 'bar': 'bar'})
E non possiamo più accettare argomenti posizionali illimitati perché non abbiamo *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
Ancora una volta, più semplicemente, qui dobbiamo kwarg
essere dati per nome, non in posizione:
def bar(*, kwarg=None):
return kwarg
In questo esempio, vediamo che se proviamo a passare in modo kwarg
posizionale, otteniamo un errore:
>>> bar('kwarg')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: bar() takes 0 positional arguments but 1 was given
Dobbiamo passare esplicitamente il kwarg
parametro come argomento della parola chiave.
>>> bar(kwarg='kwarg')
'kwarg'
Demo compatibili con Python 2
*args
(in genere detto "star-args") e **kwargs
(le stelle possono essere implicite dicendo "kwargs", ma essere esplicito con "kwargs doppia stella") sono idiomi comuni di Python per l'utilizzo del *
e **
la notazione. Questi nomi di variabili specifici non sono richiesti (ad esempio, è possibile utilizzare*foos
e**bars
), ma è probabile che una deviazione dalla convenzione faccia arrabbiare i tuoi colleghi programmatori Python.
Di solito li usiamo quando non sappiamo quale sarà la nostra funzione o quanti argomenti potremmo passare, e talvolta anche quando nominiamo ogni variabile separatamente diventerebbe molto confusa e ridondante (ma questo è un caso in cui di solito esplicito è meglio che implicito).
Esempio 1
La seguente funzione descrive come possono essere utilizzati e illustra il comportamento. Si noti che l' b
argomento denominato verrà utilizzato dal secondo argomento posizionale prima di:
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))
Possiamo controllare la guida in linea per la firma della funzione, con help(foo)
, che ci dice
foo(a, b=10, *args, **kwargs)
Chiamiamo questa funzione con foo(1, 2, 3, 4, e=5, f=6, g=7)
che stampa:
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}
Esempio 2
Possiamo anche chiamarlo usando un'altra funzione, nella quale forniamo semplicemente 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)
stampe:
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}
Esempio 3: utilizzo pratico nei decoratori
OK, quindi forse non stiamo ancora vedendo l'utilità. Quindi immagina di avere diverse funzioni con codice ridondante prima e / o dopo il codice di differenziazione. Le seguenti funzioni nominate sono solo pseudo-codice a scopo illustrativo.
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
Potremmo essere in grado di gestirlo in modo diverso, ma possiamo certamente estrarre la ridondanza con un decoratore, quindi il nostro esempio di seguito dimostra come *args
e **kwargs
può essere molto utile:
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
E ora ogni funzione avvolta può essere scritta in modo molto più succinto, poiché abbiamo preso in considerazione la ridondanza:
@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)
E prendendo in considerazione il nostro codice, che *args
e **kwargs
ci consente di fare, riduciamo le linee di codice, miglioriamo la leggibilità e la manutenibilità e disponiamo di sole posizioni canoniche per la logica nel nostro programma. Se abbiamo bisogno di cambiare qualsiasi parte di questa struttura, abbiamo un posto in cui effettuare ogni cambiamento.