Job Deletion

There are two ways to remove Jobs from a scheduler.

Delete a specific Job by it’s reference

Setup a couple of Jobs

>>> import datetime as dt
>>> import time

>>> from scheduler import Scheduler

>>> def foo():
...     print("foo")
...

>>> schedule = Scheduler()
>>> j1 = schedule.cyclic(dt.timedelta(seconds=1), foo)  
>>> j2 = schedule.cyclic(dt.timedelta(seconds=2), foo)  
>>> j3 = schedule.cyclic(dt.timedelta(seconds=3), foo)  
>>> print(schedule)  
max_exec=inf, tzinfo=None, priority_function=linear_priority_function, #jobs=3

type     function / alias due at                 due in      attempts weight
-------- ---------------- ------------------- --------- ------------- ------
CYCLIC   foo()            2021-06-20 05:22:29   0:00:00         0/inf      1
CYCLIC   foo()            2021-06-20 05:22:30   0:00:01         0/inf      1
CYCLIC   foo()            2021-06-20 05:22:31   0:00:02         0/inf      1

Remove the specified Job j2 from the Scheduler via the delete_job() method:

>>> schedule.delete_job(j2)
>>> print(schedule)  
max_exec=inf, tzinfo=None, priority_function=linear_priority_function, #jobs=2

type     function / alias due at                 due in      attempts weight
-------- ---------------- ------------------- --------- ------------- ------
CYCLIC   foo()            2021-06-20 05:22:29   0:00:00         0/inf      1
CYCLIC   foo()            2021-06-20 05:22:31   0:00:02         0/inf      1

Delete Jobs

Setup a couple of Jobs

>>> import datetime as dt
>>> import time

>>> from scheduler import Scheduler

>>> def foo():
...     print("foo")
...

>>> schedule = Scheduler()
>>> schedule.cyclic(dt.timedelta(seconds=1), foo)  
scheduler.Job(...CYCLIC...timedelta(seconds=1)...foo...)
>>> schedule.cyclic(dt.timedelta(seconds=2), foo)  
scheduler.Job(...CYCLIC...timedelta(seconds=2)...foo...)
>>> schedule.cyclic(dt.timedelta(seconds=3), foo)  
scheduler.Job(...CYCLIC...timedelta(seconds=3)...foo...)
>>> print(schedule)  
max_exec=inf, tzinfo=None, priority_function=linear_priority_function, #jobs=3

type     function / alias due at                 due in      attempts weight
-------- ---------------- ------------------- --------- ------------- ------
CYCLIC   foo()            2021-06-20 05:22:29   0:00:00         0/inf      1
CYCLIC   foo()            2021-06-20 05:22:30   0:00:01         0/inf      1
CYCLIC   foo()            2021-06-20 05:22:31   0:00:02         0/inf      1

Clear the Scheduler from Jobs with a single function call to delete_jobs().

>>> schedule.delete_jobs()
3
>>> print(schedule)  
max_exec=inf, tzinfo=None, priority_function=linear_priority_function, #jobs=0

type     function / alias due at                 due in      attempts weight
-------- ---------------- ------------------- --------- ------------- ------

Note

Additionally delete_jobs() supports the tagging system described in Tags.