twisted.test.test_task.LoopTests(unittest.TestCase) class documentation

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

Tests for task.LoopingCall based on a fake IReactorTime implementation.

Method test_defaultClock LoopingCall's default clock should be the reactor.
Method test_callbackTimeSkips When more time than the defined interval passes during the execution of a callback, LoopingCall should schedule the next call for the next interval which is still in the future.
Method test_reactorTimeSkips No summary
Method test_reactorTimeCountSkips No summary
Method test_countLengthyIntervalCounts No summary
Method test_withCountFloatingPointBoundary No summary
Method test_withCountIntervalZero task.LoopingCall.withCount with interval set to 0 will call the countCallable 1.
Method test_withCountIntervalZeroDelay task.LoopingCall.withCount with interval set to 0 and a delayed call during the loop run will still call the countCallable 1 as if no delay occurred.
Method test_withCountIntervalZeroDelayThenNonZeroInterval task.LoopingCall.withCount with interval set to 0 will still keep the time when last called so when the interval is reset.
Method testBasicFunction Undocumented
Method testDelayedStart Undocumented
Method testBadDelay Undocumented
Method testStopAtOnce Undocumented
Method testStoppingBeforeDelayedStart Undocumented
Method test_reset Test that LoopingCall can be reset.
Method test_reprFunction LoopingCall.__repr__ includes the wrapped function's name.
Method test_reprMethod LoopingCall.__repr__ includes the wrapped method's full name.
Method test_deferredDeprecation LoopingCall.deferred is deprecated.
Method _stoppingTest Undocumented

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.Deferreds. 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 test_defaultClock(self):

LoopingCall's default clock should be the reactor.

def test_callbackTimeSkips(self):

When more time than the defined interval passes during the execution of a callback, LoopingCall should schedule the next call for the next interval which is still in the future.

def test_reactorTimeSkips(self):

When more time than the defined interval passes between when LoopingCall schedules itself to run again and when it actually runs again, it should schedule the next call for the next interval which is still in the future.

def test_reactorTimeCountSkips(self):

When LoopingCall schedules itself to run again, if more than the specified interval has passed, it should schedule the next call for the next interval which is still in the future. If it was created using LoopingCall.withCount, a positional argument will be inserted at the beginning of the argument list, indicating the number of calls that should have been made.

def test_countLengthyIntervalCounts(self):

LoopingCall.withCount counts only calls that were expected to be made. So, if more than one, but less than two intervals pass between invocations, it won't increase the count above 1. For example, a LoopingCall with interval T expects to be invoked at T, 2T, 3T, etc. However, the reactor takes some time to get around to calling it, so in practice it will be called at T+something, 2T+something, 3T+something; and due to other things going on in the reactor, "something" is variable. It won't increase the count unless "something" is greater than T. So if the LoopingCall is invoked at T, 2.75T, and 3T, the count has not increased, even though the distance between invocation 1 and invocation 2 is 1.75T.

def test_withCountFloatingPointBoundary(self):

task.LoopingCall.withCount should never invoke its callable with a zero. Specifically, if a task.LoopingCall created with withCount has its start method invoked with a floating-point number which introduces decimal inaccuracy when multiplied or divided, such as "0.1", task.LoopingCall will never invoke its callable with 0. Also, the sum of all the values passed to its callable as the "count" will be an integer, the number of intervals that have elapsed.

This is a regression test for a particularly tricky case to implement.

def test_withCountIntervalZero(self):

task.LoopingCall.withCount with interval set to 0 will call the countCallable 1.

def test_withCountIntervalZeroDelay(self):

task.LoopingCall.withCount with interval set to 0 and a delayed call during the loop run will still call the countCallable 1 as if no delay occurred.

def test_withCountIntervalZeroDelayThenNonZeroInterval(self):

task.LoopingCall.withCount with interval set to 0 will still keep the time when last called so when the interval is reset.

def testBasicFunction(self):
Undocumented
def testDelayedStart(self):
Undocumented
def testBadDelay(self):
Undocumented
def _stoppingTest(self, delay):
Undocumented
def testStopAtOnce(self):
Undocumented
def testStoppingBeforeDelayedStart(self):
Undocumented
def test_reset(self):

Test that LoopingCall can be reset.

def test_reprFunction(self):

LoopingCall.__repr__ includes the wrapped function's name.

def test_reprMethod(self):

LoopingCall.__repr__ includes the wrapped method's full name.

def test_deferredDeprecation(self):

LoopingCall.deferred is deprecated.

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