Los siguientes argumentos de función son probablemente los más comunes que te dejan perplejo cuando miras el código de Python y dices: «¿Qué es esto?
*args**kwargs
Se puede especificar cualquier número de argumentos (argumentos de longitud variable) añadiendo un asterisco al argumento en la definición de la función como sigue
***
Los nombres *args,**kwargs se utilizan a menudo como convención. Sin embargo, otros nombres son aceptables siempre que * y ** estén al principio. El siguiente código de ejemplo utiliza los nombres *args,**kwargs.
A continuación se describen los siguientes detalles.
*args:Acepta múltiples argumentos como una tupla**kwargs:Acepta múltiples argumentos de palabras clave como un diccionario
*args: Acepta múltiples argumentos como una tupla
Se puede especificar un número arbitrario de argumentos definiendo los 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
Los argumentos múltiples se reciben como una tupla en la función. En el ejemplo, a la función sum() se le pasa una tupla para 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
También puede combinarse con un argumento de posición.
El valor especificado después (a la derecha) del argumento posicional se pasa a args como una tupla. Si sólo hay un argumento posicional, es una tupla vacía.
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: ()
Los argumentos marcados con * pueden definirse primero. En este caso, sin embargo, los argumentos definidos después de *args deben especificarse en forma de palabra clave. Por cierto, el formato de palabra clave es la forma «nombre del argumento = valor».
El último valor no se pasa automáticamente al argumento posicional. Por lo tanto, si no se especifica como un argumento de palabra clave, se producirá 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 sólo se especifican * argumentos, los siguientes deben especificarse siempre como argumentos de palabra 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 múltiples argumentos de palabras clave como un diccionario
Se puede especificar un número arbitrario de argumentos de palabras clave definiendo los argumentos con ,** como en **kwargs.
En la función, el nombre del argumento se recibe como un diccionario cuya clave es la llave y cuyo valor es 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'>
También puede utilizarse junto con un 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}
Especificando el objeto diccionario con ** como argumento al llamar a la función, es posible expandirlo y pasarlo 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}
Los argumentos marcados con ** sólo pueden definirse al final del argumento. Definir otro argumento después del argumento marcado con ** dará lugar a un error SyntaxError.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax
