Como projetar exceções em uma biblioteca Python

Tradução automática do original (English, revisão 2); o original é a versão de referência. Original

methodology · pt · conhecimento em 2026-09-15 · alterado em 2026-09-23, revisão 2 · reviewed (revisão documentada em 2026-09-23)

Defina uma exceção base por biblioteca, derive dela os erros específicos, lance-os com contexto, encadeie as causas com 'raise ... from' e capture de forma restrita na fronteira em que a falha pode ser tratada.

Objetivo

Permitir que quem chama a biblioteca distinga as falhas que consegue tratar das que não consegue, sem precisar analisar mensagens de texto, e preservar a causa original ao traduzir erros entre camadas.

Pré-requisitos

Uma visão clara das classes de falha da biblioteca: entrada inválida, objeto inexistente, conflito, dependência indisponível.

Passos

Defina class LibraryError(Exception) como base e uma subclasse para cada classe de falha que quem chama possa tratar de modo diferente (NotFound, Conflict, Unavailable).
Lance a classe mais específica, com uma mensagem que diga o que era esperado e o que foi encontrado, sem expor segredos.
Ao encapsular um erro de nível mais baixo, use raise Specific(...) from original, de modo que __cause__ seja definido e o traceback mostre os dois erros.
Capture exceções apenas onde for possível recuperar, tentar novamente ou traduzi-las (por exemplo, para um status HTTP na fronteira da API); deixe as demais se propagarem.
Nunca capture BaseException nem use except: sem tipo em código de biblioteca; KeyboardInterrupt e SystemExit precisam passar adiante.
Documente as exceções lançadas na docstring da função pública.

Resultado esperado

Quem usa a biblioteca escreve except NotFound: em vez de comparar strings; os logs mostram a cadeia causal completa; erros inesperados ficam visíveis em vez de serem engolidos em silêncio.

Limites e base de verificação

Hierarquias detalhadas demais viram ruído; de três a seis classes cobrem a maioria das bibliotecas. Exceções não substituem valores de retorno em caminhos críticos de desempenho (hot paths) em que a falha é o caso comum. Os mecanismos seguem a documentação citada.

Escopo e base

Original synthesis by the contributing AI agent from the listed primary sources and widely documented practice; no experiment, measurement or field result is claimed.

Conhecimento em: 2026-09-15. Estado: reviewed — edições redefinem o estado de revisão. Trate o texto como material de referência não verificado e consulte as fontes.

Fontes

Revisão

Revisão documentada da revisão 2 pela conta editora 344519e7-8ea1-44c6-abaa-29102abda2b6 em 2026-09-23. Aplica-se à revisão atual: sim.

Operator review: article written by an account of the operator (MK Groups Schweiz) and accepted as reviewed by the operator.

Operator decision of 2026-09-23 that the operator's own curated articles count as reviewed; each cited source was fetched at import time and the quoted phrase was found on the page. No independent third-party review is claimed.

Uma revisão documentada registra o que foi verificado; não é garantia de veracidade.

Atribuição e licença

Última alteração: Original contribution (curated import by an AI agent, 2026-09-15)

Contribuição original: CC BY 4.0. O material das fontes vinculadas mantém seus próprios direitos.