Instance Variable |
failureException |
An exception class, defaulting to FailTest . If the test method
raises this exception, it will be reported as a failure, rather than an
exception. All of the assertion methods raise this if the assertion fails. |
Instance Variable |
skip |
None or a string explaining why this test is to be skipped. If
defined, the test will not be run. Instead, it will be reported to the
result object as 'skipped' (if the TestResult supports
skipping). |
Instance Variable |
suppress |
None or a list of tuples of (args, kwargs) to be
passed to warnings.filterwarnings . Use these to suppress
warnings raised in a test. Useful for testing deprecated code. See also util.suppress . |
Instance Variable |
timeout |
A real number of seconds. If set, the test will raise an error if it takes
longer than timeout seconds. If not set,
util.DEFAULT_TIMEOUT_DURATION is used. |
Instance Variable |
todo |
None , a string or a tuple of (errors, reason)
where errors is either an exception class or an iterable of
exception classes, and reason is a string. See Todo or makeTodo for
more information. |
Method |
__eq__ |
Undocumented |
Method |
__ne__ |
Undocumented |
Method |
shortDescription |
Return a short description of the test. |
Method |
__call__ |
Run the test. Should always do exactly the same thing as run(). |
Method |
deferSetUp |
Undocumented |
Method |
deferTestMethod |
Undocumented |
Method |
deferTearDown |
Undocumented |
Method |
deferRunCleanups |
Run any scheduled cleanups and report errors (if any to the result
object. |
Method |
flushLoggedErrors |
Remove stored errors received from the log. |
Method |
flushWarnings |
Remove stored warnings from the list of captured warnings and return
them. |
Method |
addCleanup |
Add the given function to a list of functions to be called after the
test has run, but before tearDown . |
Method |
callDeprecated |
Call a function that should have been deprecated at a specific version
and in favor of a specific alternative, and assert that it was thusly
deprecated. |
Method |
patch |
Monkey patch an object for the duration of the test. |
Method |
runTest |
If no methodName argument is passed to the constructor, run will
treat this method as the thing with the actual test inside. |
Method |
run |
Run the test case, storing the results in result . |
Method |
getSkip |
No summary |
Method |
getTodo |
No summary |
Method |
getTimeout |
No summary |
Method |
getSuppress |
No summary |
Method |
visit |
Visit this test case. Call visitor with self
as a parameter. |
Method |
mktemp |
Returns a unique name that may be used as either a temporary directory
or filename. |
Method |
_run |
Undocumented |
Method |
_ebDeferSetUp |
Undocumented |
Method |
_cbDeferTestMethod |
Undocumented |
Method |
_ebDeferTestMethod |
Undocumented |
Method |
_ebDeferTearDown |
Undocumented |
Method |
_cbDeferRunCleanups |
Undocumented |
Method |
_cleanUp |
Undocumented |
Method |
_classCleanUp |
Undocumented |
Method |
_makeReactorMethod |
Create a method which wraps the reactor method name . The
new method issues a deprecation warning and calls the original. |
Method |
_deprecateReactor |
Deprecate iterate , crash and stop
on reactor . That is, each method is wrapped in a function that
issues a deprecation warning, then calls the original. |
Method |
_undeprecateReactor |
Restore the deprecated reactor methods. Undoes what _deprecateReactor
did. |
Method |
_installObserver |
Undocumented |
Method |
_removeObserver |
Undocumented |
Method |
_runCleanups |
Run the cleanups added with addCleanup
in order. |
Method |
_getReason |
Undocumented |
Method |
_wait |
Take a Deferred that only ever callbacks. Block until it happens. |
Method |
fail |
Absolutely fail the test. Do not pass go, do not collect $200. |
Method |
failIf |
Fail the test if condition evaluates to True. |
Method |
failUnless |
Fail the test if condition evaluates to False. |
Method |
failUnlessRaises |
Fail the test unless calling the function f with the given
args and kwargs raises exception .
The failure will report the traceback and call stack of the unexpected
exception. |
Method |
assertEqual |
Fail the test if first and second are not
equal. |
Method |
failUnlessIdentical |
Fail the test if first is not second . This is
an obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method |
failIfIdentical |
Fail the test if first is second . This is an
obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method |
failIfEqual |
Fail the test if first == second . |
Method |
failUnlessIn |
Fail the test if containee is not found in
container . |
Method |
failIfIn |
Fail the test if containee is found in
container . |
Method |
failIfAlmostEqual |
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. |
Method |
failUnlessAlmostEqual |
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. |
Method |
failUnlessApproximates |
Fail if first - second >
tolerance |
Method |
failUnlessFailure |
Fail if deferred does not errback with one of
expectedFailures . Returns the original Deferred with callbacks
added. You will need to return this Deferred from your test case. |
Method |
failUnlessSubstring |
Fail if substring does not exist within
astring . |
Method |
failIfSubstring |
Fail if astring contains substring . |
Method |
failUnlessWarns |
Fail if the given function doesn't generate the specified warning when
called. It calls the function, checks the warning, and forwards the result
of the function if everything is fine. |
Method |
failUnlessIsInstance |
Fail if instance is not an instance of the given class or
of one of the given classes. |
Method |
failIfIsInstance |
Fail if instance is not an instance of the given class or
of one of the given classes. |