CKTIS / Python
Tester les exceptions avec assertRaises
Utilisez `unittest.TestCase.assertRaises` avec un objet appelable ou dans un bloc `with` pour vérifier qu’une opération lève l’exception attendue.
Version : Python 3.12
Syntaxe
self.assertRaises(exception, callable, *args, **kwds)
with self.assertRaises(exception, msg=None) as cm:
operation()
# After a matching exception, inspect cm.exception.Dans Python 3.12, assertRaises est une méthode de unittest.TestCase. Passez une classe d’exception, pas une instance, ou un tuple de classes si plusieurs types sont acceptables. Une sous-classe d’une classe attendue convient aussi. Une exception correspondante est interceptée et l’assertion réussit. Si aucune exception n’est levée, l’assertion échoue. Une exception qui ne correspond pas se propage et est normalement signalée comme une erreur de test.
Dans la forme avec un objet appelable, écrivez self.assertRaises(ValueError, parse_port, "0"). Passez parse_port elle-même et fournissez séparément ses arguments positionnels et nommés. Ne passez pas le résultat de parse_port("0") : cet appel aurait lieu avant que l’assertion puisse intercepter l’exception.
Dans la forme avec un gestionnaire de contexte, écrivez with self.assertRaises(ValueError) as cm: et ne placez dans le bloc que l’opération censée lever l’exception. Une autre opération qui lève le même type pourrait faire réussir l’assertion pour la mauvaise raison. Après le bloc, cm.exception contient l’instance interceptée. Dans cette forme, msg= est facultatif et fournit un message d’échec de l’assertion, pas un motif pour le texte de l’exception. Pour vérifier ce texte avec une expression régulière, utilisez assertRaisesRegex.
setUp() prépare les données avant chaque méthode de test, pas avant chaque bloc subTest(). assertEqual vérifie les résultats des cas valides et peut aussi comparer le texte de l’exception interceptée. subTest(invalid=invalid) identifie chaque itération par la valeur qui apparaîtra dans le rapport si le sous-test échoue.
Exemples
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)")
Résultat
OK (2 tests)
L’exemple vérifie des ports valides, intercepte l’exception pour `"0"` et compare son texte. Il vérifie ensuite, dans des sous-tests identifiés, que `"0"` et `"65536"` sont rejetés. Le récapitulatif personnalisé compte les deux méthodes de test, pas les itérations des sous-tests.
Leçons associées
- Python · Leçon 37 · Avancé · Version : 5
- Python · Leçon 34 · Intermédiaire · Version : 3
Sources
- 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)