twisted.test.test_task.LoopTests

class documentation

class LoopTests(unittest.TestCase): (source)

View In Hierarchy

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

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_countLengthyIntervalCounts 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 ...
Method test_defaultClock LoopingCall's default clock should be the reactor.
Method test_deferredDeprecation LoopingCall.deferred is deprecated.
Method test_reactorTimeCountSkips 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 ...
Method test_reactorTimeSkips 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.
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_reset Test that LoopingCall can be reset.
Method test_withCountFloatingPointBoundary 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...
Method test_withCountIntervalZero task.LoopingCall.withCount with interval set to 0 calls the countCallable with a count of 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 testBadDelay Undocumented
Method testBasicFunction Undocumented
Method testDelayedStart Undocumented
Method testStopAtOnce Undocumented
Method testStoppingBeforeDelayedStart Undocumented
Method _stoppingTest Undocumented

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
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 deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
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 _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
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 _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
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 _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

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 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 _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

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

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

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

LoopingCall's default clock should be the reactor.

def test_deferredDeprecation(self): (source)

LoopingCall.deferred is deprecated.

def test_reactorTimeCountSkips(self): (source)

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

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

LoopingCall.__repr__ includes the wrapped function's name.

def test_reprMethod(self): (source)

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

def test_reset(self): (source)

Test that LoopingCall can be reset.

def test_withCountFloatingPointBoundary(self): (source)

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

task.LoopingCall.withCount with interval set to 0 calls the countCallable with a count of 1.

def test_withCountIntervalZeroDelay(self): (source)

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

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

def testBadDelay(self): (source)

Undocumented

def testBasicFunction(self): (source)

Undocumented

def testDelayedStart(self): (source)

Undocumented

def testStopAtOnce(self): (source)

Undocumented

def testStoppingBeforeDelayedStart(self): (source)

Undocumented

def _stoppingTest(self, delay): (source)

Undocumented