Skip to content

dp3.common.scheduler

Allows modules to register functions (callables) to be run at specified times or intervals (like cron does).

Based on APScheduler package

Scheduler 

Scheduler()

Allows modules to register functions (callables) to be run at specified times or intervals (like cron does).

Source code in dp3/common/scheduler.py 
23
24
25
26
27
28
29
def __init__(self) -> None:
    self.log = logging.getLogger("Scheduler")
    # self.log.setLevel("DEBUG")
    logging.getLogger("apscheduler.scheduler").setLevel("WARNING")
    logging.getLogger("apscheduler.executors.default").setLevel("WARNING")
    self.sched = BackgroundScheduler(timezone="UTC")
    self.last_job_id = 0

register 

register(func: Callable, func_args: Union[list, tuple] = None, func_kwargs: dict = None, year: Union[int, str] = None, month: Union[int, str] = None, day: Union[int, str] = None, week: Union[int, str] = None, day_of_week: Union[int, str] = None, hour: Union[int, str] = None, minute: Union[int, str] = None, second: Union[int, str] = None, timezone: str = 'UTC', misfire_grace_time: int = 1) -> int

Register a function to be run at specified times.

Pass cron-like specification of when the function should be called, see docs of apscheduler.triggers.cron for details.

Parameters:

Name Type Description Default
func Callable

function or method to be called

 required
func_args Union[list, tuple]

list of positional arguments to call func with

 None
func_kwargs dict

dict of keyword arguments to call func with

 None
year Union[int, str]

4-digit year

 None
month Union[int, str]

month (1-12)

 None
day Union[int, str]

day of month (1-31)

 None
week Union[int, str]

ISO week (1-53)

 None
day_of_week Union[int, str]

number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun)

 None
hour Union[int, str]

hour (0-23)

 None
minute Union[int, str]

minute (0-59)

 None
second Union[int, str]

second (0-59)

 None
timezone str

Timezone for time specification (default is UTC).

 'UTC'
misfire_grace_time int

seconds after the designated run time that the job is still allowed to be run (default is 1)

 1

Returns: job ID

Source code in dp3/common/scheduler.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def register(
    self,
    func: Callable,
    func_args: Union[list, tuple] = None,
    func_kwargs: dict = None,
    year: Union[int, str] = None,
    month: Union[int, str] = None,
    day: Union[int, str] = None,
    week: Union[int, str] = None,
    day_of_week: Union[int, str] = None,
    hour: Union[int, str] = None,
    minute: Union[int, str] = None,
    second: Union[int, str] = None,
    timezone: str = "UTC",
    misfire_grace_time: int = 1,
) -> int:
    """
    Register a function to be run at specified times.

    Pass cron-like specification of when the function should be called,
    see [docs](https://apscheduler.readthedocs.io/en/latest/modules/triggers/cron.html)
    of apscheduler.triggers.cron for details.

    Args:
        func: function or method to be called
        func_args: list of positional arguments to call func with
        func_kwargs: dict of keyword arguments to call func with
        year: 4-digit year
        month: month (1-12)
        day: day of month (1-31)
        week: ISO week (1-53)
        day_of_week: number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun)
        hour: hour (0-23)
        minute: minute (0-59)
        second: second (0-59)
        timezone: Timezone for time specification (default is UTC).
        misfire_grace_time: seconds after the designated run time
            that the job is still allowed to be run (default is 1)
    Returns:
         job ID
    """
    self.last_job_id += 1
    trigger = CronTrigger(
        year, month, day, week, day_of_week, hour, minute, second, timezone=timezone
    )
    self.sched.add_job(
        func,
        trigger,
        func_args,
        func_kwargs,
        coalesce=True,
        max_instances=1,
        misfire_grace_time=misfire_grace_time,
        id=str(self.last_job_id),
    )
    self.log.debug(f"Registered function {get_func_name(func)} to be called at {trigger}")
    return self.last_job_id

pause_job 

pause_job(id)

Pause job with given ID

Source code in dp3/common/scheduler.py 
97
98
99
def pause_job(self, id):
    """Pause job with given ID"""
    self.sched.pause_job(str(id))

resume_job 

resume_job(id)

Resume previously paused job with given ID

Source code in dp3/common/scheduler.py 
101
102
103
def resume_job(self, id):
    """Resume previously paused job with given ID"""
    self.sched.resume_job(str(id))