Fritter API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • enum.Enum
    • fritter.boundaries.ScheduledState - No class docstring; 3/3 class variables documented
  • Exception
    • fritter.persistent.jsonable.MissingPersistentCall - A serialized persistent-call handle was missing.
  • fritter.drivers.asyncio.AsyncioAsyncDriver - Driver for Future-flavored awaitables.
  • fritter.drivers.asyncio.AsyncioTimeDriver - An implementation of TimeDriver using an asyncio event loop.
  • fritter.drivers.datetimes.DateScale - A fritter.boundaries.Scale that can scale between a trunk scheduler that uses physical time (floats) and a branch scheduler that uses civil time (dates and wall-clock times).
  • fritter.drivers.datetimes.DateTimeDriver - Driver based on ZoneInfo-aware datetimes.
  • fritter.drivers.memory.MemoryDriver - In-memory TimeDriver that only moves when advance is called.
  • fritter.drivers.sleep.SleepDriver - Instantiate a SleepDriver with no arguments to get one that sleeps using time.sleep and gets the current time with time.time.
  • fritter.drivers.twisted.TwistedAsyncDriver - Driver for Deferred-flavored awaitables.
  • fritter.drivers.twisted.TwistedTimeDriver - Instantiate a TwistedTimeDriver with an IReactorTime; for example:
  • fritter.persistent.jsonable._EveryDeltaJSONifier - Undocumented
  • fritter.persistent.jsonable._YearlyJSONifier - Undocumented
  • fritter.repeat.rules.datetimes.EachWeekOn - Repeat every week, on each weekday in the given set of days, at the given hour, minute, and second.
  • fritter.repeat.rules.datetimes.EachYear - An EachYear is a RecurrenceRule based on a number of years between two dates.
  • fritter.repeat.rules.datetimes.EveryDelta - An EveryDelta is a RecurrenceRule based on a timedelta, that can cause civil times to repeat.
  • fritter.repeat.rules.seconds.EverySecond - An EverySecond is a RecurrenceRule based on a float timestamp, that can repeat work on a physical-time interval.
  • typing.Generic
    • fritter.heap.Heap - A simple implementation of a priority queue using the standard library's heappop and heappush functions.
    • fritter.persistent.jsonable._JSONableRepeaterWrapper - Since a Scheduler can only contain work of a given type, which must have a 0-argument, None-returning signature, and JSONRegistry serializes the schedulers it creates or loads by enumerating the ScheduledCall...
    • fritter.persistent.jsonable._SelfReferentialCall - No class docstring; 4/4 properties, 0/2 class variable, 1/1 method documented
    • fritter.persistent.jsonable._SpecificTypeRegistration - General container for registering a specific kind of type (instances, plain callables, repeated callables).
    • fritter.persistent.jsonable.JSONableBoundMethod - A bound method that conforms to JSONable and can be serialized and deserialized.
    • fritter.persistent.jsonable.JSONableBoundRepeatable - Like JSONableBoundMethod, but for repeating calls.
    • fritter.persistent.jsonable.JSONableMethodDescriptor - A descriptor that can bind methods into JSONableBoundMethods.
    • fritter.persistent.jsonable.JSONableRepeatableDescriptor - A descriptor that can bind methods into JSONableBoundRepeatables.
    • fritter.persistent.jsonable.JSONRegistry - A JSONRegistry maintains a set of functions and methods (and the classes those methods are defined on) that can scheduled against a Scheduler and then persisted into a JSON blob to reconstitute that scheduler later.
    • fritter.persistent.jsonable.LoadProcess - A LoadProcess collects the parameters to one top-level call to JSONRegistry.loadScheduler.
    • fritter.persistent.jsonable.SerializableFunction - Wrapper around a function that conforms with JSONable.
    • fritter.repeat._AsyncStopper - An implementation of Cancellable which can stop the repetition kicked off by Async.repeatedly.
    • fritter.repeat.Async - An Async wraps an AsyncDriver and provides an implementation of repeatedly which:
    • fritter.repeat.Repeater - A Repeater can call a RepeatingWork function repeatedly.
    • fritter.scheduler._PriorityQueueBackedSchedulerImpl - A Scheduler allows for scheduling work (of the type WhatT, which must be at least a 0-argument None-returning callable) at a given time (WhenT, which much be sortable as a PriorityComparable).
    • fritter.scheduler.ConcreteScheduledCall - A handle to a call that has been scheduled.
    • fritter.tree._BranchDriver - Implementation of TimeDriver for Scheduler that is stacked on top of another Scheduler.
    • fritter.tree._FloatScale - No summary
    • fritter.tree.NoScale - Undocumented
  • typing.Protocol
    • fritter.boundaries.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.
    • fritter.boundaries.Cancellable - An object that can be cancelled.
      • fritter.boundaries.CancellableAwaitable - An object which can be both awaited and cancelled.
      • fritter.boundaries.ScheduledCall - No class docstring; 4/4 properties, 1/1 method documented
    • fritter.boundaries.CancellableAwaitable - An object which can be both awaited and cancelled.
    • fritter.boundaries.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.
      • fritter.boundaries.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.
    • fritter.boundaries.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.
    • fritter.boundaries.PriorityQueue - High-level specification of a priority queue.
    • fritter.boundaries.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.
    • fritter.boundaries.RepeatingWork - RepeatingWork is work that can be performed repeatedly in a loop.
      • fritter.persistent.jsonable.JSONableRepeatable - A callable that can be serialized as JSON, with a signature that can be used for repeated calls with JSONRegistry.repeatedly.
    • fritter.boundaries.Scale - A Scale defines a translation between a branch (i.e., "child") time scale, and a trunk (i.e., "parent") time scale.
    • fritter.boundaries.ScheduledCall - No class docstring; 4/4 properties, 1/1 method documented
    • fritter.boundaries.Scheduler - A Scheduler is an object that allows for scheduling of timed calls.
    • fritter.boundaries.TimeDriver - Driver interface that allows Fritter to schedule objects onto a third party library.
    • fritter.drivers.asyncio.LoopTimeInterface - Describe the portions of AbstractEventLoop used by AsyncioTimeDriver.
    • fritter.persistent.jsonable._JSONableMethodBinder - Separated description of JSONableMethodDescriptor.__get__ that wraps _JSONableRepeaterWrapper.repeat to work around this issue.
    • fritter.persistent.jsonable.HasTypeCode - The HasTypeCode protocol describes an object with a typeCodeForJSON method; this is used as a bound on other types such as JSONableCallable, JSONableRepeatable, and JSONableInstance.
      • fritter.persistent.jsonable.JSONable - Methods that allow a JSONRegistry to serialize an object as JSON.
        • fritter.persistent.jsonable.JSONableCallable - A callable that can be serialized as JSON.
        • fritter.persistent.jsonable.JSONableInstance - A class that conforms to JSONableInstance can be both serialized to and deserialized from JSON by a JSONRegistry. JSONableInstance.
        • fritter.persistent.jsonable.JSONableRepeatable - A callable that can be serialized as JSON, with a signature that can be used for repeated calls with JSONRegistry.repeatedly.
      • fritter.persistent.jsonable.RuleJSONIfier - External serializer for a recurrence rule.
    • fritter.persistent.jsonable.JSONable - Methods that allow a JSONRegistry to serialize an object as JSON.
      • fritter.persistent.jsonable.JSONableCallable - A callable that can be serialized as JSON.
      • fritter.persistent.jsonable.JSONableInstance - A class that conforms to JSONableInstance can be both serialized to and deserialized from JSON by a JSONRegistry. JSONableInstance.
      • fritter.persistent.jsonable.JSONableRepeatable - A callable that can be serialized as JSON, with a signature that can be used for repeated calls with JSONRegistry.repeatedly.
    • fritter.persistent.jsonable.JSONableCallable - A callable that can be serialized as JSON.
    • fritter.persistent.jsonable.JSONableInstance - A class that conforms to JSONableInstance can be both serialized to and deserialized from JSON by a JSONRegistry. JSONableInstance.
    • fritter.persistent.jsonable.JSONableRepeatable - A callable that can be serialized as JSON, with a signature that can be used for repeated calls with JSONRegistry.repeatedly.
    • fritter.persistent.jsonable.RuleJSONIfier - External serializer for a recurrence rule.
    • fritter.tree.BranchManager - A BranchManager controls a group of timers in a branch scheduler created with branch; pausing the passage of time in the branch, unpausing it, or making its relative rate of progress faster or slower.

API Documentation for Fritter, generated by pydoctor 24.11.2 at 2025-12-13 07:23:16.