Première · Numérique et sciences informatiques

Spécification et mise au point : documenter une fonction, l'assertionner et la tester

Écrire la spécification d'une fonction Python (nom, paramètres, type du résultat, précondition, docstring), puis la vérifier avec des assertions et un petit jeu de tests incluant des cas limites.

Aperçu gratuit
Illustration de la fiche « Spécification et mise au point : documenter une fonction, l'assertionner et la tester »

Les points essentiels

  • Une fonction est un bloc de code nommé qui reçoit des paramètres et renvoie un résultat avec return ; sa spécification dit CE qu'elle fait, sans dire comment elle le fait.
  • Une spécification précise le rôle de la fonction, le type et le sens de chaque paramètre, le type du résultat, et les préconditions (ce que l'appelant doit garantir avant l'appel).

Les mots à connaître

Spécification
Description précise et sans ambiguïté de ce qu'une fonction attend (paramètres, préconditions) et de ce qu'elle garantit (valeur renvoyée), indépendante de la façon dont elle est programmée.
Précondition
Condition que les arguments doivent respecter pour que la fonction soit correctement utilisable, par exemple « la liste est non vide ». Si elle n'est pas respectée, le comportement de la fonction n'est pas garanti.

Un exemple pour comprendre

On veut une fonction maximum(liste) qui renvoie le plus grand élément d'une liste d'entiers non vide. Écris sa spécification sous forme de docstring, le code, puis trois assertions de test dont un cas limite.

Spécification : paramètre liste de type list d'entiers, précondition len(liste) > 0, résultat de type int : le plus grand élément. Code : def maximum(liste): """Renvoie le plus grand élément de liste (list d'entiers). Précondition : liste non vide.""" m = liste[0] for x in liste: if x > m: m = x return m Tests : assert maximum([3, 8, 2]) == 8 (cas typique) ; assert maximum([5]) == 5 (cas limite : un seul élément) ; assert maximum([-4, -1, -9]) == -1 (cas limite : valeurs toutes négatives, ce qui montre qu'on ne doit pas initialiser m à 0). Les trois résultats attendus ont été calculés à la main depuis la spécification. Les trois assertions passent : le code est cohérent avec la spécification sur ces cas.

Première page de l’Essentiel : Spécification et mise au point : documenter une fonction, l'assertionner et la tester
Ketty