Os seguintes argumentos das funcións son probablemente os máis comúns que che despistan cando miras o código de Python e dis: “Que é isto?
*args**kwargs
Pódese especificar calquera número de argumentos (argumentos de lonxitude variable) engadindo un asterisco ao argumento na definición da función do seguinte xeito
***
Os nomes *args,**kwargs úsanse a miúdo como convención. Non obstante, admítense outros nomes sempre que * e ** estean ao principio. O seguinte código de exemplo usa os nomes *args,**kwargs.
A continuación descríbense os seguintes detalles.
*args:Acepta varios argumentos como tupla**kwargs:Acepta varios argumentos de palabras clave como dicionario
*args:Acepta varios argumentos como tupla
Pódese especificar un número arbitrario de argumentos definindo os argumentos con *, como 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
Reciben varios argumentos como tupla na función. No exemplo, á función sum() pásase unha tupla para calcular a 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
Tamén se pode combinar cun argumento de posición.
O valor especificado despois (á dereita de) do argumento posicional pásase a args como unha tupla. Se só hai un argumento posicional, é unha tupla baleira.
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: ()
Os argumentos marcados con * pódense definir primeiro. Neste caso, porén, os argumentos definidos despois de *args deben especificarse en forma de palabra clave. Por certo, o formato da palabra clave é o formulario “nome do argumento = valor”.
O último valor non se pasa automaticamente ao argumento posicional. Polo tanto, se non se especifica como un argumento de palabra clave, producirase un erro 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)
Se só se especifican argumentos *, os argumentos posteriores sempre deben especificarse como argumentos de palabras clave.(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:Acepta varios argumentos de palabras clave como dicionario
Pódese especificar un número arbitrario de argumentos de palabras clave definindo argumentos con ,** como en **kwargs.
Na función, o nome do argumento recíbese como un dicionario cuxa clave é a clave e cuxo valor é o 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'>
Tamén se pode usar xunto cun argumento de posición.
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}
Ao especificar o obxecto dicionario con ** como argumento ao chamar á función, é posible expandilo e pasalo como argumento respectivo.
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
Os argumentos marcados con ** só se poden definir ao final do argumento. Definir outro argumento despois do argumento marcado con ** producirá un erro SyntaxError.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax