Annotation de types dans les fonctions

Annotation de type (ou Type hinting)

Elle sert à indiquer explicitement les types de données attendus pour les paramètres de la fonction, ainsi que le type de la valeur de retour (le cas échéant). L'objectif principal de l'annotation de type est

• d'améliorer la lisibilité du code,

• de rendre plus claire la documentation (via les docstrings) et

• de faciliter la détection d'erreurs.

Python est un langage de programmation dynamique qui n'impose pas de contraintes strictes sur les types de données. Les annotations de type ne sont pas strictement nécessaires pour que le code fonctionne. Cependant, elles sont une pratique recommandée pour les raisons citées plus haut.

Syntaxe

def nom_fonction(parametre_1: type1, parametre_2: type2, ..., parametre_n: typen) -> type_retour:
    # Code
    return resultat # Résultat étant la valeur de retour de la fonction

Exemple :

def trouver_element(liste, element) :
    """
    Cette fonction recherche un élément dans une liste et renvoie True si l'élément est trouvé, False sinon.

    :param liste: La liste dans laquelle rechercher
    :param element: L'élément à rechercher dans la liste.
    :return: True si l'élément est trouvé, False sinon.

    Example:
        ma_liste = [1, 2, 3, 4, 5]

        trouver_element(ma_liste, 3) --> True

        trouver_element(ma_liste, 6) --> False
    """

    if element in liste:
        return True
    else:
        return False


if __name__ == "__main__" :
    ma_liste = [1, 2, 3, 4, 5]

    # Appel de la fonction
    element_est_trouve = trouver_element(ma_liste, 3)
    print(element_est_trouve)

Pour une fonction qui ne retourne rien, elle est annotée avec -> None.

Exemple :

def afficher_message(message: str) -> None:
    print(message)