fritter.boundaries.ScheduledCall

class documentation

class ScheduledCall(Cancellable, Protocol[WhenTCo, WhatTCo, IDTCo]): (source)

View In Hierarchy

Undocumented

Method cancel Cancel this ScheduledCall, making it so that it will not be invoked in the future. If the work described by when has already been called, or this call has already been cancelled, do nothing.
Property id Return a unique identifier for this scheduled call.
Property state Is this call still waiting to be called, or has it been called or cancelled?
Property what If this has not been called or cancelled, return the original callable that was scheduled.
Property when Return the original time at which the call will be scheduled.
def cancel(self): (source)
overrides fritter.boundaries.Cancellable.cancel

Cancel this ScheduledCall, making it so that it will not be invoked in the future. If the work described by when has already been called, or this call has already been cancelled, do nothing.

@property
id: IDTCo = (source)

Return a unique identifier for this scheduled call.

@property
state: ScheduledState = (source)

Is this call still waiting to be called, or has it been called or cancelled?

@property
what: WhatTCo|None = (source)

If this has not been called or cancelled, return the original callable that was scheduled.

Note
To break cycles, this will only have a non-None value when in ScheduledState.pending.
@property
when: WhenTCo = (source)

Return the original time at which the call will be scheduled.