BaseScheduler

class scheduler.base.scheduler.BaseScheduler(logger: Logger | None = None)

Bases: ABC, Generic[BaseJobType, T]

Interface definition of an abstract scheduler.

Author: Jendrik A. Potyka, Fabian A. Preiss

Methods

__init__([logger])
cyclic(timing, handle, **kwargs)	Schedule a cyclic BaseJob.
daily(timing, handle, **kwargs)	Schedule a daily BaseJob.
delete_job(job)	Delete a BaseJob from the BaseScheduler.
delete_jobs([tags, any_tag])	Delete a set of BaseJobs from the BaseScheduler by tags.
get_jobs([tags, any_tag])	Get a set of BaseJobs from the BaseScheduler by tags.
hourly(timing, handle, **kwargs)	Schedule an hourly BaseJob.
minutely(timing, handle, **kwargs)	Schedule a minutely BaseJob.
once(timing, handle, *[, args, kwargs, ...])	Schedule a oneshot BaseJob.
weekly(timing, handle, **kwargs)	Schedule a weekly BaseJob.

Attributes

jobs	Get the set of all BaseJobs.

abstractmethod cyclic(timing: timedelta, handle: T, **kwargs) → BaseJobType

Schedule a cyclic BaseJob.

abstractmethod daily(timing: time | list[time], handle: T, **kwargs) → BaseJobType

Schedule a daily BaseJob.

abstractmethod delete_job(job: BaseJobType) → None

Delete a BaseJob from the BaseScheduler.

abstractmethod delete_jobs(tags: set[str] | None = None, any_tag: bool = False) → int

Delete a set of BaseJobs from the BaseScheduler by tags.

abstractmethod get_jobs(tags: set[str] | None = None, any_tag: bool = False) → set[BaseJobType]

Get a set of BaseJobs from the BaseScheduler by tags.

abstractmethod hourly(timing: time | list[time], handle: T, **kwargs) → BaseJobType

Schedule an hourly BaseJob.

abstract property jobs: set[BaseJobType]

Get the set of all BaseJobs.

abstractmethod minutely(timing: time | list[time], handle: T, **kwargs) → BaseJobType

Schedule a minutely BaseJob.

abstractmethod once(timing: datetime | timedelta | Weekday | time, handle: T, *, args: tuple[Any] | None = None, kwargs: dict[str, Any] | None = None, tags: Iterable[str] | None = None, alias: str | None = None) → BaseJobType

Schedule a oneshot BaseJob.

abstractmethod weekly(timing: Weekday | list[Weekday], handle: T, **kwargs) → BaseJobType

Schedule a weekly BaseJob.