File: docs/api.rst Copy Chapter

API reference

Data structures Copy Chapter

.. autoclass:: apscheduler.Task
.. autoclass:: apscheduler.TaskDefaults
.. autoclass:: apscheduler.Schedule
.. autoclass:: apscheduler.ScheduleResult
.. autoclass:: apscheduler.Job
.. autoclass:: apscheduler.JobResult

Decorators Copy Chapter

.. autodecorator:: apscheduler.task

Schedulers Copy Chapter

.. autoclass:: apscheduler.Scheduler
.. autoclass:: apscheduler.AsyncScheduler

Job executors Copy Chapter

.. autoclass:: apscheduler.abc.JobExecutor
.. autoclass:: apscheduler.executors.async_.AsyncJobExecutor
.. autoclass:: apscheduler.executors.subprocess.ProcessPoolJobExecutor
.. autoclass:: apscheduler.executors.qt.QtJobExecutor
.. autoclass:: apscheduler.executors.thread.ThreadPoolJobExecutor

Data stores Copy Chapter

.. autoclass:: apscheduler.abc.DataStore
.. autoclass:: apscheduler.datastores.memory.MemoryDataStore
.. autoclass:: apscheduler.datastores.sqlalchemy.SQLAlchemyDataStore
.. autoclass:: apscheduler.datastores.mongodb.MongoDBDataStore

Event brokers Copy Chapter

.. autoclass:: apscheduler.abc.EventBroker
.. autoclass:: apscheduler.abc.Subscription
.. autoclass:: apscheduler.eventbrokers.local.LocalEventBroker
.. autoclass:: apscheduler.eventbrokers.asyncpg.AsyncpgEventBroker
.. autoclass:: apscheduler.eventbrokers.psycopg.PsycopgEventBroker
.. autoclass:: apscheduler.eventbrokers.mqtt.MQTTEventBroker
.. autoclass:: apscheduler.eventbrokers.redis.RedisEventBroker

Serializers Copy Chapter

.. autoclass:: apscheduler.abc.Serializer
.. autoclass:: apscheduler.serializers.cbor.CBORSerializer
.. autoclass:: apscheduler.serializers.json.JSONSerializer
.. autoclass:: apscheduler.serializers.pickle.PickleSerializer

Triggers Copy Chapter

.. autoclass:: apscheduler.abc.Trigger
:special-members: getstate, setstate

.. autoclass:: apscheduler.triggers.date.DateTrigger
.. autoclass:: apscheduler.triggers.interval.IntervalTrigger
.. autoclass:: apscheduler.triggers.calendarinterval.CalendarIntervalTrigger
.. autoclass:: apscheduler.triggers.combining.AndTrigger
.. autoclass:: apscheduler.triggers.combining.OrTrigger
.. autoclass:: apscheduler.triggers.cron.CronTrigger

Events Copy Chapter

.. autoclass:: apscheduler.Event
.. autoclass:: apscheduler.DataStoreEvent
.. autoclass:: apscheduler.TaskAdded
.. autoclass:: apscheduler.TaskUpdated
.. autoclass:: apscheduler.TaskRemoved
.. autoclass:: apscheduler.ScheduleAdded
.. autoclass:: apscheduler.ScheduleUpdated
.. autoclass:: apscheduler.ScheduleRemoved
.. autoclass:: apscheduler.JobAdded
.. autoclass:: apscheduler.JobRemoved
.. autoclass:: apscheduler.ScheduleDeserializationFailed
.. autoclass:: apscheduler.JobDeserializationFailed
.. autoclass:: apscheduler.SchedulerEvent
.. autoclass:: apscheduler.SchedulerStarted
.. autoclass:: apscheduler.SchedulerStopped
.. autoclass:: apscheduler.JobAcquired
.. autoclass:: apscheduler.JobReleased

Enumerated types Copy Chapter

.. autoclass:: apscheduler.SchedulerRole()
:show-inheritance:

.. autoclass:: apscheduler.RunState()
:show-inheritance:

.. autoclass:: apscheduler.JobOutcome()
:show-inheritance:

.. autoclass:: apscheduler.ConflictPolicy()
:show-inheritance:

.. autoclass:: apscheduler.CoalescePolicy()
:show-inheritance:

Context variables Copy Chapter

See the :mod:contextvars module for information on how to work with context variables.

.. data:: apscheduler.current_scheduler
:type: ~contextvars.ContextVar[Scheduler]

The current scheduler.

.. data:: apscheduler.current_async_scheduler
:type: ~contextvars.ContextVar[AsyncScheduler]

The current asynchronous scheduler.

.. data:: apscheduler.current_job
:type: ~contextvars.ContextVar[Job]

The job being currently run (available when running the job's target callable).

Exceptions Copy Chapter

.. autoexception:: apscheduler.TaskLookupError
.. autoexception:: apscheduler.ScheduleLookupError
.. autoexception:: apscheduler.JobLookupError
.. autoexception:: apscheduler.CallableLookupError
.. autoexception:: apscheduler.JobResultNotReady
.. autoexception:: apscheduler.JobCancelled
.. autoexception:: apscheduler.JobDeadlineMissed
.. autoexception:: apscheduler.ConflictingIdError
.. autoexception:: apscheduler.SerializationError
.. autoexception:: apscheduler.DeserializationError
.. autoexception:: apscheduler.MaxIterationsReached

Support classes for retrying failures Copy Chapter

.. autoclass:: apscheduler.RetrySettings
.. autoclass:: apscheduler.RetryMixin

Support classes for unset options Copy Chapter

.. data:: apscheduler.unset

Sentinel value for unset option values.

.. autoclass:: apscheduler.UnsetValue