fritter.boundaries

module documentation
(source)

fritter.boundaries describes the boundaries between different parts of the system and its interface with your application code. It contains Protocols, TypeVars, and constant values, but no logic of its own.

Class AsyncDriver An AsyncDriver is an interface to a library that supports awaitables (such as the standard library asyncio), to allow fritter.repeat.Async to return an awaitable of a library-appropriate type.
Class Cancellable An object that can be cancelled.
Class CancellableAwaitable An object which can be both awaited and cancelled.
Class PriorityComparable A PriorityComparable is an object that can be compared with another object and evaluated as less than or less-equal to another object for the purposes of a PriorityQueue.
Class PriorityDiffable A PriorityDiffable is a PriorityComparable object that can also be added (and subtracted) with a delta type, or with itself to produce the delta type.
Class PriorityQueue High-level specification of a priority queue.
Class RecurrenceRule A RecurrenceRule is a callable that takes a reference time and a current time, and computes series of steps between the current recurrence and a new reference time for the next call.
Class RepeatingWork RepeatingWork is work that can be performed repeatedly in a loop.
Class Scale A Scale defines a translation between a branch (i.e., "child") time scale, and a trunk (i.e., "parent") time scale.
Class ScheduledCall No class docstring; 4/4 properties, 1/1 method documented
Class ScheduledState No class docstring; 3/3 class variables documented
Class Scheduler A Scheduler is an object that allows for scheduling of timed calls.
Class TimeDriver Driver interface that allows Fritter to schedule objects onto a third party library.
Type Variable AsyncType TypeVar bound to a CancellableAwaitable
Type Variable CallTCo TypeVar for representing a cancelable call handle.
Type Variable DeltaType Undocumented
Type Variable IDT TypeVar for representing the opaque identifier of ScheduledCall objects.
Type Variable IDTCo IDT (Covariant)
Type Variable Prioritized A TypeVar for objects that can be compared for relative priority.
Type Variable Return Return TypeVar for generators and coroutines.
Type Variable Send Send TypeVar for generators and coroutines.
Type Variable StepsT A type representing the record of steps that have passed in a recurrence rule.
Type Variable StepsTCon StepsT (Contravariant)
Type Variable StepsTInv StepsT (Invariant)
Type Variable WhatT TypeVar for representing a unit of work that can take place within the context of a Scheduler.
Type Variable WhatTCo WhatT (Covariant)
Type Variable WhenT TypeVar for representing a time at which something can occur; a temporal coordinate in a timekeeping system.
Type Variable WhenTCo WhenT (Covariant)
Type Variable Yield Yield TypeVar for generators and coroutines.
Variable CivilScheduler Undocumented
Variable PhysicalScheduler Undocumented
Variable SomeScheduledCall Undocumented
Type Variable _BranchTime Undocumented
Type Variable _TrunkDelta Undocumented
Type Variable _TrunkTime Undocumented
AsyncType = (source)

TypeVar bound to a CancellableAwaitable

Value
TypeVar('AsyncType',
        bound=CancellableAwaitable[Any, Any, Any])
CallTCo = (source)

TypeVar for representing a cancelable call handle.

Value
TypeVar('CallTCo',
        bound=Cancellable, covariant=True)
DeltaType = (source)

Undocumented

Value
TypeVar('DeltaType')
IDT = (source)

TypeVar for representing the opaque identifier of ScheduledCall objects.

Value
TypeVar('IDT')
IDTCo = (source)

IDT (Covariant)

Value
TypeVar('IDTCo',
        covariant=True)
Prioritized = (source)

A TypeVar for objects that can be compared for relative priority.

Value
TypeVar('Prioritized',
        bound=PriorityComparable)
Return = (source)

Return TypeVar for generators and coroutines.

Value
TypeVar('Return',
        covariant=True)
Send = (source)

Send TypeVar for generators and coroutines.

Value
TypeVar('Send',
        contravariant=True)
StepsT = (source)

A type representing the record of steps that have passed in a recurrence rule.

Value
TypeVar('StepsT',
        covariant=True)
StepsTCon = (source)

StepsT (Contravariant)

Value
TypeVar('StepsTCon',
        contravariant=True)
StepsTInv = (source)

StepsT (Invariant)

Value
TypeVar('StepsTInv')
WhatT = (source)

TypeVar for representing a unit of work that can take place within the context of a Scheduler.

Value
TypeVar('WhatT',
        bound=Callable[[], None])
WhatTCo = (source)

WhatT (Covariant)

Value
TypeVar('WhatTCo',
        bound=Callable[[], None], covariant=True)
WhenT = (source)

TypeVar for representing a time at which something can occur; a temporal coordinate in a timekeeping system.

Value
TypeVar('WhenT',
        bound=PriorityComparable)
WhenTCo = (source)

WhenT (Covariant)

Value
TypeVar('WhenTCo',
        bound=PriorityComparable, covariant=True)
Yield = (source)

Yield TypeVar for generators and coroutines.

Value
TypeVar('Yield',
        covariant=True)
CivilScheduler = (source)

Undocumented

PhysicalScheduler = (source)

Undocumented

SomeScheduledCall = (source)

Undocumented

_BranchTime = (source)

Undocumented

Value
TypeVar('_BranchTime',
        bound=PriorityComparable)
_TrunkDelta = (source)

Undocumented

Value
TypeVar('_TrunkDelta')
_TrunkTime = (source)

Undocumented

Value
TypeVar('_TrunkTime',
        bound=PriorityComparable)