Les arguments de fonction suivants sont probablement ceux qui vous laissent le plus souvent perplexe lorsque vous regardez du code Python et que vous vous dites : “Qu'est-ce que c'est ?
*args**kwargs
Un nombre quelconque d'arguments (arguments de longueur variable) peut être spécifié en ajoutant un astérisque à l'argument dans la définition de la fonction, comme suit
***
Les noms *args, **kwargs sont souvent utilisés par convention. Cependant, d'autres noms sont acceptables tant que * et ** sont au début. L'exemple de code suivant utilise les noms *args,**kwargs.
Les détails suivants sont décrits ci-dessous.
*args:Accepte plusieurs arguments sous forme de tuple**kwargs:Accepte plusieurs arguments de mots-clés comme un dictionnaire
*args: Accepte plusieurs arguments sous forme de tuple
Un nombre arbitraire d'arguments peut être spécifié en définissant les arguments avec *, comme dans *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
Les arguments multiples sont reçus sous forme de tuple dans la fonction. Dans l'exemple, la fonction sum() reçoit un tuple pour calculer la somme.
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
Il peut également être combiné avec un argument de position.
La valeur spécifiée après (à droite de) l'argument positionnel est passée à args comme un tuple. S'il n'y a qu'un seul argument positionnel, c'est un tuple vide.
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: ()
Les arguments marqués d'un * peuvent être définis en premier. Dans ce cas, cependant, les arguments définis après *args doivent être spécifiés sous forme de mots-clés. Soit dit en passant, le format mot-clé est la forme “nom de l'argument = valeur”.
La dernière valeur n'est pas automatiquement transmise à l'argument positionnel. Par conséquent, si elle n'est pas spécifiée en tant qu'argument de mot-clé, une erreur TypeError sera générée.
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 seuls les arguments * sont spécifiés, les arguments suivants doivent toujours être spécifiés en tant qu'arguments de mots-clés.(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: Accepte plusieurs arguments de mots-clés comme un dictionnaire
Un nombre arbitraire d'arguments de mots-clés peut être spécifié en définissant les arguments avec ,** comme dans **kwargs.
Dans la fonction, le nom de l'argument est reçu comme un dictionnaire dont la clé est la clé et la valeur la valeur.
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'>
Il peut également être utilisé en conjonction avec un argumentaire de position.
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}
En spécifiant l'objet dictionnaire avec ** comme argument lors de l'appel de la fonction, il est possible de le développer et de le passer comme argument respectif.
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
Les arguments marqués par ** ne peuvent être définis qu'à la fin de l'argument. La définition d'un autre argument après l'argument marqué par ** entraînera une erreur SyntaxError.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax