Comment créer des exceptions personnalisées en Python

Les classes d’exceptions intégrées de Python ne répondent pas à certaines situations d’erreur qui peuvent survenir dans votre code. Dans de tels cas, vous devrez créer des exceptions personnalisées pour gérer efficacement ces erreurs.

En Python, vous pouvez définir des exceptions personnalisées et les lever lorsque des situations d’erreur spécifiques se produisent. Vous pouvez gérer des erreurs spécifiques et informatives à l’aide d’exceptions personnalisées, ce qui améliore la lisibilité et la maintenabilité de votre code.

Pourquoi avez-vous besoin d’exceptions personnalisées ?

Au cours du développement d’une application, divers scénarios d’erreur peuvent survenir en raison des modifications apportées au code, de l’intégration avec d’autres paquets ou bibliothèques et des interactions avec des applications externes. Il est crucial de gérer ces erreurs afin de les récupérer ou de gérer les échecs de manière gracieuse.

Python offre une gamme de d’exceptions intégrées qui couvrent les erreurs telles que Erreur de valeur, Erreur de type, Erreur de fichier introuvable et bien d’autres encore. Bien que ces exceptions intégrées soient utiles, elles ne représentent que parfois fidèlement les erreurs susceptibles de se produire dans votre application.

En créant des exceptions personnalisées, vous pouvez les adapter spécifiquement aux exigences de votre application et fournir des informations aux développeurs qui utilisent votre code.

Comment définir des exceptions personnalisées

Pour créer des exceptions personnalisées, définissez une classe Python qui hérite de la classe Exception. Les Exception offre les fonctionnalités de base dont vous aurez besoin pour gérer les exceptions, et vous pouvez la personnaliser pour ajouter des fonctionnalités en fonction de vos besoins spécifiques.

Lorsque vous créez des classes d’exception personnalisées, veillez à ce qu’elles restent simples tout en incluant les attributs nécessaires au stockage des informations relatives aux erreurs. Les gestionnaires d’exception peuvent ensuite accéder à ces attributs pour traiter les erreurs de manière appropriée.

Voici une classe d’exception personnalisée, MyCustomError:

Cette classe accepte un argument de message facultatif lors de l’initialisation. Elle utilise la classe d’exception super() pour appeler le constructeur de la classe de base Exception qui est essentielle pour la gestion des exceptions.

Comment lever des exceptions personnalisées

Pour lever une erreur, utilisez la classe lever suivi d’une instance de votre classe d’exception personnalisée, en lui passant un message d’erreur comme argument :

Vous pouvez également lever l’erreur sans passer d’argument :

L’un ou l’autre de ces formats convient à la remontée d’erreurs personnalisées.

Comment gérer les exceptions personnalisées

La gestion des exceptions personnalisées suit la même approche que la gestion des exceptions intégrées. Utilisez essayer, except et enfin afin d’attraper les exceptions personnalisées et de prendre les mesures qui s’imposent.

De cette façon, vous pouvez gérer toutes les formes d’exceptions personnalisées soulevées.

Si une exception se produit pendant l’exécution d’un essayer un bloc except peut l’attraper et le traiter. S’il n’y a pas de bloc sauf pour traiter l’exception, tout bloc enfin s’exécute, puis l’exception est à nouveau levée. Utilisez un bloc enfin principalement pour effectuer des tâches de nettoyage qui doivent être exécutées en toutes circonstances, qu’une exception se produise ou non.

Dans cet exemple, un bloc KeyboardInterrupt se produit, mais l’exception sauf ne traite que les exceptions MyCustomError . Dans ce cas, le bloc enfin s’exécute, puis l’exception non gérée est à nouveau levée.

Héritage de classes d’erreurs personnalisées

Sur la base du concept de programmation orientée objet (POO), vous pouvez également hériter de classes d’exception personnalisées, tout comme des classes normales. En héritant d’une classe d’exception personnalisée, vous pouvez créer des classes d’erreur qui fournissent un contexte plus spécifique à une exception. Cette approche vous permet de gérer les erreurs à différents niveaux de votre code et de mieux comprendre la cause de l’erreur.

Supposons que vous développiez une application web qui interagit avec une API externe. Cette API peut présenter différents scénarios d’erreur. Vous voudrez gérer ces erreurs de manière cohérente et claire dans l’ensemble de votre code. Pour ce faire, créez une classe d’exception personnalisée, BaseAPIException:

Une fois que vous avez cette classe d’exception personnalisée de base, vous pouvez créer des classes d’exception enfantines qui en héritent :

Levez et attrapez ces exceptions personnalisées lorsque vous faites des appels à l’API dans votre application web. Traitez-les en conséquence en utilisant la logique appropriée dans votre code.

La clause except finale se réfère à la classe mère et sert de fourre-tout pour toutes les autres erreurs liées à l’API.

Lorsque vous héritez de classes d’exception personnalisées, vous pouvez gérer efficacement les erreurs au sein de l’API. Cette approche vous permet de séparer votre gestion des erreurs des détails de mise en œuvre de l’API, ce qui facilite l’ajout d’exceptions personnalisées ou les modifications lorsque l’API évolue ou rencontre de nouveaux cas d’erreur.

Enveloppe des exceptions personnalisées

Envelopper les exceptions signifie attraper une exception, l’encapsuler dans une exception personnalisée, puis lever cette exception personnalisée tout en faisant référence à l’exception d’origine en tant que cause. Cette technique permet de fournir un contexte aux messages d’erreur et de garder les détails de l’implémentation cachés au code appelant.

Imaginons que votre application web interagisse avec une API. Si l’API soulève un LookupError vous pouvez l’attraper, puis déclencher une erreur de type APINotFoundError qui fait référence à la LookupError en tant que cause :

Utiliser une à partir de avec la clause soulever pour faire référence à l’exception originale dans votre exception personnalisée.

Lorsque l’exception personnalisée se produit, elle inclut l’exception originale sous la forme d’une instruction __cause__ fournissant ainsi un lien entre l’exception personnalisée et l’exception originale. Cela vous permet de retracer l’origine d’une exception.

En enveloppant les exceptions, vous pouvez fournir un contexte plus significatif et envoyer des messages d’erreur plus appropriés aux utilisateurs, sans révéler les détails de l’implémentation interne de votre code ou de l’API. Cela vous permet également de gérer et de traiter les types d’erreurs de manière structurée et uniforme.

Personnaliser le comportement des classes en Python

En héritant de la classe d’exception de base fournie par Python, vous pouvez créer des exceptions simples et utiles que vous pouvez lever lorsque des erreurs spécifiques se produisent dans votre code. Vous pouvez également mettre en œuvre un comportement personnalisé pour vos classes d’exception à l’aide des méthodes magic ou dunder.