Docstrings et annotations de type
Deux petites touches transforment une fonction qui marche en fonction professionnelle : une docstring et des annotations de type.
Une docstring est une chaîne littérale placée tout en haut du corps de la fonction. Elle explique ce que fait la fonction. Les outils et help() la lisent, et Python la range dans function.__doc__ :
def add(a, b):
"""Return the sum of a and b."""
return a + b
print(add.__doc__) # Return the sum of a and b.Les triples guillemets permettent à une docstring de tenir sur plusieurs lignes, pratique pour les explications plus longues.
Les annotations de type (type hints) indiquent les types attendus des paramètres et de la valeur renvoyée. Tu écris name: type pour chaque paramètre et -> type pour le retour :
def add(a: int, b: int) -> int:
"""Return the sum of a and b."""
return a + bLes annotations n'imposent rien à l'exécution. Python ne t'empêchera pas de passer une chaîne. C'est de la documentation que les éditeurs et les vérificateurs utilisent pour repérer les erreurs tôt, et elles rendent tes signatures claires toutes seules. Les types courants sont int, float, str et bool.
À partir de maintenant, écris tes fonctions avec les deux : une docstring claire et des annotations honnêtes.
Définis une fonction multiply avec les annotations def multiply(a: int, b: int) -> int: et une docstring (sa première ligne) qui dit exactement Return the product of a and b.. Le corps doit faire return a * b.
Tu as repéré un problème dans cette leçon ? Signale-le · Pose une question sur cette leçon
Cet exercice s'ouvre bientôt
Termine la leçon précédente pour débloquer celle-ci. Tout le cours est gratuit, aucun compte n'est requis, et tu peux lire cette leçon dès maintenant.
Ce navigateur bloque les cookies pour learn.floati.life, donc les leçons que tu as terminées ici ne peuvent pas s'ouvrir dans l'ordre. Autorise les cookies pour ce site et recharge la page.