twisted.internet.test.test_inlinecb.CancellationTests(SynchronousTestCase)
class documentationtwisted.internet.test.test_inlinecb
(View In Hierarchy)
Tests for cancellation of Deferred
s
returned by inlineCallbacks
.
For each of these tests, let:
G
be a generator decorated with
inlineCallbacks
D
be a Deferred
returned by G
C
be a Deferred
awaited by G
with yield
Method | setUp | Set up the list of outstanding Deferred s. |
Method | tearDown | If any Deferred s are
still outstanding, fire them. |
Method | sampleInlineCB | Generator for testing cascade cancelling cases. |
Method | getDeferred | A sample function that returns a Deferred that
can be fired on demand, by CancellationTests.deferredGotten . |
Method | deferredGotten | Fire the Deferred
returned from the least-recent call to CancellationTests.getDeferred . |
Method | test_cascadeCancellingOnCancel | When D cancelled, C will be immediately
cancelled too. |
Method | test_errbackCancelledErrorOnCancel | When D cancelled, CancelledError from C will
be errbacked through D . |
Method | test_errorToErrorTranslation | When D is cancelled, and C raises a particular type of
error, G may catch that error at the point of yielding and
translate it into a different error which may be received by application
code. |
Method | test_errorToSuccessTranslation | When D is cancelled, and C raises a particular
type of error, G may catch that error at the point of yielding
and translate it into a result value which may be received by application
code. |
Method | test_asynchronousCancellation | No summary |
Inherited from SynchronousTestCase:
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 | 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. |
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 . |
Method | __init__ | Undocumented |
Method | __eq__ | No summary |
Method | __ne__ | Undocumented |
Method | __hash__ | Undocumented |
Method | shortDescription | Undocumented |
Method | getSkip | No summary |
Method | getTodo | No summary |
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 | addCleanup | Add the given function to a list of functions to be called after the
test has run, but before tearDown . |
Method | patch | Monkey patch an object for the duration of the test. |
Method | flushLoggedErrors | Remove stored errors received from the log. |
Method | flushWarnings | Remove stored warnings from the list of captured warnings and return them. |
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 | mktemp | Create a new path name which can be used for a new file or directory. |
Method | _getSuppress | No summary |
Method | _getSkipReason | Return the reason to use for skipping a test method. |
Method | _run | Run a single method, either a test method or fixture. |
Method | _runFixturesAndTest | Run setUp , a test method, test cleanups, and
tearDown . |
Method | _runCleanups | Synchronously run any cleanups which have been added. |
Method | _installObserver | Undocumented |
Method | _removeObserver | Undocumented |
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. |
Generator for testing cascade cancelling cases.
Parameters | getChildDeferred | Some callable returning Deferred that
we awaiting (with yield ) |
A sample function that returns a Deferred
that
can be fired on demand, by CancellationTests.deferredGotten
.
Returns | Deferred
that can be fired on demand. |
Fire the Deferred
returned from the least-recent call to CancellationTests.getDeferred
.
Parameters | result | result object to be used when firing the Deferred . |
When D
cancelled, CancelledError from C
will
be errbacked through D
.
When D
is cancelled, and C raises a particular type of
error, G
may catch that error at the point of yielding and
translate it into a different error which may be received by application
code.