twisted.test.test_defer.DeferredAddTimeoutTests

class documentation

class DeferredAddTimeoutTests(unittest.SynchronousTestCase): (source)

View In Hierarchy

Tests for the function Deferred.addTimeout

Method test_callbackAddedToCancelerBeforeTimeout 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 ...
Method test_callbackAddedToCancelerBeforeTimeoutCustom 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 ...
Method test_cancelBeforeTimeout If the 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 ...
Method test_cancelBeforeTimeoutCustom If the 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 ...
Method test_errbackAddedBeforeTimeout 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.
Method test_errbackAddedBeforeTimeoutCustom 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...
Method test_errbackAddedBeforeTimeoutSuppressesCancellation 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.
Method test_errbackAddedBeforeTimeoutSuppressesCancellationCustom 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...
Method test_failureBeforeTimeout The 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 The 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.
Method test_providedCancelCalledBeforeTimeoutCustom A custom translation function can handle a Deferred with a custom cancellation function.
Method test_successResultBeforeTimeout The 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 The 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.
Method test_timedOut The Deferred by default errbacks with a defer.TimeoutError if it times out before callbacking or errbacking.
Method test_timedOutCustom No summary
Method test_timedOutProvidedCancelFailure If a cancellation function is provided when the Deferred is initialized, the Deferred returns the cancellation value's non-CanceledError failure when the Deferred times out.
Method test_timedOutProvidedCancelSuccess If a cancellation function is provided when the Deferred is initialized, the Deferred returns the cancellation value's non-failure return value when the Deferred times out.
Method test_timeoutChainable Deferred.addTimeout returns its own Deferred so it can be called in a callback chain.

Inherited from SynchronousTestCase:

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
Method __init__ Undocumented
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 flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
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 shortDescription Undocumented
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 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 _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _passed Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via SynchronousTestCase):

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 assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
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 assertNoResult Assert that deferred does not have a result at this point.
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 assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
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 assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
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 fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def test_callbackAddedToCancelerBeforeTimeout(self): (source)

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): (source)

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.

def test_cancelBeforeTimeout(self): (source)

If the 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): (source)

If the 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_errbackAddedBeforeTimeout(self): (source)

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_errbackAddedBeforeTimeoutCustom(self): (source)

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_errbackAddedBeforeTimeoutSuppressesCancellation(self): (source)

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_errbackAddedBeforeTimeoutSuppressesCancellationCustom(self): (source)

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_failureBeforeTimeout(self): (source)

The 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): (source)

The 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_providedCancelCalledBeforeTimeoutCustom(self): (source)

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

def test_successResultBeforeTimeout(self): (source)

The 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): (source)

The 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_timedOut(self): (source)

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

def test_timedOutCustom(self): (source)
def test_timedOutProvidedCancelFailure(self): (source)

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

def test_timedOutProvidedCancelSuccess(self): (source)

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

def test_timeoutChainable(self): (source)

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