twisted.trial.unittest.TestCase : API documentation

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.

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	__init__	Construct an asynchronous test case for `methodName`.
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	__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	addCleanup	Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method	getSuppress	Undocumented
Method	getTimeout	No summary
Method	_run	Run a single method, either a test method or fixture.
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	_runCleanups	Run the cleanups added with `addCleanup` in order.
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	_wait	Take a Deferred that only ever callbacks. Block until it happens.

Inherited from _Assertions (via SynchronousTestCase):

Method	fail	Absolutely fail the test. Do not pass go, do not collect $200.
Method	assertFalse	Fail the test if `condition` evaluates to True.
Method	assertTrue	Fail the test if `condition` evaluates to False.
Method	assertRaises	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	assertIs	Fail the test if `first` is not `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertIsNot	Fail the test if `first` is `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertNotEqual	Fail the test if `first` == `second`.
Method	assertIn	Fail the test if `containee` is not found in `container`.
Method	assertNotIn	Fail the test if `containee` is found in `container`.
Method	assertNotAlmostEqual	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	assertAlmostEqual	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	assertApproximates	Fail if `first` - `second` > `tolerance`
Method	assertSubstring	Fail if `substring` does not exist within `astring`.
Method	assertNotSubstring	Fail if `astring` contains `substring`.
Method	assertWarns	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	assertIsInstance	Fail if `instance` is not an instance of the given class or of one of the given classes.
Method	assertNotIsInstance	Fail if `instance` is an instance of the given class or of one of the given classes.
Method	successResultOf	Return the current success result of `deferred` or raise `self.failureException`.
Method	failureResultOf	Return the current failure result of `deferred` or raise `self.failureException`.
Method	assertNoResult	Assert that `deferred` does not have a result at this point.
Method	assertRegex	Fail the test if a `regexp` search of `text` fails.

Inherited from _Assertions (via SynchronousTestCase):

Method	fail	Absolutely fail the test. Do not pass go, do not collect $200.
Method	assertFalse	Fail the test if `condition` evaluates to True.
Method	assertTrue	Fail the test if `condition` evaluates to False.
Method	assertRaises	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	assertIs	Fail the test if `first` is not `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertIsNot	Fail the test if `first` is `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertNotEqual	Fail the test if `first` == `second`.
Method	assertIn	Fail the test if `containee` is not found in `container`.
Method	assertNotIn	Fail the test if `containee` is found in `container`.
Method	assertNotAlmostEqual	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	assertAlmostEqual	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	assertApproximates	Fail if `first` - `second` > `tolerance`
Method	assertSubstring	Fail if `substring` does not exist within `astring`.
Method	assertNotSubstring	Fail if `astring` contains `substring`.
Method	assertWarns	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	assertIsInstance	Fail if `instance` is not an instance of the given class or of one of the given classes.
Method	assertNotIsInstance	Fail if `instance` is an instance of the given class or of one of the given classes.
Method	successResultOf	Return the current success result of `deferred` or raise `self.failureException`.
Method	failureResultOf	Return the current failure result of `deferred` or raise `self.failureException`.
Method	assertNoResult	Assert that `deferred` does not have a result at this point.
Method	assertRegex	Fail the test if a `regexp` search of `text` fails.

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.

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

overrides twisted.trial.unittest.SynchronousTestCase.__init__

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

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

overrides twisted.trial.unittest.SynchronousTestCase._run

Run a single method, either a test method or fixture.

Parameters	suppress	Any warnings to suppress, as defined by the `suppress` attribute on this method, test case, or the module it is defined in.
	todo	Any expected failure or failures, as defined by the `todo` attribute on this method, test case, or the module it is defined in.
	method	The method to run.
	result	The TestResult instance to which to report results.
Returns	`True` if the method fails and no further method/fixture calls should be made, `False` otherwise.

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

from twisted.trial.itrial.ITestCase

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

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

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

def _cbDeferRunCleanups(self, cleanupResults, result): (source)

Undocumented

def _cleanUp(self, result): (source)

Undocumented

def _classCleanUp(self, 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 _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 _undeprecateReactor(self, reactor): (source)

Restore the deprecated reactor methods. Undoes what _deprecateReactor did.

Parameters reactor The Twisted reactor.

def _runCleanups(self): (source)

overrides twisted.trial.unittest.SynchronousTestCase._runCleanups

Run the cleanups added with addCleanup in order.

Returns A Deferred that fires when all cleanups are run.

def _runFixturesAndTest(self, result): (source)

overrides twisted.trial.unittest.SynchronousTestCase._runFixturesAndTest

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 addCleanup(self, f, *args, **kwargs): (source)

overrides twisted.trial.unittest.SynchronousTestCase.addCleanup

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

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

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

API Documentation for Twisted, generated by pydoctor at 2017-06-11 10:59:01.

twisted.trial.unittest.TestCase(SynchronousTestCase) class documentation

`twisted.trial.unittest.TestCase(SynchronousTestCase)` class documentation