Knowledge baseExam Center
ENEnglish
Choose language13

CKTIS / Python

unittest.TestCase

Defines a fixture-backed test with assertion methods and a lifecycle managed by the test runner.

Version: Python 3.14; repository image, production runtime not attested

Syntax

unittest.TestCase(methodName='runTest')

Defines a fixture-backed test with assertion methods and a lifecycle managed by the test runner.

A failed assertion is recorded as a test failure when the case runs through its result object rather than escaping as an unhandled application exception.

One TestCase instance runs the named method. After a successful setUp, tearDown runs even when the body fails. Registered cleanups run after tearDown when setUp succeeds, and run without tearDown when setUp fails. Assertion failures go to failures, while an unrelated ValueError goes to errors. The example compares 4 and 5 and prints 1 1 0. When setUp fails, neither the test body nor tearDown runs. Registered cleanups run last-in, first-out. A subTest identifies a failing variant and ordinarily permits later variants to run.

import unittest
events=[]
class Check(unittest.TestCase):
    def setUp(self):
        events.append('up')
        self.addCleanup(events.append,'clean')
    def tearDown(self): events.append('down')
    def test_bad(self): self.assertEqual(2,3)
    def test_error(self): raise ValueError('bad')
r=unittest.TestResult()
Check('test_bad').run(r)
assert events==['up','down','clean'] and len(r.failures)==1
Check('test_error').run(r)
assert len(r.errors)==1 and r.testsRun==2
class Broken(unittest.TestCase):
    def setUp(self):
        self.addCleanup(events.append,'first')
        self.addCleanup(events.append,'second')
        raise ValueError('setup')
    def tearDown(self): events.append('down')
    def test_a(self): events.append('body')
events.clear()
Broken('test_a').run(r)
assert events==['second','first']
class Variants(unittest.TestCase):
    def test_loop(self):
        for n in (1,2):
            with self.subTest(n=n):
                events.append(n)
                self.assertEqual(n,2)
r2=unittest.TestResult()
Variants('test_loop').run(r2)
assert events[-2:]==[1,2] and r2.testsRun==1 and len(r2.failures)==1

unittest.TestCase.setUp · unittest.TestCase.assertEqual · unittest.TestCase.assertRaises · unittest.TestCase.subTest

setUp prepares state before the test method. assertEqual compares the result and expectation. assertRaises(KeyError) requires that exception or a subclass. subTest(key=...) labels variants within one method, so testsRun remains 1.

import unittest
class PriceTests(unittest.TestCase):
    def setUp(self):
        self.values = {"small": 2}
    def test_sizes(self):
        for key, expected in [("small",2),("other",0)]:
            with self.subTest(key=key):
                self.assertEqual(self.values.get(key,0),expected)
        with self.assertRaises(KeyError):
            self.values["missing"]
r=unittest.TestResult()
PriceTests("test_sizes").run(r)
assert r.testsRun==1 and r.wasSuccessful()

Examples

import unittest
class Check(unittest.TestCase):
    def test_total(self): self.assertEqual(4, 5)

r = unittest.TestResult()
Check("test_total").run(r)
print(r.testsRun, len(r.failures), len(r.errors))

Result

1 1 0

One TestCase instance runs the named method. After a successful setUp, tearDown runs even when the body fails. Registered cleanups run after tearDown when setUp succeeds, and run without tearDown when setUp fails. Assertion failures go to failures, while an unrelated ValueError goes to errors. The example compares 4 and 5 and prints 1 1 0. When setUp fails, neither the test body nor tearDown runs. Registered cleanups run last-in, first-out. A subTest identifies a failing variant and ordinarily permits later variants to run.

Sources