apscheduler API reference

74 public APIs from apscheduler (agronholm/apscheduler) — 39 classes, 4 functions, 31 methods. Signatures extracted by static analysis of the actual source.

Repository: agronholm/apscheduler

Kind	Count
Classes	39
Functions	4
Methods	31

API list

classsrc.apscheduler._enums.JobOutcome

Used to indicate how the execution of a job ended.

classsrc.apscheduler._enums.RunState

Used to track the running state of schedulers.

classsrc.apscheduler._events.DataStoreEvent

Base class for events originating from a data store.

classsrc.apscheduler._events.Event

Base class for all events.

classsrc.apscheduler._events.JobAdded

Signals that a new job was added to the store.

classsrc.apscheduler._events.JobDeserializationFailed

Signals that the deserialization of a job has failed.

classsrc.apscheduler._events.JobReleased

Signals that a scheduler has finished processing of a job.

classsrc.apscheduler._events.JobRemoved

Signals that a job was removed from the store.

classsrc.apscheduler._events.ScheduleAdded

Signals that a new schedule was added to the store.

classsrc.apscheduler._events.ScheduleRemoved

Signals that a schedule was removed from the store.

classsrc.apscheduler._events.ScheduleUpdated

Signals that a schedule has been updated in the store.

classsrc.apscheduler._events.SchedulerEvent

Base class for events originating from a scheduler.

classsrc.apscheduler._events.SchedulerStopped

Signals that a scheduler has stopped.

classsrc.apscheduler._events.TaskAdded

Signals that a new task was added to the store.

classsrc.apscheduler._events.TaskRemoved

Signals that a task was removed from the store.

classsrc.apscheduler._events.TaskUpdated

Signals that a task was updated in a data store.

funcsrc.apscheduler._marshalling.callable_from_ref(ref:str) -> Callable

Return the callable pointed to by ``ref``.

funcsrc.apscheduler._marshalling.callable_to_ref(func:Callable) -> str

Return a reference to the given callable.

classsrc.apscheduler._retry.RetryMixin

Mixin that provides support for retrying operations.

classsrc.apscheduler._retry.RetrySettings

Settings for retrying an operation with Tenacity.

classsrc.apscheduler._schedulers.async_.AsyncScheduler

An asynchronous (AnyIO based) scheduler implementation.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.get_job_result(job_id:UUID, *wait:bool=True) -> JobResult | None

Retrieve the result of a job.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.get_jobs() -> Sequence[Job]

Retrieve all jobs from the data store.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.get_schedule(id:str) -> Schedule

Retrieve a schedule from the data store.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.get_schedules() -> list[Schedule]

Retrieve all schedules from the data store.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.get_tasks() -> Sequence[Task]

Retrieve all currently defined tasks.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.pause_schedule(id:str) -> None

Pause the specified schedule.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.remove_schedule(id:str) -> None

Remove the given schedule from the data store.

method

src.apscheduler._schedulers.async_.AsyncScheduler.run_until_stopped(*task_status:TaskStatus[None]=TASK_STATUS_IGNORED) -> None

Run the scheduler until explicitly stopped.

methodsrc.apscheduler._schedulers.async_.AsyncScheduler.state() -> RunState

The current running state of the scheduler.

method

src.apscheduler._schedulers.async_.AsyncScheduler.unpause_schedule(id:str, *resume_from:datetime | Literal['now'] | None=None) -> None

Unpause the specified schedule.

classsrc.apscheduler._schedulers.sync.Scheduler

A synchronous wrapper for :class:`AsyncScheduler`.

methodsrc.apscheduler._schedulers.sync.Scheduler.start_in_background() -> None

Launch the scheduler in a new thread.

methodsrc.apscheduler._schedulers.sync.Scheduler.state() -> RunState

The current running state of the scheduler.

classsrc.apscheduler._structures.Job

Represents a queued request to run a task.

methodsrc.apscheduler._structures.Job.original_scheduled_time() -> datetime | None

The scheduled time without any jitter included.

classsrc.apscheduler._structures.JobResult

Represents the result of running a job.

classsrc.apscheduler._structures.Schedule

Represents a schedule on which a task will be run.

classsrc.apscheduler._structures.ScheduleResult

Represents a result of a schedule processing operation.

classsrc.apscheduler._utils.UnsetValue

