Criando exceções próprias

Por que criar a sua própria exceção

As exceções embutidas são ótimas, mas genéricas. ValueError diz que um valor é inválido, e nada mais. Só que o seu programa tem regras próprias. Uma conta bancária pode ter a regra "não sacar mais do que o saldo". Você poderia levantar um ValueError para isso, mas o nome não conta a história. Se, em vez disso, você levanta um SaldoInsuficienteError, qualquer pessoa que leia o código, ou que precise tratar esse caso, entende de imediato o que aconteceu. O nome da exceção vira documentação viva da regra de negócio.

class SaldoInsuficienteError(Exception):
    """Levantada quando um saque excede o saldo disponível."""


def sacar(saldo, valor):
    if valor > saldo:
        raise SaldoInsuficienteError(f"Saque de {valor} maior que o saldo de {saldo}")
    return saldo - valor

print(sacar(100, 30))   # 70
print(sacar(100, 150))  # levanta SaldoInsuficienteError

Uma classe que herda de Exception já é uma exceção completa; o docstring explica quando ela é levantada.

Repare como a definição é curta. A classe SaldoInsuficienteError herda de Exception e o corpo é apenas um docstring que explica quando ela acontece. Poderia ser um simples pass. Isso basta porque a herança faz o trabalho pesado: aceitar a mensagem, guardar os argumentos, aparecer no traceback com o nome certo. Você só está dando um rótulo específico a um erro específico. Levantá-la é igual a levantar qualquer exceção: raise SaldoInsuficienteError com a mensagem.

Capturar a sua exceção com clareza

A grande vantagem aparece na hora de tratar. Com um nome próprio, quem chama a função consegue reagir de forma específica a esse caso, sem confundir com outros erros de valor. Um except SaldoInsuficienteError pega exatamente essa situação e mais nenhuma. Se você tivesse usado ValueError, um saque acima do saldo se misturaria com qualquer outro valor inválido, e você não conseguiria dar mensagens diferentes para problemas diferentes. A exceção própria separa as águas.

saldo = 100

try:
    saldo = sacar(saldo, 150)
except SaldoInsuficienteError as erro:
    print("Operação recusada:", erro)
else:
    print("Novo saldo:", saldo)

# Saída:
# Operação recusada: Saque de 150 maior que o saldo de 100

O as erro captura o objeto da exceção; imprimi-lo mostra a mensagem que você passou ao raise.

O trecho except SaldoInsuficienteError as erro guarda o objeto da exceção na variável erro. Imprimir esse objeto mostra a mensagem que você definiu no raise. É por isso que caprichar na mensagem compensa: ela chega inteira até quem trata o erro. Você também pode organizar várias exceções do seu programa criando uma classe base, por exemplo class ErroDaConta(Exception), e fazendo SaldoInsuficienteError e outras herdarem dela. Assim, um except ErroDaConta captura qualquer erro daquela família de uma vez, quando essa for a intenção.

Fixando as exceções próprias

Criar uma exceção é barato: uma classe curta que herda de Exception. O valor está no nome e na clareza que ele traz. Mas não crie por criar. Se o erro é local, simples e ninguém precisa distinguir, uma embutida como ValueError basta. A exceção própria compensa quando o problema faz parte das regras do seu programa e quem chama precisa tratá-lo de forma específica, como o saque acima do saldo. Na próxima aula você junta tudo em boas práticas, e no fim do módulo transforma esse SaldoInsuficienteError numa função de saque completa.