CKTIS / Python
Testar exceções com assertRaises
Usa `unittest.TestCase.assertRaises` com um objeto invocável ou num bloco `with` para verificar se uma operação lança a exceção esperada.
Versão: Python 3.12
Sintaxe
self.assertRaises(exception, callable, *args, **kwds)
with self.assertRaises(exception, msg=None) as cm:
operation()
# After a matching exception, inspect cm.exception.Em Python 3.12, assertRaises é um método de unittest.TestCase. Passa uma classe de exceção, não uma instância, ou um tuplo de classes se forem aceitáveis vários tipos. Uma subclasse de uma classe esperada também corresponde. Uma exceção correspondente é capturada e a asserção passa. Se não for lançada nenhuma exceção, a asserção falha. Uma exceção que não corresponda propaga-se e é normalmente reportada como erro do teste.
Na forma com um objeto invocável, escreve self.assertRaises(ValueError, parse_port, "0"). Passa parse_port sem a chamar e fornece os argumentos posicionais e nomeados separadamente. Não passes o resultado de parse_port("0"): essa chamada ocorreria antes de a asserção poder capturar a exceção.
Na forma com um gestor de contexto, escreve with self.assertRaises(ValueError) as cm: e coloca no bloco apenas a operação que deve lançar a exceção. Outra operação que lance o mesmo tipo pode fazer com que a asserção passe pelo motivo errado. Depois do bloco, cm.exception contém a instância capturada. Nesta forma, msg= é opcional e fornece uma mensagem para a falha da asserção, não um padrão para o texto da exceção. Para verificar o texto com uma expressão regular, usa assertRaisesRegex.
setUp() prepara os dados antes de cada método de teste, não antes de cada bloco subTest(). assertEqual verifica os resultados dos casos válidos e também pode comparar o texto da exceção capturada. subTest(invalid=invalid) identifica cada iteração com o valor que aparece no relatório se o subteste falhar.
Exemplos
import io
import unittest
def parse_port(text):
port = int(text)
if not 1 <= port <= 65535:
raise ValueError("port must be between 1 and 65535")
return port
class PortTests(unittest.TestCase):
def setUp(self):
self.default_port = "80"
self.highest_port = "65535"
def test_context_form(self):
self.assertEqual(parse_port(self.default_port), 80)
self.assertEqual(parse_port(self.highest_port), 65535)
with self.assertRaises(ValueError) as cm:
parse_port("0")
self.assertEqual(str(cm.exception), "port must be between 1 and 65535")
def test_callable_form(self):
for invalid, valid, expected in (("0", "1", 1), ("65536", self.highest_port, 65535)):
with self.subTest(invalid=invalid):
self.assertEqual(parse_port(valid), expected)
self.assertRaises(ValueError, parse_port, invalid)
if __name__ == "__main__":
log = io.StringIO()
suite = unittest.defaultTestLoader.loadTestsFromTestCase(PortTests)
result = unittest.TextTestRunner(stream=log).run(suite)
if not result.wasSuccessful():
raise SystemExit(log.getvalue())
print(f"OK ({result.testsRun} tests)")
Resultado
OK (2 tests)
O exemplo verifica portos válidos, captura a exceção para `"0"` e compara o respetivo texto. Em seguida, verifica em subtestes identificados que `"0"` e `"65536"` são rejeitados. O resumo personalizado conta os dois métodos de teste, não as iterações dos subtestes.
Lições relacionadas
- Python · Lição 37 · Avançado · Versão: 5
- Python · Lição 34 · Intermédio · Versão: 3
Fontes
- unittest — Unit testing framework: TestCase.assertRaises (Python 3.12)
- unittest — Unit testing framework: TestCase.assertRaisesRegex (Python 3.12)
- unittest — Unit testing framework: TestCase.setUp (Python 3.12)
- unittest — Unit testing framework: TestCase.assertEqual (Python 3.12)
- unittest — Unit testing framework: TestCase.subTest (Python 3.12)
- unittest — Unit testing framework: TextTestRunner (Python 3.12)