twisted.internet.task.Clock

class documentation

class Clock: (source)

Known subclasses: twisted.internet.testing.MemoryReactorClock

Implements interfaces: twisted.internet.interfaces.IReactorTime

View In Hierarchy

Provide a deterministic, easily-controlled implementation of IReactorTime.callLater. This is commonly useful for writing deterministic unit tests for code which schedules events using this API.

Class Variable rightNow Undocumented
Method __init__ Undocumented
Instance Variable calls Undocumented
Method seconds Pretend to be time.time(). This is used internally when an operation such as IDelayedCall.reset needs to determine a time value relative to the current time.
Method callLater See twisted.internet.interfaces.IReactorTime.callLater.
Method getDelayedCalls See twisted.internet.interfaces.IReactorTime.getDelayedCalls
Method advance Move time on this clock forward by the given amount and run whatever pending calls should be run.
Method pump Advance incrementally by the given set of times.
Method _sortCalls Sort the pending calls according to the time they are scheduled.
rightNow = (source)

Undocumented

(type: float)
def __init__(self): (source)
overridden in twisted.internet.testing.MemoryReactorClock

Undocumented

calls = (source)

Undocumented

(type: List[DelayedCall])
def seconds(self): (source)
from twisted.internet.interfaces.IReactorTime

Pretend to be time.time(). This is used internally when an operation such as IDelayedCall.reset needs to determine a time value relative to the current time.

ReturnsThe time which should be considered the current time. (type: float)
def _sortCalls(self): (source)

Sort the pending calls according to the time they are scheduled.

def callLater(self, delay, callable, *args, **kw): (source)
from twisted.internet.interfaces.IReactorTime

See twisted.internet.interfaces.IReactorTime.callLater.

ParametersdelayUndocumented (type: float)
callableUndocumented (type: Callable[..., object])
argsUndocumented (type: object)
kwUndocumented (type: object)
ReturnsUndocumented (type: IDelayedCall)
def getDelayedCalls(self): (source)
from twisted.internet.interfaces.IReactorTime

See twisted.internet.interfaces.IReactorTime.getDelayedCalls

ReturnsUndocumented (type: Sequence[IDelayedCall])
def advance(self, amount): (source)

Move time on this clock forward by the given amount and run whatever pending calls should be run.

ParametersamountThe number of seconds which to advance this clock's time. (type: float)
def pump(self, timings): (source)

Advance incrementally by the given set of times.

ParameterstimingsUndocumented (type: Iterable[float])
API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.