The type of :data:`unset`.

funcsrc.apscheduler._utils.current_async_library() -> str

Return the name of the currently used async library.

funcsrc.apscheduler._utils.time_exists(dt:datetime) -> bool

Determine whether a datetime exists in its time zone.

classsrc.apscheduler.abc.DataStore

Interface for data stores.

method

src.apscheduler.abc.DataStore.acquire_jobs(scheduler_id:str, lease_duration:timedelta, limit:int | None=None) -> list[Job]

Acquire unclaimed jobs for execution.

methodsrc.apscheduler.abc.DataStore.acquire_schedules(scheduler_id:str, lease_duration:timedelta, limit:int) -> list[Schedule]

Acquire unclaimed due schedules for processing.

methodsrc.apscheduler.abc.DataStore.add_job(job:Job) -> None

Add a job to be executed by an eligible scheduler.

methodsrc.apscheduler.abc.DataStore.add_schedule(schedule:Schedule, conflict_policy:ConflictPolicy) -> None

Add or update the given schedule in the data store.

methodsrc.apscheduler.abc.DataStore.add_task(task:Task) -> None

Add the given task to the store.

methodsrc.apscheduler.abc.DataStore.cleanup() -> None

Perform clean-up operations on the data store.

methodsrc.apscheduler.abc.DataStore.get_job_result(job_id:UUID) -> JobResult | None

Retrieve the result of a job.

methodsrc.apscheduler.abc.DataStore.get_jobs(ids:Iterable[UUID] | None=None) -> list[Job]

Get the list of pending jobs.

methodsrc.apscheduler.abc.DataStore.get_schedules(ids:set[str] | None=None) -> list[Schedule]

Get schedules from the data store.

methodsrc.apscheduler.abc.DataStore.get_task(task_id:str) -> Task

Get an existing task definition.

methodsrc.apscheduler.abc.DataStore.get_tasks() -> list[Task]

Get all the tasks in this store.

methodsrc.apscheduler.abc.DataStore.release_job(scheduler_id:str, job:Job, result:JobResult) -> None

Release the claim on the given job and record the result.

methodsrc.apscheduler.abc.DataStore.remove_schedules(ids:Iterable[str]) -> None

Remove schedules from the data store.

methodsrc.apscheduler.abc.DataStore.remove_task(task_id:str) -> None

Remove the task with the given ID.

methodsrc.apscheduler.abc.DataStore.start(exit_stack:AsyncExitStack, event_broker:EventBroker, logger:Logger) -> None

Start the event broker.

classsrc.apscheduler.abc.Serializer

Interface for classes that implement (de)serialization.

methodsrc.apscheduler.abc.Serializer.serialize(obj:object) -> bytes

Turn the given object into a bytestring.

classsrc.apscheduler.abc.Subscription

Represents a subscription with an event source.

methodsrc.apscheduler.abc.Subscription.unsubscribe() -> None

Cancel this subscription.

methodsrc.apscheduler.abc.Trigger.next() -> datetime | None

Return the next datetime to fire on.

classsrc.apscheduler.datastores.base.BaseDataStore

Base class for data stores.

classsrc.apscheduler.datastores.mongodb.MongoDBDataStore

Uses a MongoDB server to store data.

classsrc.apscheduler.datastores.sqlalchemy.SQLAlchemyDataStore

Uses a relational database to store data.

classsrc.apscheduler.eventbrokers.local.LocalEventBroker

Asynchronous, local event broker.

classsrc.apscheduler.executors.async_.AsyncJobExecutor

Executes functions directly on the event loop thread.

classsrc.apscheduler.executors.subprocess.ProcessPoolJobExecutor

Executes functions in a process pool.

classsrc.apscheduler.executors.thread.ThreadPoolJobExecutor

Executes functions in a thread pool.

classsrc.apscheduler.serializers.cbor.CBORSerializer

Serializes objects using CBOR (:rfc:`8949`).

classsrc.apscheduler.serializers.json.JSONSerializer

Serializes objects using JSON.

classsrc.apscheduler.triggers.date.DateTrigger

Triggers once on the given date/time.

classsrc.apscheduler.triggers.interval.IntervalTrigger

Triggers on specified intervals.

About this data

These signatures were extracted from the public source of agronholm/apscheduler using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries