twisted.trial.unittest.TestCase

class documentation

class TestCase(SynchronousTestCase): (source)

Implements interfaces: twisted.trial.itrial.ITestCase

A unit test. The atom of the unit testing universe.

This class extends SynchronousTestCase which extends unittest.TestCase from the standard library. The main feature is the ability to return Deferreds from tests and fixture methods and to have the suite wait for those Deferreds to fire. Also provides new assertions such as assertFailure.

Method	`__call__`	Run the test. Should always do exactly the same thing as run().
Method	`__init__`	Construct an asynchronous test case for `methodName`.
Method	`addCleanup`	Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method	`assertFailure`	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	`deferRunCleanups`	Run any scheduled cleanups and report errors (if any) to the result. object.
Method	`deferSetUp`	Undocumented
Method	`deferTearDown`	Undocumented
Method	`deferTestMethod`	Undocumented
Method	`getSuppress`	Undocumented
Method	`getTimeout`	No summary
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.
Method	`_cbDeferTestMethod`	Undocumented
Method	`_classCleanUp`	Undocumented
Method	`_cleanUp`	Undocumented
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	`_ebDeferSetUp`	Undocumented
Method	`_ebDeferTearDown`	Undocumented
Method	`_ebDeferTestMethod`	Undocumented
Method	`_makeReactorMethod`	Create a method which wraps the reactor method `name`. The new method issues a deprecation warning and calls the original.
Method	`_run`	Undocumented
Method	`_runFixturesAndTest`	Really run `setUp`, the test method, and `tearDown`. Any of these may return `defer.Deferred`s. After they complete, do some reactor cleanup.
Method	`_undeprecateReactor`	Restore the deprecated reactor methods. Undoes what `_deprecateReactor` did.
Method	`_wait`	Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable	`_passed`	Undocumented
Instance Variable	`_reactorMethods`	Undocumented
Instance Variable	`_timedOut`	Undocumented

def __call__(self, *args, **kwargs): (source)

from twisted.trial.itrial.ITestCase

Run the test. Should always do exactly the same thing as run().

def __init__(self, methodName='runTest'): (source)

Construct an asynchronous test case for methodName.

Parameters
methodName	The name of a method on `self`. This method should be a unit test. That is, it should be a short method that calls some of the assert* methods. If `methodName` is unspecified, `SynchronousTestCase.runTest` will be used as the test method. This is mostly useful for testing Trial.

def addCleanup(self, f, *args, **kwargs): (source)

Extend the base cleanup feature with support for cleanup functions which return Deferreds.

If the function f returns a Deferred, TestCase will wait until the Deferred has fired before proceeding to the next function.

def assertFailure(self, deferred, *expectedFailures): (source)

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.

@defer.inlineCallbacks
def deferRunCleanups(self, ignored, result): (source)

Run any scheduled cleanups and report errors (if any) to the result. object.

def deferSetUp(self, ignored, result): (source)

Undocumented

def deferTearDown(self, ignored, result): (source)

Undocumented

def deferTestMethod(self, ignored, result): (source)

Undocumented

def getSuppress(self): (source)

Undocumented

def getTimeout(self): (source)

Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION if it cannot find anything. See TestCase docstring for more details.

timeout = (source)

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.

def _cbDeferTestMethod(self, ignored, result): (source)

Undocumented

def _classCleanUp(self, result): (source)

Undocumented

def _cleanUp(self, result): (source)

Undocumented

def _deprecateReactor(self, reactor): (source)

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.

Parameters
reactor	The Twisted reactor.

def _ebDeferSetUp(self, failure, result): (source)

Undocumented

def _ebDeferTearDown(self, failure, result): (source)

Undocumented

def _ebDeferTestMethod(self, f, result): (source)

Undocumented

def _makeReactorMethod(self, name): (source)

Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.

def _run(self, methodName, result): (source)

Undocumented

def _runFixturesAndTest(self, result): (source)

Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.

Parameters
result	A `TestResult` object.

def _undeprecateReactor(self, reactor): (source)

Restore the deprecated reactor methods. Undoes what _deprecateReactor did.

Parameters
reactor	The Twisted reactor.

def _wait(self, d, running=_wait_is_running): (source)

Take a Deferred that only ever callbacks. Block until it happens.

_passed: bool = (source)

Undocumented

_reactorMethods: dict = (source)

Undocumented

_timedOut: bool = (source)

Undocumented