doc_content
stringlengths
1
386k
doc_id
stringlengths
5
188
unittest.registerResult(result) Register a TestResult object for control-c handling. Registering a result stores a weak reference to it, so it doesn’t prevent the result from being garbage collected. Registering a TestResult object has no side-effects if control-c handling is not enabled, so test frameworks can uncon...
python.library.unittest#unittest.registerResult
unittest.removeHandler(function=None) When called without arguments this function removes the control-c handler if it has been installed. This function can also be used as a test decorator to temporarily remove the handler while the test is being executed: @unittest.removeHandler def test_signal_handling(self): ....
python.library.unittest#unittest.removeHandler
unittest.removeResult(result) Remove a registered result. Once a result has been removed then stop() will no longer be called on that result object in response to a control-c.
python.library.unittest#unittest.removeResult
@unittest.skip(reason) Unconditionally skip the decorated test. reason should describe why the test is being skipped.
python.library.unittest#unittest.skip
@unittest.skipIf(condition, reason) Skip the decorated test if condition is true.
python.library.unittest#unittest.skipIf
exception unittest.SkipTest(reason) This exception is raised to skip a test. Usually you can use TestCase.skipTest() or one of the skipping decorators instead of raising this directly.
python.library.unittest#unittest.SkipTest
@unittest.skipUnless(condition, reason) Skip the decorated test unless condition is true.
python.library.unittest#unittest.skipUnless
class unittest.TestCase(methodName='runTest') Instances of the TestCase class represent the logical test units in the unittest universe. This class is intended to be used as a base class, with specific tests being implemented by concrete subclasses. This class implements the interface needed by the test runner to all...
python.library.unittest#unittest.TestCase
classmethod addClassCleanup(function, /, *args, **kwargs) Add a function to be called after tearDownClass() to cleanup resources used during the test class. Functions will be called in reverse order to the order they are added (LIFO). They are called with any arguments and keyword arguments passed into addClassCleanu...
python.library.unittest#unittest.TestCase.addClassCleanup
addCleanup(function, /, *args, **kwargs) Add a function to be called after tearDown() to cleanup resources used during the test. Functions will be called in reverse order to the order they are added (LIFO). They are called with any arguments and keyword arguments passed into addCleanup() when they are added. If setUp...
python.library.unittest#unittest.TestCase.addCleanup
addTypeEqualityFunc(typeobj, function) Registers a type-specific method called by assertEqual() to check if two objects of exactly the same typeobj (not subclasses) compare equal. function must take two positional arguments and a third msg=None keyword argument just as assertEqual() does. It must raise self.failureEx...
python.library.unittest#unittest.TestCase.addTypeEqualityFunc
assertAlmostEqual(first, second, places=7, msg=None, delta=None) assertNotAlmostEqual(first, second, places=7, msg=None, delta=None) Test that first and second are approximately (or not approximately) equal by computing the difference, rounding to the given number of decimal places (default 7), and comparing to zer...
python.library.unittest#unittest.TestCase.assertAlmostEqual
assertCountEqual(first, second, msg=None) Test that sequence first contains the same elements as second, regardless of their order. When they don’t, an error message listing the differences between the sequences will be generated. Duplicate elements are not ignored when comparing first and second. It verifies whether...
python.library.unittest#unittest.TestCase.assertCountEqual
assertDictEqual(first, second, msg=None) Test that two dictionaries are equal. If not, an error message is constructed that shows the differences in the dictionaries. This method will be used by default to compare dictionaries in calls to assertEqual(). New in version 3.1.
python.library.unittest#unittest.TestCase.assertDictEqual
assertEqual(first, second, msg=None) Test that first and second are equal. If the values do not compare equal, the test will fail. In addition, if first and second are the exact same type and one of list, tuple, dict, set, frozenset or str or any type that a subclass registers with addTypeEqualityFunc() the type-spec...
python.library.unittest#unittest.TestCase.assertEqual
assertTrue(expr, msg=None) assertFalse(expr, msg=None) Test that expr is true (or false). Note that this is equivalent to bool(expr) is True and not to expr is True (use assertIs(expr, True) for the latter). This method should also be avoided when more specific methods are available (e.g. assertEqual(a, b) instead ...
python.library.unittest#unittest.TestCase.assertFalse
assertGreater(first, second, msg=None) assertGreaterEqual(first, second, msg=None) assertLess(first, second, msg=None) assertLessEqual(first, second, msg=None) Test that first is respectively >, >=, < or <= than second depending on the method name. If not, the test will fail: >>> self.assertGreaterEqual(3, 4) A...
python.library.unittest#unittest.TestCase.assertGreater
assertGreater(first, second, msg=None) assertGreaterEqual(first, second, msg=None) assertLess(first, second, msg=None) assertLessEqual(first, second, msg=None) Test that first is respectively >, >=, < or <= than second depending on the method name. If not, the test will fail: >>> self.assertGreaterEqual(3, 4) A...
python.library.unittest#unittest.TestCase.assertGreaterEqual
assertIn(member, container, msg=None) assertNotIn(member, container, msg=None) Test that member is (or is not) in container. New in version 3.1.
python.library.unittest#unittest.TestCase.assertIn
assertIs(first, second, msg=None) assertIsNot(first, second, msg=None) Test that first and second are (or are not) the same object. New in version 3.1.
python.library.unittest#unittest.TestCase.assertIs
assertIsInstance(obj, cls, msg=None) assertNotIsInstance(obj, cls, msg=None) Test that obj is (or is not) an instance of cls (which can be a class or a tuple of classes, as supported by isinstance()). To check for the exact type, use assertIs(type(obj), cls). New in version 3.2.
python.library.unittest#unittest.TestCase.assertIsInstance
assertIsNone(expr, msg=None) assertIsNotNone(expr, msg=None) Test that expr is (or is not) None. New in version 3.1.
python.library.unittest#unittest.TestCase.assertIsNone
assertIs(first, second, msg=None) assertIsNot(first, second, msg=None) Test that first and second are (or are not) the same object. New in version 3.1.
python.library.unittest#unittest.TestCase.assertIsNot
assertIsNone(expr, msg=None) assertIsNotNone(expr, msg=None) Test that expr is (or is not) None. New in version 3.1.
python.library.unittest#unittest.TestCase.assertIsNotNone
assertGreater(first, second, msg=None) assertGreaterEqual(first, second, msg=None) assertLess(first, second, msg=None) assertLessEqual(first, second, msg=None) Test that first is respectively >, >=, < or <= than second depending on the method name. If not, the test will fail: >>> self.assertGreaterEqual(3, 4) A...
python.library.unittest#unittest.TestCase.assertLess
assertGreater(first, second, msg=None) assertGreaterEqual(first, second, msg=None) assertLess(first, second, msg=None) assertLessEqual(first, second, msg=None) Test that first is respectively >, >=, < or <= than second depending on the method name. If not, the test will fail: >>> self.assertGreaterEqual(3, 4) A...
python.library.unittest#unittest.TestCase.assertLessEqual
assertListEqual(first, second, msg=None) assertTupleEqual(first, second, msg=None) Tests that two lists or tuples are equal. If not, an error message is constructed that shows only the differences between the two. An error is also raised if either of the parameters are of the wrong type. These methods are used by d...
python.library.unittest#unittest.TestCase.assertListEqual
assertLogs(logger=None, level=None) A context manager to test that at least one message is logged on the logger or one of its children, with at least the given level. If given, logger should be a logging.Logger object or a str giving the name of a logger. The default is the root logger, which will catch all messages ...
python.library.unittest#unittest.TestCase.assertLogs
assertMultiLineEqual(first, second, msg=None) Test that the multiline string first is equal to the string second. When not equal a diff of the two strings highlighting the differences will be included in the error message. This method is used by default when comparing strings with assertEqual(). New in version 3.1.
python.library.unittest#unittest.TestCase.assertMultiLineEqual
assertAlmostEqual(first, second, places=7, msg=None, delta=None) assertNotAlmostEqual(first, second, places=7, msg=None, delta=None) Test that first and second are approximately (or not approximately) equal by computing the difference, rounding to the given number of decimal places (default 7), and comparing to zer...
python.library.unittest#unittest.TestCase.assertNotAlmostEqual
assertNotEqual(first, second, msg=None) Test that first and second are not equal. If the values do compare equal, the test will fail.
python.library.unittest#unittest.TestCase.assertNotEqual
assertIn(member, container, msg=None) assertNotIn(member, container, msg=None) Test that member is (or is not) in container. New in version 3.1.
python.library.unittest#unittest.TestCase.assertNotIn
assertIsInstance(obj, cls, msg=None) assertNotIsInstance(obj, cls, msg=None) Test that obj is (or is not) an instance of cls (which can be a class or a tuple of classes, as supported by isinstance()). To check for the exact type, use assertIs(type(obj), cls). New in version 3.2.
python.library.unittest#unittest.TestCase.assertNotIsInstance
assertRegex(text, regex, msg=None) assertNotRegex(text, regex, msg=None) Test that a regex search matches (or does not match) text. In case of failure, the error message will include the pattern and the text (or the pattern and the part of text that unexpectedly matched). regex may be a regular expression object or...
python.library.unittest#unittest.TestCase.assertNotRegex
assertRaises(exception, callable, *args, **kwds) assertRaises(exception, *, msg=None) Test that an exception is raised when callable is called with any positional or keyword arguments that are also passed to assertRaises(). The test passes if exception is raised, is an error if another exception is raised, or fails...
python.library.unittest#unittest.TestCase.assertRaises
assertRaisesRegex(exception, regex, callable, *args, **kwds) assertRaisesRegex(exception, regex, *, msg=None) Like assertRaises() but also tests that regex matches on the string representation of the raised exception. regex may be a regular expression object or a string containing a regular expression suitable for ...
python.library.unittest#unittest.TestCase.assertRaisesRegex
assertRegex(text, regex, msg=None) assertNotRegex(text, regex, msg=None) Test that a regex search matches (or does not match) text. In case of failure, the error message will include the pattern and the text (or the pattern and the part of text that unexpectedly matched). regex may be a regular expression object or...
python.library.unittest#unittest.TestCase.assertRegex
assertSequenceEqual(first, second, msg=None, seq_type=None) Tests that two sequences are equal. If a seq_type is supplied, both first and second must be instances of seq_type or a failure will be raised. If the sequences are different an error message is constructed that shows the difference between the two. This met...
python.library.unittest#unittest.TestCase.assertSequenceEqual
assertSetEqual(first, second, msg=None) Tests that two sets are equal. If not, an error message is constructed that lists the differences between the sets. This method is used by default when comparing sets or frozensets with assertEqual(). Fails if either of first or second does not have a set.difference() method. ...
python.library.unittest#unittest.TestCase.assertSetEqual
assertTrue(expr, msg=None) assertFalse(expr, msg=None) Test that expr is true (or false). Note that this is equivalent to bool(expr) is True and not to expr is True (use assertIs(expr, True) for the latter). This method should also be avoided when more specific methods are available (e.g. assertEqual(a, b) instead ...
python.library.unittest#unittest.TestCase.assertTrue
assertListEqual(first, second, msg=None) assertTupleEqual(first, second, msg=None) Tests that two lists or tuples are equal. If not, an error message is constructed that shows only the differences between the two. An error is also raised if either of the parameters are of the wrong type. These methods are used by d...
python.library.unittest#unittest.TestCase.assertTupleEqual
assertWarns(warning, callable, *args, **kwds) assertWarns(warning, *, msg=None) Test that a warning is triggered when callable is called with any positional or keyword arguments that are also passed to assertWarns(). The test passes if warning is triggered and fails if it isn’t. Any exception is an error. To catch ...
python.library.unittest#unittest.TestCase.assertWarns
assertWarnsRegex(warning, regex, callable, *args, **kwds) assertWarnsRegex(warning, regex, *, msg=None) Like assertWarns() but also tests that regex matches on the message of the triggered warning. regex may be a regular expression object or a string containing a regular expression suitable for use by re.search(). ...
python.library.unittest#unittest.TestCase.assertWarnsRegex
countTestCases() Return the number of tests represented by this test object. For TestCase instances, this will always be 1.
python.library.unittest#unittest.TestCase.countTestCases
debug() Run the test without collecting the result. This allows exceptions raised by the test to be propagated to the caller, and can be used to support running tests under a debugger.
python.library.unittest#unittest.TestCase.debug
defaultTestResult() Return an instance of the test result class that should be used for this test case class (if no other result instance is provided to the run() method). For TestCase instances, this will always be an instance of TestResult; subclasses of TestCase should override this as necessary.
python.library.unittest#unittest.TestCase.defaultTestResult
classmethod doClassCleanups() This method is called unconditionally after tearDownClass(), or after setUpClass() if setUpClass() raises an exception. It is responsible for calling all the cleanup functions added by addClassCleanup(). If you need cleanup functions to be called prior to tearDownClass() then you can cal...
python.library.unittest#unittest.TestCase.doClassCleanups
doCleanups() This method is called unconditionally after tearDown(), or after setUp() if setUp() raises an exception. It is responsible for calling all the cleanup functions added by addCleanup(). If you need cleanup functions to be called prior to tearDown() then you can call doCleanups() yourself. doCleanups() pops...
python.library.unittest#unittest.TestCase.doCleanups
fail(msg=None) Signals a test failure unconditionally, with msg or None for the error message.
python.library.unittest#unittest.TestCase.fail
failureException This class attribute gives the exception raised by the test method. If a test framework needs to use a specialized exception, possibly to carry additional information, it must subclass this exception in order to “play fair” with the framework. The initial value of this attribute is AssertionError.
python.library.unittest#unittest.TestCase.failureException
id() Return a string identifying the specific test case. This is usually the full name of the test method, including the module and class name.
python.library.unittest#unittest.TestCase.id
longMessage This class attribute determines what happens when a custom failure message is passed as the msg argument to an assertXYY call that fails. True is the default value. In this case, the custom message is appended to the end of the standard failure message. When set to False, the custom message replaces the s...
python.library.unittest#unittest.TestCase.longMessage
maxDiff This attribute controls the maximum length of diffs output by assert methods that report diffs on failure. It defaults to 80*8 characters. Assert methods affected by this attribute are assertSequenceEqual() (including all the sequence comparison methods that delegate to it), assertDictEqual() and assertMultiL...
python.library.unittest#unittest.TestCase.maxDiff
output A list of str objects with the formatted output of matching messages.
python.library.unittest#unittest.TestCase.output
records A list of logging.LogRecord objects of the matching log messages.
python.library.unittest#unittest.TestCase.records
run(result=None) Run the test, collecting the result into the TestResult object passed as result. If result is omitted or None, a temporary result object is created (by calling the defaultTestResult() method) and used. The result object is returned to run()’s caller. The same effect may be had by simply calling the T...
python.library.unittest#unittest.TestCase.run
setUp() Method called to prepare the test fixture. This is called immediately before calling the test method; other than AssertionError or SkipTest, any exception raised by this method will be considered an error rather than a test failure. The default implementation does nothing.
python.library.unittest#unittest.TestCase.setUp
setUpClass() A class method called before tests in an individual class are run. setUpClass is called with the class as the only argument and must be decorated as a classmethod(): @classmethod def setUpClass(cls): ... See Class and Module Fixtures for more details. New in version 3.2.
python.library.unittest#unittest.TestCase.setUpClass
shortDescription() Returns a description of the test, or None if no description has been provided. The default implementation of this method returns the first line of the test method’s docstring, if available, or None. Changed in version 3.1: In 3.1 this was changed to add the test name to the short description even...
python.library.unittest#unittest.TestCase.shortDescription
skipTest(reason) Calling this during a test method or setUp() skips the current test. See Skipping tests and expected failures for more information. New in version 3.1.
python.library.unittest#unittest.TestCase.skipTest
subTest(msg=None, **params) Return a context manager which executes the enclosed code block as a subtest. msg and params are optional, arbitrary values which are displayed whenever a subtest fails, allowing you to identify them clearly. A test case can contain any number of subtest declarations, and they can be arbit...
python.library.unittest#unittest.TestCase.subTest
tearDown() Method called immediately after the test method has been called and the result recorded. This is called even if the test method raised an exception, so the implementation in subclasses may need to be particularly careful about checking internal state. Any exception, other than AssertionError or SkipTest, r...
python.library.unittest#unittest.TestCase.tearDown
tearDownClass() A class method called after tests in an individual class have run. tearDownClass is called with the class as the only argument and must be decorated as a classmethod(): @classmethod def tearDownClass(cls): ... See Class and Module Fixtures for more details. New in version 3.2.
python.library.unittest#unittest.TestCase.tearDownClass
class unittest.TestLoader The TestLoader class is used to create test suites from classes and modules. Normally, there is no need to create an instance of this class; the unittest module provides an instance that can be shared as unittest.defaultTestLoader. Using a subclass or instance, however, allows customization ...
python.library.unittest#unittest.TestLoader
discover(start_dir, pattern='test*.py', top_level_dir=None) Find all the test modules by recursing into subdirectories from the specified start directory, and return a TestSuite object containing them. Only test files that match pattern will be loaded. (Using shell style pattern matching.) Only module names that are ...
python.library.unittest#unittest.TestLoader.discover
errors A list of the non-fatal errors encountered while loading tests. Not reset by the loader at any point. Fatal errors are signalled by the relevant a method raising an exception to the caller. Non-fatal errors are also indicated by a synthetic test that will raise the original error when run. New in version 3.5.
python.library.unittest#unittest.TestLoader.errors
getTestCaseNames(testCaseClass) Return a sorted sequence of method names found within testCaseClass; this should be a subclass of TestCase.
python.library.unittest#unittest.TestLoader.getTestCaseNames
loadTestsFromModule(module, pattern=None) Return a suite of all test cases contained in the given module. This method searches module for classes derived from TestCase and creates an instance of the class for each test method defined for the class. Note While using a hierarchy of TestCase-derived classes can be conv...
python.library.unittest#unittest.TestLoader.loadTestsFromModule
loadTestsFromName(name, module=None) Return a suite of all test cases given a string specifier. The specifier name is a “dotted name” that may resolve either to a module, a test case class, a test method within a test case class, a TestSuite instance, or a callable object which returns a TestCase or TestSuite instanc...
python.library.unittest#unittest.TestLoader.loadTestsFromName
loadTestsFromNames(names, module=None) Similar to loadTestsFromName(), but takes a sequence of names rather than a single name. The return value is a test suite which supports all the tests defined for each name.
python.library.unittest#unittest.TestLoader.loadTestsFromNames
loadTestsFromTestCase(testCaseClass) Return a suite of all test cases contained in the TestCase-derived testCaseClass. A test case instance is created for each method named by getTestCaseNames(). By default these are the method names beginning with test. If getTestCaseNames() returns no methods, but the runTest() met...
python.library.unittest#unittest.TestLoader.loadTestsFromTestCase
sortTestMethodsUsing Function to be used to compare method names when sorting them in getTestCaseNames() and all the loadTestsFrom*() methods.
python.library.unittest#unittest.TestLoader.sortTestMethodsUsing
suiteClass Callable object that constructs a test suite from a list of tests. No methods on the resulting object are needed. The default value is the TestSuite class. This affects all the loadTestsFrom*() methods.
python.library.unittest#unittest.TestLoader.suiteClass
testMethodPrefix String giving the prefix of method names which will be interpreted as test methods. The default value is 'test'. This affects getTestCaseNames() and all the loadTestsFrom*() methods.
python.library.unittest#unittest.TestLoader.testMethodPrefix
testNamePatterns List of Unix shell-style wildcard test name patterns that test methods have to match to be included in test suites (see -v option). If this attribute is not None (the default), all test methods to be included in test suites must match one of the patterns in this list. Note that matches are always per...
python.library.unittest#unittest.TestLoader.testNamePatterns
class unittest.TestResult This class is used to compile information about which tests have succeeded and which have failed. A TestResult object stores the results of a set of tests. The TestCase and TestSuite classes ensure that results are properly recorded; test authors do not need to worry about recording the outc...
python.library.unittest#unittest.TestResult
addError(test, err) Called when the test case test raises an unexpected exception. err is a tuple of the form returned by sys.exc_info(): (type, value, traceback). The default implementation appends a tuple (test, formatted_err) to the instance’s errors attribute, where formatted_err is a formatted traceback derived ...
python.library.unittest#unittest.TestResult.addError
addExpectedFailure(test, err) Called when the test case test fails or errors, but was marked with the expectedFailure() decorator. The default implementation appends a tuple (test, formatted_err) to the instance’s expectedFailures attribute, where formatted_err is a formatted traceback derived from err.
python.library.unittest#unittest.TestResult.addExpectedFailure
addFailure(test, err) Called when the test case test signals a failure. err is a tuple of the form returned by sys.exc_info(): (type, value, traceback). The default implementation appends a tuple (test, formatted_err) to the instance’s failures attribute, where formatted_err is a formatted traceback derived from err.
python.library.unittest#unittest.TestResult.addFailure
addSkip(test, reason) Called when the test case test is skipped. reason is the reason the test gave for skipping. The default implementation appends a tuple (test, reason) to the instance’s skipped attribute.
python.library.unittest#unittest.TestResult.addSkip
addSubTest(test, subtest, outcome) Called when a subtest finishes. test is the test case corresponding to the test method. subtest is a custom TestCase instance describing the subtest. If outcome is None, the subtest succeeded. Otherwise, it failed with an exception where outcome is a tuple of the form returned by sy...
python.library.unittest#unittest.TestResult.addSubTest
addSuccess(test) Called when the test case test succeeds. The default implementation does nothing.
python.library.unittest#unittest.TestResult.addSuccess
addUnexpectedSuccess(test) Called when the test case test was marked with the expectedFailure() decorator, but succeeded. The default implementation appends the test to the instance’s unexpectedSuccesses attribute.
python.library.unittest#unittest.TestResult.addUnexpectedSuccess
buffer If set to true, sys.stdout and sys.stderr will be buffered in between startTest() and stopTest() being called. Collected output will only be echoed onto the real sys.stdout and sys.stderr if the test fails or errors. Any output is also attached to the failure / error message. New in version 3.2.
python.library.unittest#unittest.TestResult.buffer
errors A list containing 2-tuples of TestCase instances and strings holding formatted tracebacks. Each tuple represents a test which raised an unexpected exception.
python.library.unittest#unittest.TestResult.errors
expectedFailures A list containing 2-tuples of TestCase instances and strings holding formatted tracebacks. Each tuple represents an expected failure or error of the test case.
python.library.unittest#unittest.TestResult.expectedFailures
failfast If set to true stop() will be called on the first failure or error, halting the test run. New in version 3.2.
python.library.unittest#unittest.TestResult.failfast
failures A list containing 2-tuples of TestCase instances and strings holding formatted tracebacks. Each tuple represents a test where a failure was explicitly signalled using the TestCase.assert*() methods.
python.library.unittest#unittest.TestResult.failures
shouldStop Set to True when the execution of tests should stop by stop().
python.library.unittest#unittest.TestResult.shouldStop
skipped A list containing 2-tuples of TestCase instances and strings holding the reason for skipping the test. New in version 3.1.
python.library.unittest#unittest.TestResult.skipped
startTest(test) Called when the test case test is about to be run.
python.library.unittest#unittest.TestResult.startTest
startTestRun() Called once before any tests are executed. New in version 3.1.
python.library.unittest#unittest.TestResult.startTestRun
stop() This method can be called to signal that the set of tests being run should be aborted by setting the shouldStop attribute to True. TestRunner objects should respect this flag and return without running any additional tests. For example, this feature is used by the TextTestRunner class to stop the test framewor...
python.library.unittest#unittest.TestResult.stop
stopTest(test) Called after the test case test has been executed, regardless of the outcome.
python.library.unittest#unittest.TestResult.stopTest
stopTestRun() Called once after all tests are executed. New in version 3.1.
python.library.unittest#unittest.TestResult.stopTestRun
tb_locals If set to true then local variables will be shown in tracebacks. New in version 3.5.
python.library.unittest#unittest.TestResult.tb_locals
testsRun The total number of tests run so far.
python.library.unittest#unittest.TestResult.testsRun
unexpectedSuccesses A list containing TestCase instances that were marked as expected failures, but succeeded.
python.library.unittest#unittest.TestResult.unexpectedSuccesses
wasSuccessful() Return True if all tests run so far have passed, otherwise returns False. Changed in version 3.4: Returns False if there were any unexpectedSuccesses from tests marked with the expectedFailure() decorator.
python.library.unittest#unittest.TestResult.wasSuccessful
class unittest.TestSuite(tests=()) This class represents an aggregation of individual test cases and test suites. The class presents the interface needed by the test runner to allow it to be run as any other test case. Running a TestSuite instance is the same as iterating over the suite, running each test individuall...
python.library.unittest#unittest.TestSuite