Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

`*args` et `**kwargs` : recueillir et transmettre des arguments

Dans une définition, `*args` recueille les arguments positionnels restants et `**kwargs` les arguments nommés restants. Dans un appel, les mêmes astérisques dépaquettent les valeurs.

Version : Python 3.12

Syntaxe

def wrapper(*args, **kwargs):
    return target(*args, **kwargs)

def dispatch(handler, /, *args, label="items"):
    return handler(*args, label=label)

Dans une définition de fonction en Python 3.12, *args recueille les arguments positionnels non associés à d’autres paramètres dans un tuple, dans l’ordre où ils sont passés. **kwargs recueille les arguments nommés restants dans un nouveau dictionnaire dict. S’il n’y a rien à recueillir, ils reçoivent respectivement () et {}. Les noms args et kwargs sont conventionnels : ce sont les astérisques qui déterminent le comportement.

Un paramètre ordinaire placé après *args, comme label, ne peut être passé que par son nom. Un * seul introduit ces paramètres sans rien recueillir. Les paramètres précédant /, comme handler dans l’exemple, sont exclusivement positionnels. S’il est présent, **kwargs est le dernier paramètre.

Dans un appel comme target(*args, **kwargs), l’opération est inverse : * dépaquette un itérable en arguments positionnels distincts, et ** dépaquette un objet de type mapping dont les clés sont des chaînes en arguments nommés. Écrire explicitement deux fois le même nom d’argument dans un appel provoque une SyntaxError à la compilation. Si le dépaquetage avec ** introduit un nom d’argument en double, ou si un argument positionnel et un argument nommé fournissent chacun une valeur au même paramètre, l’appel déclenche une TypeError à l’exécution.

La fonction enveloppe wrapper recueille et transmet les deux types d’arguments. La fonction de répartition dispatch ne recueille que les arguments positionnels supplémentaires, reçoit label séparément et appelle handler. Si dispatch n’accepte pas un argument nommé, l’appel transmis déclenche TypeError, même si wrapper l’accepte.

Exemples

def render(*values, label):
    return f"{label}: {values}"


def dispatch(handler, /, *args, label="items"):
    return handler(*args, label=label)


def wrapper(*args, **kwargs):
    return dispatch(render, *args, **kwargs)


print(wrapper(3, 5, label="points"))
print(wrapper())

Résultat

points: (3, 5)
items: ()

Au premier appel, `dispatch` associe `label="points"` à `label` et recueille `3` et `5` dans `args`. Au second, `wrapper` ne recueille rien, si bien que `dispatch` utilise sa valeur par défaut `"items"`.

Leçons associées

  • Python · Leçon 44 · Avancé · Version : 5

Sources