Module unittest :: Class TestCase
[hide private]
[frames] | no frames]

type TestCase

object --+
         |
        TestCase
Known Subclasses:

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the __init__ method, the base class __init__ method must always be called. It is important that subclasses should not change the signature of their __init__ method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

Nested Classes [hide private]
failureException
Assertion failed.
Instance Methods [hide private]
 
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test method when executed.
 
setUp(self)
Hook method for setting up the test fixture before exercising it.
 
tearDown(self)
Hook method for deconstructing the test fixture after testing it.
 
countTestCases(self)
 
defaultTestResult(self)
 
shortDescription(self)
Returns a one-line description of the test, or None if no description has been provided.
 
id(self)
 
__str__(self)
 
__repr__(self)
 
run(self, result=None)
 
__call__(self, *args, **kwds)
 
debug(self)
Run the test without collecting errors in a TestResult
 
_exc_info(self)
Return a version of sys.exc_info() with the traceback frame minimised; usually the top level of the traceback frame is not needed.
 
fail(self, msg=None)
Fail immediately, with the given message.
 
failIf(self, expr, msg=None)
Fail the test if the expression is true.
 
failUnless(self, expr, msg=None)
Fail the test unless the expression is true.
 
failUnlessRaises(self, excClass, callableObj, *args, **kwargs)
Fail unless an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs.
 
failUnlessEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '==' operator.
 
failIfEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '==' operator.
 
failUnlessAlmostEqual(self, first, second, places=7, msg=None)
Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
 
failIfAlmostEqual(self, first, second, places=7, msg=None)
Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
 
assertEquals(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '==' operator.
 
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '==' operator.
 
assertNotEquals(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '==' operator.
 
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '==' operator.
 
assertAlmostEquals(self, first, second, places=7, msg=None)
Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
 
assertAlmostEqual(self, first, second, places=7, msg=None)
Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
 
assertNotAlmostEquals(self, first, second, places=7, msg=None)
Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
 
assertNotAlmostEqual(self, first, second, places=7, msg=None)
Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
 
assertRaises(self, excClass, callableObj, *args, **kwargs)
Fail unless an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs.
 
assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
 
assert_(self, expr, msg=None)
Fail the test unless the expression is true.
 
assertFalse(self, expr, msg=None)
Fail the test if the expression is true.
Method Details [hide private]

__init__(self, methodName='runTest')
(Constructor)

 

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Overrides: object.__init__

shortDescription(self)

 

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method's docstring.

__str__(self)
(Informal representation operator)

 
Overrides: object.__str__
(inherited documentation)

__repr__(self)
(Representation operator)

 
Overrides: object.__repr__
(inherited documentation)

failUnlessRaises(self, excClass, callableObj, *args, **kwargs)

 

Fail unless an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is thrown, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

failUnlessAlmostEqual(self, first, second, places=7, msg=None)

 

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

failIfAlmostEqual(self, first, second, places=7, msg=None)

 

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

assertAlmostEquals(self, first, second, places=7, msg=None)

 

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

assertAlmostEqual(self, first, second, places=7, msg=None)

 

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

assertNotAlmostEquals(self, first, second, places=7, msg=None)

 

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

assertNotAlmostEqual(self, first, second, places=7, msg=None)

 

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

assertRaises(self, excClass, callableObj, *args, **kwargs)

 

Fail unless an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is thrown, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.