Indication des types en Python avec exceptions

Question

J'ai une fonction qui ressemble à ceci :

def check_for_errors(result):
    if 'success' in result:
        return True

    if 'error' in result:
        raise TypeError

    return False

En cas d'exécution réussie de cette fonction, je devrais obtenir une bool mais s'il y a une erreur, je devrais recevoir une TypeError - ce qui n'est pas grave car je m'en occupe dans une autre fonction.

La première ligne de ma fonction ressemble à ceci :

def check_for_errors(result: str) -> bool:

Ma question est la suivante : dois-je mentionner l'erreur dans mes indications de type ?

Answer 1

Les indications de type ne peuvent rien dire sur les exceptions. Elles sont totalement hors de portée de cette fonctionnalité. Vous pouvez néanmoins documenter l'exception dans la docstring.

De PEP 484 -- Conseils sur les types :

Exceptions

Aucune syntaxe pour lister les exceptions explicitement soulevées n'est proposée. Actuellement, le seul cas d'utilisation connu pour cette fonctionnalité est documentaire, auquel cas la recommandation est de mettre cette information dans une chaîne de caractères.

Guido van Rossum s'est fortement opposé à l'ajout d'exceptions à la spécification de l'indication du type, car il ne veut pas se retrouver dans une situation où les exceptions doivent être vérifié (géré dans le code d'appel) ou déclarés explicitement à chaque niveau.

Answer 2

Il est généralement judicieux de documenter l'erreur. Ainsi, un autre développeur utilisant votre fonction sera en mesure de traiter vos erreurs sans avoir à lire votre code.