Première · Numérique et sciences informatiques

Comprendre la fonction : contrat, docstring, assertions et tests

Rédiger la spécification d'une fonction Python (nom, paramètres, préconditions, valeur renvoyée) puis vérifier son respect avec des assertions simples et des tests ciblés.

Aperçu gratuit
Illustration de la fiche « Comprendre la fonction : contrat, docstring, assertions et tests »

Les points essentiels

  • Une fonction regroupe un traitement réutilisable : elle reçoit des paramètres, effectue un calcul et renvoie un résultat avec return. Elle se définit avec def.
  • La spécification est le contrat de la fonction : ce qu'elle attend en entrée (types, valeurs admises, appelées préconditions) et ce qu'elle garantit en sortie (postcondition). Elle se rédige avant le code, notamment dans la docstring placée sous la ligne def.

Les mots à connaître

Spécification d'une fonction
Description précise de ce que doit faire la fonction : rôle, paramètres attendus et leurs types, préconditions sur les entrées, nature et propriétés de la valeur renvoyée. Elle est en général écrite dans la docstring.
Précondition / postcondition
La précondition est la condition que doivent respecter les arguments pour que la fonction ait un comportement garanti ; la postcondition est la propriété que doit vérifier le résultat si la précondition est respectée.

Un exemple pour comprendre

On veut une fonction maximum(a, b) qui renvoie le plus grand de deux entiers. Écrire sa spécification, le code, puis trois assertions de test.

Spécification : maximum(a, b) prend deux entiers a et b (aucune autre précondition) et renvoie un entier égal au plus grand des deux. Code : def maximum(a, b): """Renvoie le plus grand des entiers a et b.""" if a >= b: return a return b Tests : assert maximum(3, 7) == 7 (cas ordinaire, le second est le plus grand) ; assert maximum(9, 2) == 9 (le premier est le plus grand) ; assert maximum(5, 5) == 5 (cas limite d'égalité). Résultat attendu déterminé à la main avant exécution : les trois assertions passent sans erreur. Le cas d'égalité est utile car c'est là qu'une erreur de comparaison (> au lieu de >=) pourrait passer inaperçue sans changer le résultat, ce qui montre l'intérêt de tester les bornes.

Première page de l’Essentiel : Comprendre la fonction : contrat, docstring, assertions et tests
Ketty