unittest

Python unit testing framework, based on Erich Gamma’s JUnit and Kent Beck’s Smalltalk testing framework.

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 ‘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

Copyright (c) 1999-2003 Steve Purcell Copyright (c) 2003-2010 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.

Functions

expectedFailure(func)
findTestCases(module[, prefix, sortUsing, ...])
getTestCaseNames(testCaseClass, prefix[, ...])
installHandler()
makeSuite(testCaseClass[, prefix, ...])
registerResult(result)
removeHandler([method])
removeResult(result)
skip(reason) Unconditionally skip a test.
skipIf(condition, reason) Skip a test if the condition is true.
skipUnless(condition, reason) Skip a test unless the condition is true.

Classes

BaseTestSuite([tests]) A simple test suite that doesn’t provide class or module shared fixtures.
FunctionTestCase(testFunc[, setUp, ...]) A test case that wraps a test function.
TestCase([methodName]) A class whose instances are single test cases.
TestLoader This class is responsible for loading tests according to various criteria
TestProgram([module, defaultTest, argv, ...]) A command-line program that runs a set of tests; this is primarily for making test modules conveniently executable.
TestResult([stream, descriptions, verbosity]) Holder for test result information.
TestSuite([tests]) A test suite is a composite test consisting of a number of TestCases.
TextTestResult(stream, descriptions, verbosity) A test result class that can print formatted text results to a stream.
TextTestRunner([stream, descriptions, ...]) A test runner class that displays results in textual form.
main alias of TestProgram

Exceptions

SkipTest Raise this exception in a test to skip it.