twisted._threads.test.test_team.TeamTests(SynchronousTestCase) class documentation

Part of twisted._threads.test.test_team (View In Hierarchy)

Tests for Team

Method setUp Set up a Team with inspectable, synchronous workers that can be single-stepped.
Method coordinate Perform all work currently scheduled in the coordinator.
Method performAllOutstandingWork Perform all work on the coordinator and worker performers that needs to be done.
Method test_doDoesWorkInWorker Team.do does the work in a worker created by the createWorker callable.
Method test_initialStatistics Team.statistics returns an object with idleWorkerCount, busyWorkerCount, and backloggedWorkCount integer attributes.
Method test_growCreatesIdleWorkers Team.grow increases the number of available idle workers.
Method test_growCreateLimit Team.grow increases the number of available idle workers until the createWorker callable starts returning None.
Method test_shrinkQuitsWorkers Team.shrink will quit the given number of workers.
Method test_shrinkToZero Team.shrink with no arguments will stop all outstanding workers.
Method test_moreWorkWhenNoWorkersAvailable When no additional workers are available, the given work is backlogged, and then performed later when the work was.
Method test_exceptionInTask When an exception is raised in a task passed to Team.do, the logException given to the Team at construction is invoked in the exception context.
Method test_quit Team.quit causes future invocations of Team.do and Team.quit to raise AlreadyQuit.
Method test_quitQuits Team.quit causes all idle workers, as well as the coordinator worker, to quit.
Method test_quitQuitsLaterWhenBusy Team.quit causes all busy workers to be quit once they've finished the work they've been given.
Method test_quitConcurrentWithWorkHappening If work happens after Team.quit sets its Quit flag, but before any other work takes place, the Team should still exit gracefully.
Method test_shrinkWhenBusy Team.shrink will wait for busy workers to finish being busy and then quit them.

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

Set up a Team with inspectable, synchronous workers that can be single-stepped.

def coordinate(self):

Perform all work currently scheduled in the coordinator.

Returnswhether any coordination work was performed; if the coordinator was idle when this was called, return False (otherwise True). (type: bool)
def performAllOutstandingWork(self):

Perform all work on the coordinator and worker performers that needs to be done.

def test_doDoesWorkInWorker(self):

Team.do does the work in a worker created by the createWorker callable.

def test_initialStatistics(self):

Team.statistics returns an object with idleWorkerCount, busyWorkerCount, and backloggedWorkCount integer attributes.

def test_growCreatesIdleWorkers(self):

Team.grow increases the number of available idle workers.

def test_growCreateLimit(self):

Team.grow increases the number of available idle workers until the createWorker callable starts returning None.

def test_shrinkQuitsWorkers(self):

Team.shrink will quit the given number of workers.

def test_shrinkToZero(self):

Team.shrink with no arguments will stop all outstanding workers.

def test_moreWorkWhenNoWorkersAvailable(self):

When no additional workers are available, the given work is backlogged, and then performed later when the work was.

def test_exceptionInTask(self):

When an exception is raised in a task passed to Team.do, the logException given to the Team at construction is invoked in the exception context.

def test_quit(self):

Team.quit causes future invocations of Team.do and Team.quit to raise AlreadyQuit.

def test_quitQuits(self):

Team.quit causes all idle workers, as well as the coordinator worker, to quit.

def test_quitQuitsLaterWhenBusy(self):

Team.quit causes all busy workers to be quit once they've finished the work they've been given.

def test_quitConcurrentWithWorkHappening(self):

If work happens after Team.quit sets its Quit flag, but before any other work takes place, the Team should still exit gracefully.

def test_shrinkWhenBusy(self):

Team.shrink will wait for busy workers to finish being busy and then quit them.

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