Qu’est-ce qu’un contrat de fonction en Python ?

Réponse courte

Le contrat d’une fonction décrit comment l’utiliser : les entrées admises, le résultat renvoyé, les erreurs possibles et les effets de bord autorisés ou interdits. Un programme client peut s’y fier sans connaître le détail du calcul.

Comprendre

Ce que précise le contrat

Un contrat fixe les règles observables à respecter entre une fonction et le programme qui l’appelle. Il indique les préconditions sur les arguments, le type et le sens du résultat, les situations d’erreur et les éventuelles modifications des données reçues. Cette interface peut être documentée par une docstring.

Un exemple de moyenne

Pour moyenne(valeurs), on peut exiger une liste non vide de nombres finis, renvoyer un nombre et laisser la liste inchangée. Sur [8, 12], le résultat attendu est 10. Pour une liste vide, la fonction peut signaler une ValueError si cette règle est annoncée. Le code interne pourrait changer sans casser les clients tant que le contrat reste le même.

À quoi sert-il ?

Les tests vérifient des cas précis du contrat : une liste singleton [-4] doit donner -4, et [0, 0] doit donner 0. Un test supplémentaire compare la liste avant et après l’appel afin de détecter une modification interdite. Le contrat permet aussi de séparer le calcul de l’affichage : la fonction renvoie 10, le programme client décide s’il l’affiche.

Exemples

  • Si moyenne([8, 12]) est appelée, le contrat peut imposer le retour numérique 10 et l’absence de modification de la liste.
  • Si la précondition exclut les listes vides, moyenne([]) doit produire l’erreur annoncée, par exemple ValueError, plutôt qu’un résultat arbitraire.
  • Une fonction qui renvoie auparavant un nombre mais renvoie maintenant la chaîne "10" change son contrat : un client qui additionne le résultat échoue.

Pièges fréquents

  • Décrire seulement le nom et les paramètres oublie le type du retour, les erreurs possibles et les effets de bord, qui font aussi partie du contrat.
  • Confondre contrat et réalisation conduit à dépendre des variables internes : un client doit s’appuyer sur les règles annoncées, pas sur chaque ligne du corps.

Pourquoi ça marche

Le contrat crée une frontière stable entre deux parties : le client sait ce qu’il peut fournir et ce qu’il recevra, même si l’algorithme interne est réécrit.

Et maintenant ?

Questions proches

← Toutes les questions-réponses