Els arguments de funció següents són probablement els més comuns que us descobreixen quan mireu el codi de Python i digueu: “Què és això?
*args**kwargs
Es pot especificar qualsevol nombre d’arguments (arguments de longitud variable) afegint un asterisc a l’argument a la definició de la funció de la següent manera
***
Els noms *args,**kwargs s’utilitzen sovint com a convenció. Tanmateix, altres noms són acceptables sempre que * i ** estiguin al principi. El codi d’exemple següent utilitza els noms *args,**kwargs.
A continuació es descriuen els detalls següents.
*args:Accepta diversos arguments com a tupla**kwargs:Accepta diversos arguments de paraula clau com a diccionari
*args:Accepta diversos arguments com a tupla
Es pot especificar un nombre arbitrari d’arguments definint arguments amb *, com en *args.
def my_sum(*args):
return sum(args)
print(my_sum(1, 2, 3, 4))
# 10
print(my_sum(1, 2, 3, 4, 5, 6, 7, 8))
# 36
Es reben diversos arguments com a tupla a la funció. A l’exemple, a la funció sum() se li passa una tupla per calcular la suma.
def my_sum2(*args):
print('args: ', args)
print('type: ', type(args))
print('sum : ', sum(args))
my_sum2(1, 2, 3, 4)
# args: (1, 2, 3, 4)
# type: <class 'tuple'>
# sum : 10
També es pot combinar amb un argument de posició.
El valor especificat després (a la dreta de) de l’argument posicional es passa a args com a tupla. Si només hi ha un argument posicional, és una tupla buida.
def func_args(arg1, arg2, *args):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('args: ', args)
func_args(0, 1, 2, 3, 4)
# arg1: 0
# arg2: 1
# args: (2, 3, 4)
func_args(0, 1)
# arg1: 0
# arg2: 1
# args: ()
Els arguments marcats amb * es poden definir primer. En aquest cas, però, els arguments definits més tard que *args s’han d’especificar en forma de paraula clau. Per cert, el format de la paraula clau és la forma “nom de l’argument = valor”.
L’últim valor no es passa automàticament a l’argument posicional. Per tant, si no s’especifica com a argument de paraula clau, es produirà un error TypeError.
def func_args2(arg1, *args, arg2):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('args: ', args)
# func_args2(0, 1, 2, 3, 4)
# TypeError: func_args2() missing 1 required keyword-only argument: 'arg2'
func_args2(0, 1, 2, 3, arg2=4)
# arg1: 0
# arg2: 4
# args: (1, 2, 3)
Si només s’especifiquen arguments *, els arguments posteriors sempre s’han d’especificar com a arguments de paraula clau.(keyword-only argument)
def func_args_kw_only(arg1, *, arg2):
print('arg1: ', arg1)
print('arg2: ', arg2)
# func_args_kw_only(100, 200)
# TypeError: func_args_kw_only() takes 1 positional argument but 2 were given
func_args_kw_only(100, arg2=200)
# arg1: 100
# arg2: 200
**kwargs:Accepta diversos arguments de paraula clau com a diccionari
Es pot especificar un nombre arbitrari d’arguments de paraula clau definint arguments amb ,** com a **kwargs.
A la funció, el nom de l’argument es rep com un diccionari la clau del qual és la clau i el valor del qual és el valor.
def func_kwargs(**kwargs):
print('kwargs: ', kwargs)
print('type: ', type(kwargs))
func_kwargs(key1=1, key2=2, key3=3)
# kwargs: {'key1': 1, 'key2': 2, 'key3': 3}
# type: <class 'dict'>
També es pot utilitzar juntament amb un argument de posició.
def func_kwargs_positional(arg1, arg2, **kwargs):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('kwargs: ', kwargs)
func_kwargs_positional(0, 1, key1=1)
# arg1: 0
# arg2: 1
# kwargs: {'key1': 1}
Si especifiqueu l’objecte diccionari amb ** com a argument en cridar la funció, és possible expandir-lo i passar-lo com a argument respectiu.
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
Els arguments marcats amb ** només es poden definir al final de l’argument. Definir un altre argument després de l’argument marcat amb ** donarà lloc a un error SyntaxError.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax