twisted.test.test_cooperator.RunStateTests

Tests to verify the behavior of CooperativeTask.pause, CooperativeTask.resume, CooperativeTask.stop, exhausting the underlying iterator, and their interactions with each other.

Method	setUp	Create a cooperator with a fake scheduler and a termination predicate that ensures only one unit of work will take place per tick.
Method	worker	This is a sample generator which yields Deferreds when we are testing deferral and an ascending integer count otherwise.
Method	tearDown	Drop references to interesting parts of the fixture to allow Deferred errors to be noticed when things start failing.
Method	deferNext	Defer the next result from my worker iterator.
Method	stopNext	Make the next result from my worker iterator be completion (raising StopIteration).
Method	dieNext	Make the next result from my worker iterator be raising an `UnhandledException`.
Method	test_pauseResume	Cooperators should stop running their tasks when they're paused, and start again when they're resumed.
Method	test_resumeNotPaused	`CooperativeTask.resume` should raise a `TaskNotPaused` exception if it was not paused; e.g. if `CooperativeTask.pause` was not invoked more times than `CooperativeTask.resume` on that object.
Method	test_pauseTwice	Pauses on tasks should behave like a stack. If a task is paused twice, it needs to be resumed twice.
Method	test_pauseWhileDeferred	No summary
Method	test_whenDone	No summary
Method	test_whenDoneError	`CooperativeTask.whenDone` returns a `defer.Deferred` that will fail when the iterable's `next` method raises an exception, with that exception.
Method	test_whenDoneStop	`CooperativeTask.whenDone` returns a `defer.Deferred` that fails with `TaskStopped` when the `stop` method is called on that `CooperativeTask`.
Method	test_whenDoneAlreadyDone	`CooperativeTask.whenDone` will return a `defer.Deferred` that will succeed immediately if its iterator has already completed.
Method	test_stopStops	`stop()`ping a task should cause it to be removed from the run just as `pause()`ing, with the distinction that `resume()` will raise a `TaskStopped` exception.
Method	test_pauseStopResume	`resume()`ing a paused, stopped task should be a no-op; it should not raise an exception, because it's paused, but neither should it actually do more work from the task.
Method	test_stopDeferred	No summary
Method	test_stopExhausted	`stop()`ping a `CooperativeTask` whose iterator has been exhausted should raise `TaskDone`.
Method	test_stopErrored	`stop()`ping a `CooperativeTask` whose iterator has encountered an error should raise `TaskFailed`.
Method	test_stopCooperatorReentrancy	No summary

Inherited from TestCase:

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 SynchronousTestCase (via TestCase):

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	__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	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	_installObserver	Undocumented
Method	_removeObserver	Undocumented

Inherited from _Assertions (via TestCase, 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 setUp(self):

Create a cooperator with a fake scheduler and a termination predicate that ensures only one unit of work will take place per tick.

def worker(self):

This is a sample generator which yields Deferreds when we are testing deferral and an ascending integer count otherwise.

def tearDown(self):

Drop references to interesting parts of the fixture to allow Deferred errors to be noticed when things start failing.

def deferNext(self):

Defer the next result from my worker iterator.

def stopNext(self):

Make the next result from my worker iterator be completion (raising StopIteration).

def dieNext(self):

Make the next result from my worker iterator be raising an UnhandledException.

def test_pauseResume(self):

Cooperators should stop running their tasks when they're paused, and start again when they're resumed.

def test_resumeNotPaused(self):

CooperativeTask.resume should raise a TaskNotPaused exception if it was not paused; e.g. if CooperativeTask.pause was not invoked more times than CooperativeTask.resume on that object.

def test_pauseTwice(self):

Pauses on tasks should behave like a stack. If a task is paused twice, it needs to be resumed twice.

def test_pauseWhileDeferred(self):

pause()ing a task while it is waiting on an outstanding defer.Deferred should put the task into a state where the outstanding defer.Deferred must be called back and the task is resumed before it will continue processing.

def test_whenDone(self):

CooperativeTask.whenDone returns a Deferred which fires when the Cooperator's iterator is exhausted. It returns a new Deferred each time it is called; callbacks added to other invocations will not modify the value that subsequent invocations will fire with.

def test_whenDoneError(self):

CooperativeTask.whenDone returns a defer.Deferred that will fail when the iterable's next method raises an exception, with that exception.

def test_whenDoneStop(self):

CooperativeTask.whenDone returns a defer.Deferred that fails with TaskStopped when the stop method is called on that CooperativeTask.

def test_whenDoneAlreadyDone(self):

CooperativeTask.whenDone will return a defer.Deferred that will succeed immediately if its iterator has already completed.

def test_stopStops(self):

stop()ping a task should cause it to be removed from the run just as pause()ing, with the distinction that resume() will raise a TaskStopped exception.

def test_pauseStopResume(self):

resume()ing a paused, stopped task should be a no-op; it should not raise an exception, because it's paused, but neither should it actually do more work from the task.

def test_stopDeferred(self):

As a corrolary of the interaction of pause() and unpause(), stop()ping a task which is waiting on a Deferred should cause the task to gracefully shut down, meaning that it should not be unpaused when the deferred fires.

def test_stopExhausted(self):

stop()ping a CooperativeTask whose iterator has been exhausted should raise TaskDone.

def test_stopErrored(self):

stop()ping a CooperativeTask whose iterator has encountered an error should raise TaskFailed.

def test_stopCooperatorReentrancy(self):

If a callback of a Deferred from CooperativeTask.whenDone calls Cooperator.stop on its CooperativeTask._cooperator, the Cooperator will stop, but the CooperativeTask whose callback is calling stop should already be considered 'stopped' by the time the callback is running, and therefore removed from the CoooperativeTask.

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

twisted.test.test_cooperator.RunStateTests(unittest.TestCase) class documentation

`twisted.test.test_cooperator.RunStateTests(unittest.TestCase)` class documentation