twisted.test.test_defer.RaceTests

class documentation

class RaceTests(unittest.SynchronousTestCase):

Constructor: RaceTests(methodName)

View In Hierarchy

Tests for race.

Method test_cancel If the result of race is cancelled then all of the Deferreds passed in are cancelled.
Method test_failure When all of the Deferreds passed to race fire with failures, the Deferred return by race fires with FailureGroup wrapping all of their failures.
Method test_resultAfterCancel If one of the Deferreds fires after it was cancelled its result goes nowhere. In particular, it does not cause any errors to be logged.
Method test_resultFromCancel If one of the input Deferreds has a cancel function that fires it with success, nothing bad happens.
Method test_success When one of the Deferreds passed to race fires successfully, the Deferred return by race fires with the index of that Deferred and its result and cancels the rest of the Deferreds.

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.
@given(numDeferreds=integers(min_value=1, max_value=3))
def test_cancel(self, numDeferreds: int):

If the result of race is cancelled then all of the Deferreds passed in are cancelled.

@given(beforeWinner=integers(min_value=0, max_value=3), afterWinner=integers(min_value=0, max_value=3))
def test_failure(self, beforeWinner: int, afterWinner: int):

When all of the Deferreds passed to race fire with failures, the Deferred return by race fires with FailureGroup wrapping all of their failures.

Parameters
beforeWinner:intA randomly selected number of Deferreds to appear after the "winning" Deferred in the list passed in.
afterWinner:intUndocumented
@given(beforeWinner=integers(min_value=0, max_value=3), afterWinner=integers(min_value=0, max_value=3))
def test_resultAfterCancel(self, beforeWinner: int, afterWinner: int):

If one of the Deferreds fires after it was cancelled its result goes nowhere. In particular, it does not cause any errors to be logged.

def test_resultFromCancel(self):

If one of the input Deferreds has a cancel function that fires it with success, nothing bad happens.

@given(beforeWinner=integers(min_value=0, max_value=3), afterWinner=integers(min_value=0, max_value=3))
def test_success(self, beforeWinner: int, afterWinner: int):

When one of the Deferreds passed to race fires successfully, the Deferred return by race fires with the index of that Deferred and its result and cancels the rest of the Deferreds.

Parameters
beforeWinner:intA randomly selected number of Deferreds to appear after the "winning" Deferred in the list passed in.
afterWinner:intUndocumented