unittest

Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's
Smalltalk testing framework (used with permission).

This module contains the core framework classes that form the basis of
specific test cases and suites (TestCase, TestSuite etc.), and also a
text-based utility class for running the tests and reporting the results
 (TextTestRunner).

Simple usage:

    import unittest

    class IntegerArithmeticTestCase(unittest.TestCase):
        def testAdd(self):  # test method names begin with 'test'
            self.assertEqual((1 + 2), 3)
            self.assertEqual(0 + 1, 1)
        def testMultiply(self):
            self.assertEqual((0 * 10), 0)
            self.assertEqual((5 * 8), 40)

    if __name__ == '__main__':
        unittest.main()

Further information is available in the bundled documentation, and from

  http://docs.python.org/library/unittest.html

Copyright (c) 1999-2003 Steve Purcell
Copyright (c) 2003 Python Software Foundation
This module is free software, and you may redistribute it and/or modify
it under the same terms as Python itself, so long as this copyright message
and disclaimer are retained in their original form.

IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF
THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Symbols in unittest

a

addModuleCleanup: Same as addCleanup, except the cleanup items are called even if setUpModule fails (unlike tearDownModule).

d

defaultTestLoader: Instance of the TestLoader class intended to be shared.
doModuleCleanups: Execute all module cleanup functions.

e

enterModuleContext: Same as enterContext, but module-wide.
expectedFailure: Mark the test as an expected failure or error.

f

FunctionTestCase: A test case that wraps a test function.

i

installHandler: Install the control-c handler.
IsolatedAsyncioTestCase: This class provides an API similar to TestCase and also accepts coroutines as test functions.

m

main: A command-line program that runs a set of tests; this is primarily for making test modules conveniently executable.

r

registerResult: Register a TestResult object for control-c handling.
removeHandler: When called without arguments this function removes the control-c handler if it has been installed.
removeResult: Remove a registered result.

s

setUpModule: These should be implemented as functions:
skip: Unconditionally skip a test.
skipIf: Skip a test if the condition is true.
SkipTest: Raise this exception in a test to skip it.
skipUnless: Skip a test unless the condition is true.

t

tearDownModule: These should be implemented as functions:
TestCase: A class whose instances are single test cases.
TestLoader: This class is responsible for loading tests according to various criteria and returning them wrapped in a TestSuite
TestResult: Holder for test result information.
TestSuite: A test suite is a composite test consisting of a number of TestCases.
TextTestResult: A test result class that can print formatted text results to a stream.
TextTestRunner: A test runner class that displays results in textual form.

PyDocs

Development Tools

Development Tools

All modules

unittest

Symbols in unittest

a

d

e

f

i

m

r

s

t