Class reference
Reference for returned classes from some functions. These are not intended to be created by the user.
Watches
ItemNoUpdateWatch
- class ItemNoUpdateWatch(name, secs)
- EVENT
alias of
ItemNoUpdateEvent
- cancel()
Cancel the item watch
- listen_event(callback)
Listen to (only) the event that is emitted by this watcher
ItemNoChangeWatch
- class ItemNoChangeWatch(name, secs)
- EVENT
alias of
ItemNoChangeEvent
- cancel()
Cancel the item watch
- listen_event(callback)
Listen to (only) the event that is emitted by this watcher
Scheduler
OneTimeJob
- class OneTimeJob(parent, func)
- cancel()
Cancel the job.
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
CountdownJob
- class CountdownJob(parent, func)
- cancel()
Cancel the job.
- countdown(time)
Set the time after which the job will be executed.
- Parameters:
time (
Union
[timedelta
,float
,int
]) – time- Return type:
CountdownJob
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- stop()
Stops the countdown so it can be started again with a call to reset
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
ReoccurringJob
- class ReoccurringJob(parent, func)
- boundary_func(func)
Add a function which will be called when the datetime changes. Use this to implement custom boundaries. Use
None
to disable the boundary function.- Parameters:
func (
Optional
[Callable
[[datetime
],datetime
]]) – Function which returns a datetime obj, arg is a datetime with the next run time. ReturnSKIP_EXECUTION
together with a reoccurring job to skip the proposed run time.- Return type:
DateTimeJobBase
- cancel()
Cancel the job.
- earliest(time_obj)
Set earliest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run earlier- Return type:
DateTimeJobBase
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- interval(interval)
Set the interval at which the task will run.
- Parameters:
interval (
Union
[int
,float
,timedelta
]) – interval in secs or a timedelta obj- Return type:
ReoccurringJob
- jitter(start, stop=None)
Add a random jitter per call in the interval [start <= secs <= stop] to the next run. If stop is omitted start must be positive and the interval will be [-start <= secs <= start] Passing
None
as start will disable jitter.- Parameters:
start (
Union
[int
,float
,None
]) – Interval start orNone
to disable jitterstop (
Union
[int
,float
,None
]) – Interval stop orNone
to build interval based on start
- Return type:
DateTimeJobBase
- latest(time_obj)
Set latest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run later- Return type:
DateTimeJobBase
- offset(timedelta_obj)
Set a constant offset to the calculation of the next run.
None
will disable the offset.- Parameters:
timedelta_obj (
Optional
[timedelta
]) – constant offset- Return type:
DateTimeJobBase
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
DayOfWeekJob
- class DayOfWeekJob(parent, func)
- boundary_func(func)
Add a function which will be called when the datetime changes. Use this to implement custom boundaries. Use
None
to disable the boundary function.- Parameters:
func (
Optional
[Callable
[[datetime
],datetime
]]) – Function which returns a datetime obj, arg is a datetime with the next run time. ReturnSKIP_EXECUTION
together with a reoccurring job to skip the proposed run time.- Return type:
DateTimeJobBase
- cancel()
Cancel the job.
- earliest(time_obj)
Set earliest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run earlier- Return type:
DateTimeJobBase
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- jitter(start, stop=None)
Add a random jitter per call in the interval [start <= secs <= stop] to the next run. If stop is omitted start must be positive and the interval will be [-start <= secs <= start] Passing
None
as start will disable jitter.- Parameters:
start (
Union
[int
,float
,None
]) – Interval start orNone
to disable jitterstop (
Union
[int
,float
,None
]) – Interval stop orNone
to build interval based on start
- Return type:
DateTimeJobBase
- latest(time_obj)
Set latest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run later- Return type:
DateTimeJobBase
- offset(timedelta_obj)
Set a constant offset to the calculation of the next run.
None
will disable the offset.- Parameters:
timedelta_obj (
Optional
[timedelta
]) – constant offset- Return type:
DateTimeJobBase
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- time(time)
Set a time of day when the job will run.
- Parameters:
time (
Union
[time
,datetime
]) – time- Return type:
DayOfWeekJob
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
- weekdays(weekdays)
Set the weekdays when the job will run.
- Parameters:
weekdays (
Union
[str
,Iterable
[Union
[str
,int
]]]) – Day group names (e.g.'all'
,'weekend'
,'workdays'
), an iterable with day names (e.g.['Mon', 'Fri']
) or an iterable with the isoweekday values (e.g.[1, 5]
).- Return type:
DayOfWeekJob
DawnJob
- class DawnJob(parent, func)
- boundary_func(func)
Add a function which will be called when the datetime changes. Use this to implement custom boundaries. Use
None
to disable the boundary function.- Parameters:
func (
Optional
[Callable
[[datetime
],datetime
]]) – Function which returns a datetime obj, arg is a datetime with the next run time. ReturnSKIP_EXECUTION
together with a reoccurring job to skip the proposed run time.- Return type:
DateTimeJobBase
- cancel()
Cancel the job.
- earliest(time_obj)
Set earliest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run earlier- Return type:
DateTimeJobBase
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- jitter(start, stop=None)
Add a random jitter per call in the interval [start <= secs <= stop] to the next run. If stop is omitted start must be positive and the interval will be [-start <= secs <= start] Passing
None
as start will disable jitter.- Parameters:
start (
Union
[int
,float
,None
]) – Interval start orNone
to disable jitterstop (
Union
[int
,float
,None
]) – Interval stop orNone
to build interval based on start
- Return type:
DateTimeJobBase
- latest(time_obj)
Set latest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run later- Return type:
DateTimeJobBase
- offset(timedelta_obj)
Set a constant offset to the calculation of the next run.
None
will disable the offset.- Parameters:
timedelta_obj (
Optional
[timedelta
]) – constant offset- Return type:
DateTimeJobBase
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
SunriseJob
- class SunriseJob(parent, func)
- boundary_func(func)
Add a function which will be called when the datetime changes. Use this to implement custom boundaries. Use
None
to disable the boundary function.- Parameters:
func (
Optional
[Callable
[[datetime
],datetime
]]) – Function which returns a datetime obj, arg is a datetime with the next run time. ReturnSKIP_EXECUTION
together with a reoccurring job to skip the proposed run time.- Return type:
DateTimeJobBase
- cancel()
Cancel the job.
- earliest(time_obj)
Set earliest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run earlier- Return type:
DateTimeJobBase
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- jitter(start, stop=None)
Add a random jitter per call in the interval [start <= secs <= stop] to the next run. If stop is omitted start must be positive and the interval will be [-start <= secs <= start] Passing
None
as start will disable jitter.- Parameters:
start (
Union
[int
,float
,None
]) – Interval start orNone
to disable jitterstop (
Union
[int
,float
,None
]) – Interval stop orNone
to build interval based on start
- Return type:
DateTimeJobBase
- latest(time_obj)
Set latest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run later- Return type:
DateTimeJobBase
- offset(timedelta_obj)
Set a constant offset to the calculation of the next run.
None
will disable the offset.- Parameters:
timedelta_obj (
Optional
[timedelta
]) – constant offset- Return type:
DateTimeJobBase
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
SunsetJob
- class SunsetJob(parent, func)
- boundary_func(func)
Add a function which will be called when the datetime changes. Use this to implement custom boundaries. Use
None
to disable the boundary function.- Parameters:
func (
Optional
[Callable
[[datetime
],datetime
]]) – Function which returns a datetime obj, arg is a datetime with the next run time. ReturnSKIP_EXECUTION
together with a reoccurring job to skip the proposed run time.- Return type:
DateTimeJobBase
- cancel()
Cancel the job.
- earliest(time_obj)
Set earliest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run earlier- Return type:
DateTimeJobBase
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- jitter(start, stop=None)
Add a random jitter per call in the interval [start <= secs <= stop] to the next run. If stop is omitted start must be positive and the interval will be [-start <= secs <= start] Passing
None
as start will disable jitter.- Parameters:
start (
Union
[int
,float
,None
]) – Interval start orNone
to disable jitterstop (
Union
[int
,float
,None
]) – Interval stop orNone
to build interval based on start
- Return type:
DateTimeJobBase
- latest(time_obj)
Set latest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run later- Return type:
DateTimeJobBase
- offset(timedelta_obj)
Set a constant offset to the calculation of the next run.
None
will disable the offset.- Parameters:
timedelta_obj (
Optional
[timedelta
]) – constant offset- Return type:
DateTimeJobBase
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable
DuskJob
- class DuskJob(parent, func)
- boundary_func(func)
Add a function which will be called when the datetime changes. Use this to implement custom boundaries. Use
None
to disable the boundary function.- Parameters:
func (
Optional
[Callable
[[datetime
],datetime
]]) – Function which returns a datetime obj, arg is a datetime with the next run time. ReturnSKIP_EXECUTION
together with a reoccurring job to skip the proposed run time.- Return type:
DateTimeJobBase
- cancel()
Cancel the job.
- earliest(time_obj)
Set earliest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run earlier- Return type:
DateTimeJobBase
- get_next_run()
Return the next execution timestamp.
- Return type:
datetime
- jitter(start, stop=None)
Add a random jitter per call in the interval [start <= secs <= stop] to the next run. If stop is omitted start must be positive and the interval will be [-start <= secs <= start] Passing
None
as start will disable jitter.- Parameters:
start (
Union
[int
,float
,None
]) – Interval start orNone
to disable jitterstop (
Union
[int
,float
,None
]) – Interval stop orNone
to build interval based on start
- Return type:
DateTimeJobBase
- latest(time_obj)
Set latest boundary as time of day.
None
will disable boundary.- Parameters:
time_obj (
Optional
[time
]) – time obj, scheduler will not run later- Return type:
DateTimeJobBase
- offset(timedelta_obj)
Set a constant offset to the calculation of the next run.
None
will disable the offset.- Parameters:
timedelta_obj (
Optional
[timedelta
]) – constant offset- Return type:
DateTimeJobBase
- remaining()
Returns the remaining time to the next run or None if the job is not scheduled
- Return type:
Optional
[timedelta
]- Returns:
remaining time as a timedelta or None
- to_item(item)
Sends the next execution (date)time to an item. Sends
None
if the job is not scheduled.- Parameters:
item (
UnionType
[str
,BaseValueItem
,None
]) – item name or item, None to disable