class documentation

Test the non-wallclock based clock implementation.

Method test_callLaterKeepsCallsOrdered The order of calls scheduled by task.Clock.callLater is honored when adding a new call via calling task.Clock.callLater again.
Method test_callLaterOrdering Test that the DelayedCall returned is not one previously created.
Method test_callLaterResetInsideCallKeepsCallsOrdered The order of calls scheduled by task.Clock.callLater is honored when re-scheduling an existing call via IDelayedCall.reset on the result of a previous call to callLater, even when that call to reset occurs within the callable scheduled by ...
Method test_callLaterResetKeepsCallsOrdered The order of calls scheduled by task.Clock.callLater is honored when re-scheduling an existing call via IDelayedCall.reset on the result of a previous call to callLater.
Method test_getDelayedCalls Test that we can get a list of all delayed calls
Method test_getDelayedCallsEmpty Test that we get an empty list from getDelayedCalls on a newly constructed Clock.
Method test_providesIReactorTime Undocumented
Method testAdvance Test that advancing the clock will fire some calls.
Method testAdvanceCancel Test attempting to cancel the call in a callback.
Method testCallLater Test that calls can be scheduled for later with the fake clock and hands back an IDelayedCall.
Method testCallLaterCancelled Test that calls can be cancelled.
Method testCallLaterDelayed Test that calls can be delayed.
Method testCallLaterResetLater Test that calls can have their time reset to a later time.
Method testCallLaterResetSooner Test that calls can have their time reset to an earlier time.
Method testSeconds Test that the seconds method of the fake clock returns fake time.

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

The order of calls scheduled by task.Clock.callLater is honored when adding a new call via calling task.Clock.callLater again.

For example, if task.Clock.callLater is invoked with a callable "A" and a time t0, and then the IDelayedCall which results from that is reset to a later time t2 which is greater than t0, and then task.Clock.callLater is invoked again with a callable "B", and time t1 which is less than t2 but greater than t0, "B" will be invoked before "A".

def test_callLaterOrdering(self): (source)

Test that the DelayedCall returned is not one previously created.

def test_callLaterResetInsideCallKeepsCallsOrdered(self): (source)

The order of calls scheduled by task.Clock.callLater is honored when re-scheduling an existing call via IDelayedCall.reset on the result of a previous call to callLater, even when that call to reset occurs within the callable scheduled by callLater itself.

def test_callLaterResetKeepsCallsOrdered(self): (source)

The order of calls scheduled by task.Clock.callLater is honored when re-scheduling an existing call via IDelayedCall.reset on the result of a previous call to callLater.

For example, if task.Clock.callLater is invoked with a callable "A" and a time t0, and then task.Clock.callLater is invoked again with a callable "B", and time t1 greater than t0, and finally the IDelayedCall for "A" is reset to a later time, t2, which is greater than t1, "B" will be invoked before "A".

def test_getDelayedCalls(self): (source)

Test that we can get a list of all delayed calls

def test_getDelayedCallsEmpty(self): (source)

Test that we get an empty list from getDelayedCalls on a newly constructed Clock.

def test_providesIReactorTime(self): (source)

Undocumented

def testAdvance(self): (source)

Test that advancing the clock will fire some calls.

def testAdvanceCancel(self): (source)

Test attempting to cancel the call in a callback.

AlreadyCalled should be raised, not for example a ValueError from removing the call from Clock.calls. This requires call.called to be set before the callback is called.

def testCallLater(self): (source)

Test that calls can be scheduled for later with the fake clock and hands back an IDelayedCall.

def testCallLaterCancelled(self): (source)

Test that calls can be cancelled.

def testCallLaterDelayed(self): (source)

Test that calls can be delayed.

def testCallLaterResetLater(self): (source)

Test that calls can have their time reset to a later time.

def testCallLaterResetSooner(self): (source)

Test that calls can have their time reset to an earlier time.

def testSeconds(self): (source)

Test that the seconds method of the fake clock returns fake time.