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.

Method Summary

__init__(self,
methodName)
Create an instance of the class that will use the named test
method when executed.

assertAlmostEqual(self,
first,
second,
places,
msg)
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.

assertAlmostEquals(self,
first,
second,
places,
msg)
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.

assertEqual(self,
first,
second,
msg)
Fail if the two objects are unequal as determined by the '=='
operator.

assertEquals(self,
first,
second,
msg)
Fail if the two objects are unequal as determined by the '=='
operator.

assertNotAlmostEqual(self,
first,
second,
places,
msg)
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.

assertNotAlmostEquals(self,
first,
second,
places,
msg)
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.

assertNotEqual(self,
first,
second,
msg)
Fail if the two objects are equal as determined by the '=='
operator.

assertNotEquals(self,
first,
second,
msg)
Fail if the two objects are equal as determined by the '=='
operator.

failUnlessAlmostEqual(self,
first,
second,
places,
msg)
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.

failUnlessEqual(self,
first,
second,
msg)
Fail if the two objects are unequal as determined by the '=='
operator.

assert_(self,
expr,
msg=None)

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).

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).

assertEqual(self,
first,
second,
msg=None)

Fail if the two objects are unequal as determined by the '=='
operator.

assertEquals(self,
first,
second,
msg=None)

Fail if the two objects are unequal as determined by the '=='
operator.

assertFalse(self,
expr,
msg=None)

Fail the test if the expression is true.

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).

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).

assertNotEqual(self,
first,
second,
msg=None)

Fail if the two objects are equal as determined by the '=='
operator.

assertNotEquals(self,
first,
second,
msg=None)

Fail if the two objects are equal as determined by the '=='
operator.

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.

assertTrue(self,
expr,
msg=None)

Fail the test unless the expression is true.

debug(self)

Run the test without collecting errors in a TestResult

fail(self,
msg=None)

Fail immediately, with the given message.

failIf(self,
expr,
msg=None)

Fail the test if the expression is true.

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).

failIfEqual(self,
first,
second,
msg=None)

Fail if the two objects are equal as determined by the '=='
operator.

failUnless(self,
expr,
msg=None)

Fail the test unless the expression is true.

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).

failUnlessEqual(self,
first,
second,
msg=None)

Fail if the two objects are unequal as determined by the '=='
operator.

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.

setUp(self)

Hook method for setting up the test fixture before exercising it.

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.