twisted.test.test_defer.DeferredAddTimeoutTests(unittest.SynchronousTestCase) class documentation

Part of twisted.test.test_defer (View In Hierarchy)

Tests for the function Deferred.addTimeout

Method test_timeoutChainable defer.Deferred.addTimeout returns its own defer.Deferred so it can be called in a callback chain.
Method test_successResultBeforeTimeout The defer.Deferred callbacks with the result if it succeeds before the timeout. No cancellation happens after the callback either, which could also cancel inner deferreds.
Method test_successResultBeforeTimeoutCustom No summary
Method test_failureBeforeTimeout The defer.Deferred errbacks with the failure if it fails before the timeout. No cancellation happens after the errback either, which could also cancel inner deferreds.
Method test_failureBeforeTimeoutCustom No summary
Method test_timedOut The defer.Deferred by default errbacks with a defer.TimeoutError if it times out before callbacking or errbacking.
Method test_timedOutCustom No summary
Method test_timedOutProvidedCancelSuccess If a cancellation function is provided when the defer.Deferred is initialized, the defer.Deferred returns the cancellation value's non-failure return value when the defer.Deferred times out.
Method test_timedOutProvidedCancelFailure If a cancellation function is provided when the defer.Deferred is initialized, the defer.Deferred returns the cancellation value's non-CanceledError failure when the defer.Deferred times out.
Method test_cancelBeforeTimeout No summary
Method test_cancelBeforeTimeoutCustom No summary
Method test_providedCancelCalledBeforeTimeoutCustom A custom translation function can handle a defer.Deferred with a custom cancellation function.
Method test_errbackAddedBeforeTimeout No summary
Method test_errbackAddedBeforeTimeoutSuppressesCancellation No summary
Method test_errbackAddedBeforeTimeoutCustom No summary
Method test_errbackAddedBeforeTimeoutSuppressesCancellationCustom No summary
Method test_callbackAddedToCancelerBeforeTimeout No summary
Method test_callbackAddedToCancelerBeforeTimeoutCustom 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.
def test_timeoutChainable(self):

defer.Deferred.addTimeout returns its own defer.Deferred so it can be called in a callback chain.

def test_successResultBeforeTimeout(self):

The defer.Deferred callbacks with the result if it succeeds before the timeout. No cancellation happens after the callback either, which could also cancel inner deferreds.

def test_successResultBeforeTimeoutCustom(self):

The defer.Deferred callbacks with the result if it succeeds before the timeout, even if a custom onTimeoutCancel function is provided. No cancellation happens after the callback either, which could also cancel inner deferreds.

def test_failureBeforeTimeout(self):

The defer.Deferred errbacks with the failure if it fails before the timeout. No cancellation happens after the errback either, which could also cancel inner deferreds.

def test_failureBeforeTimeoutCustom(self):

The defer.Deferred errbacks with the failure if it fails before the timeout, even if using a custom onTimeoutCancel function. No cancellation happens after the errback either, which could also cancel inner deferreds.

def test_timedOut(self):

The defer.Deferred by default errbacks with a defer.TimeoutError if it times out before callbacking or errbacking.

def test_timedOutCustom(self): 
If a custom C{onTimeoutCancel] function is provided, the
L{defer.Deferred} returns the custom function's return value if the
L{defer.Deferred} times out before callbacking or errbacking.
The custom C{onTimeoutCancel} function can return a result instead of
a failure.
def test_timedOutProvidedCancelSuccess(self):

If a cancellation function is provided when the defer.Deferred is initialized, the defer.Deferred returns the cancellation value's non-failure return value when the defer.Deferred times out.

def test_timedOutProvidedCancelFailure(self):

If a cancellation function is provided when the defer.Deferred is initialized, the defer.Deferred returns the cancellation value's non-CanceledError failure when the defer.Deferred times out.

def test_cancelBeforeTimeout(self):

If the defer.Deferred is manually cancelled before the timeout, it is not re-cancelled (no AlreadyCancelled error, and also no canceling of inner deferreds), and the default onTimeoutCancel function is not called, preserving the original CancelledError.

def test_cancelBeforeTimeoutCustom(self):

If the defer.Deferred is manually cancelled before the timeout, it is not re-cancelled (no AlreadyCancelled error, and also no canceling of inner deferreds), and the custom onTimeoutCancel function is not called, preserving the original CancelledError.

def test_providedCancelCalledBeforeTimeoutCustom(self):

A custom translation function can handle a defer.Deferred with a custom cancellation function.

def test_errbackAddedBeforeTimeout(self):

An errback added before a timeout is added errbacks with a defer.CancelledError when the timeout fires. If the errback returns the defer.CancelledError, it is translated to a defer.TimeoutError by the timeout implementation.

def test_errbackAddedBeforeTimeoutSuppressesCancellation(self):

An errback added before a timeout is added errbacks with a defer.CancelledError when the timeout fires. If the errback suppresses the defer.CancelledError, the deferred successfully completes.

def test_errbackAddedBeforeTimeoutCustom(self):

An errback added before a timeout is added with a custom timeout function errbacks with a defer.CancelledError when the timeout fires. The timeout function runs if the errback returns the defer.CancelledError.

def test_errbackAddedBeforeTimeoutSuppressesCancellationCustom(self):

An errback added before a timeout is added with a custom timeout function errbacks with a defer.CancelledError when the timeout fires. The timeout function runs if the errback suppresses the defer.CancelledError.

def test_callbackAddedToCancelerBeforeTimeout(self):

Given a deferred with a cancellation function that resumes the callback chain, a callback that is added to the deferred before a timeout is added to runs when the timeout fires. The deferred completes successfully, without a defer.TimeoutError.

def test_callbackAddedToCancelerBeforeTimeoutCustom(self):

Given a deferred with a cancellation function that resumes the callback chain, a callback that is added to the deferred before a timeout is added to runs when the timeout fires. The deferred completes successfully, without a defer.TimeoutError. The timeout's custom timeout function also runs.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.