CKTIS / Python
Paramètres positionnels variadiques : `*args`
Dans une définition de fonction, `*args` recueille les arguments positionnels supplémentaires dans un tuple. Dans un appel, `*` dépaquette un itérable en arguments positionnels.
Version : Python 3.12
Syntaxe
def f(required, *args, option=False):
...En Python 3.12, dans la définition def f(required, *args, option=False):, *args recueille, dans leur ordre de passage, les arguments positionnels qui n’ont pas été associés aux paramètres précédents. Dans le corps de la fonction, args est un tuple, ou () s’il n’y a pas de surplus.
Le nom args est conventionnel ; le préfixe * indique que le paramètre recueille des arguments positionnels. Puisque option suit *args, il ne peut être fourni que par nom, par exemple avec option=True. Un * seul introduit aussi des paramètres à passer uniquement par nom, mais ne recueille aucun argument positionnel.
Dans une définition, un seul astérisque recueille les arguments positionnels ; dans un appel comme func(*args, **kwargs), il dépaquette un itérable en arguments positionnels. La fonction d’enrobage utilise un mécanisme distinct pour transmettre les arguments nommés : dans la définition, **kwargs recueille les arguments nommés non associés dans un dictionnaire ; dans l’appel, ** dépaquette un objet de type mapping à clés textuelles en arguments nommés. La signature de la fonction cible s’applique toujours : un argument obligatoire manquant ou deux valeurs pour le même paramètre provoquent une TypeError.
Une fonction d’enrobage utilisée pour l’audit peut compter les arguments, les transmettre sans modification et renvoyer le résultat de la fonction cible. functools.wraps conserve des métadonnées comme le nom de la fonction d’origine. Ne journalisez pas les valeurs brutes des arguments dans un véritable journal d’audit : elles peuvent contenir des mots de passe ou d’autres données sensibles.
Exemples
from functools import wraps
def audit(func):
@wraps(func)
def wrapper(*args, **kwargs):
print(f"audit: positional={len(args)}, keyword={len(kwargs)}")
return func(*args, **kwargs)
return wrapper
@audit
def total(base=0, *increments, scale=1):
return (base + sum(increments)) * scale
print(total(10, 2, 3, scale=2))
print(total())Résultat
audit: positional=3, keyword=1 30 audit: positional=0, keyword=0 0
Au premier appel, la fonction d’enrobage compte trois arguments positionnels et un argument nommé. Après transmission, `total` associe `10` à `base`, `(2, 3)` à `increments` et `2` à `scale`, puis renvoie `30`. Le second appel montre les deux collections vides (`()` et `{}`) ; les valeurs par défaut donnent `0`.
Leçons associées
- Python · Leçon 10 · Avancé · Version : 5