diff options
author | Alex Grönholm <alex.gronholm@nextday.fi> | 2022-07-31 20:34:27 +0300 |
---|---|---|
committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2022-07-31 23:51:50 +0300 |
commit | 4c785354a5ec342ca1796cbd0a0098d6e093a48e (patch) | |
tree | a1ead25a78ea4702ae1f0071a9904933873c79ac /src/apscheduler/_enums.py | |
parent | e5d0aa1828b834ebc7d2c4dca6b49063ad951ef4 (diff) | |
download | apscheduler-4c785354a5ec342ca1796cbd0a0098d6e093a48e.tar.gz |
Added missing docstrings to classes
Diffstat (limited to 'src/apscheduler/_enums.py')
-rw-r--r-- | src/apscheduler/_enums.py | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/src/apscheduler/_enums.py b/src/apscheduler/_enums.py index dec6669..139333a 100644 --- a/src/apscheduler/_enums.py +++ b/src/apscheduler/_enums.py @@ -4,21 +4,38 @@ from enum import Enum, auto class RunState(Enum): + """Used to track the running state of schedulers and workers.""" + + #: not running yet, but in the process of starting starting = auto() + #: running started = auto() + #: still running but in the process of shutting down stopping = auto() + #: not running stopped = auto() class JobOutcome(Enum): + """Used to indicate how the execution of a job ended.""" + + #: the job completed successfully success = auto() + #: the job raised an exception error = auto() + #: the job's execution was delayed enough for it to miss its designated run time by + #: too large a margin missed_start_deadline = auto() + #: the job's execution was cancelled cancelled = auto() - expired = auto() class ConflictPolicy(Enum): + """ + Used to indicate what to do when trying to add a schedule whose ID conflicts with an + existing schedule. + """ + #: replace the existing schedule with a new one replace = auto() #: keep the existing schedule as-is and drop the new schedule @@ -28,6 +45,10 @@ class ConflictPolicy(Enum): class CoalescePolicy(Enum): + """ + Used to indicate how to + """ + #: run once, with the earliest fire time earliest = auto() #: run once, with the latest fire time |