with self.assertRaises(KeyError):

Testing Patterns

Meaning

Asserts that a block of code raises a specified exception, used in unit tests to verify error handling. It ensures that the tested code path correctly raises the expected exception, making test intent explicit and reducing boilerplate try/except code.

Primary Function

Unit testing

Communicative Purpose

Verifies that a specific exception is raised by code under test.

Pattern

with self.assertRaises(exception_type):

Core Structure

with self.assertRaises(...):

Função primária

Unit testing

Propósito comunicativo

Verifies that a specific exception is raised by code under test.

Situações de gatilho

Python unit testing: testing dictionary access with missing keys; Python unit testing: validating error paths in APIs; Python unit testing: ensuring custom exceptions are raised.

Contextos

Python unittest framework; test suites using unittest.TestCase; also usable with pytest via unittest compatibility.

Padrão

with self.assertRaises(exception_type):

Estrutura central

with self.assertRaises(...):

Slots de substituição

exception_type: Exception class (e.g., KeyError, ValueError, CustomError)

Colocados típicos

assertEqual
assertIn
setUp
tearDown
test method naming

Substituições comuns

Using assertRaisesRegex for message checking
using pytest.raises(context manager).

Erros comuns

Forgetting the colon; using assertRaises without context manager (old style); asserting wrong exception type; missing indentation.

Similar / contraste

assertRaisesRegex (checks exception message); assertWarns (for warnings); using try/except block manually.

Interferências

Coming from Java: expecting @Test(expected=Exception.class) syntax; from JavaScript: using try/catch with expect(toThrow).

Família do chunk

assertRaises
assertRaisesRegex
assertWarns
assertWarnsRegex

Nuance

The context manager captures the exception; if no exception is raised, the test fails. If multiple exceptions could be raised, only the first is checked. Performance impact negligible.

Efeito pragmático

Makes test intent explicit and reduces boilerplate try/except code.

Dica de memória

‘with self.assertRaises’ – think ‘with I expect this error’.

Nota

Can be used with any Exception subclass, including custom exceptions.

Upgrade path

Use assertRaisesRegex to also validate exception message, or adopt pytest.raises for a more concise syntax.

Frequência: MediumFormulaicidade: Semi-fixedTipo de construção: context manager idiomPrioridade de aquisição: Active recallPrioridade de output: BothTag de espaçamento: Short-term

Examples

import unittest\n\nclass TestDictAccess(unittest.TestCase):\n def test_missing_key(self):\n d = {'a': 1}\n with self.assertRaises(KeyError):\n _ = d['b']\n\nif __name__ == '__main__':\n unittest.main()

import unittest\n\ndef divide(a, b):\n if b == 0:\n raise ValueError('division by zero')\n return a / b\n\nclass TestDivision(unittest.TestCase):\n def test_div_by_zero(self):\n with self.assertRaises(ValueError):\n divide(5, 0)\n\nif __name__ == '__main__':\n unittest.main()

import unittest\n\nclass CustomError(Exception):\n pass\n\ndef risky():\n raise CustomError('something went wrong')\n\nclass TestCustom(unittest.TestCase):\n def test_custom_error(self):\n with self.assertRaises(CustomError):\n risky()\n\nif __name__ == '__main__':\n unittest.main()