You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
114 lines
3.2 KiB
Python
114 lines
3.2 KiB
Python
"""
|
|
This type stub file was generated by pyright.
|
|
"""
|
|
|
|
UTC = ...
|
|
class Job:
|
|
"""
|
|
Contains the options given when scheduling callables and its current schedule and other state.
|
|
This class should never be instantiated by the user.
|
|
|
|
:var str id: the unique identifier of this job
|
|
:var str name: the description of this job
|
|
:var func: the callable to execute
|
|
:var tuple|list args: positional arguments to the callable
|
|
:var dict kwargs: keyword arguments to the callable
|
|
:var bool coalesce: whether to only run the job once when several run times are due
|
|
:var trigger: the trigger object that controls the schedule of this job
|
|
:var str executor: the name of the executor that will run this job
|
|
:var int misfire_grace_time: the time (in seconds) how much this job's execution is allowed to
|
|
be late (``None`` means "allow the job to run no matter how late it is")
|
|
:var int max_instances: the maximum number of concurrently executing instances allowed for this
|
|
job
|
|
:var datetime.datetime next_run_time: the next scheduled run time of this job
|
|
|
|
.. note::
|
|
The ``misfire_grace_time`` has some non-obvious effects on job execution. See the
|
|
:ref:`missed-job-executions` section in the documentation for an in-depth explanation.
|
|
"""
|
|
__slots__ = ...
|
|
def __init__(self, scheduler, id=..., **kwargs) -> None:
|
|
...
|
|
|
|
def modify(self, **changes): # -> Self:
|
|
"""
|
|
Makes the given changes to this job and saves it in the associated job store.
|
|
|
|
Accepted keyword arguments are the same as the variables on this class.
|
|
|
|
.. seealso:: :meth:`~apscheduler.schedulers.base.BaseScheduler.modify_job`
|
|
|
|
:return Job: this job instance
|
|
|
|
"""
|
|
...
|
|
|
|
def reschedule(self, trigger, **trigger_args): # -> Self:
|
|
"""
|
|
Shortcut for switching the trigger on this job.
|
|
|
|
.. seealso:: :meth:`~apscheduler.schedulers.base.BaseScheduler.reschedule_job`
|
|
|
|
:return Job: this job instance
|
|
|
|
"""
|
|
...
|
|
|
|
def pause(self): # -> Self:
|
|
"""
|
|
Temporarily suspend the execution of this job.
|
|
|
|
.. seealso:: :meth:`~apscheduler.schedulers.base.BaseScheduler.pause_job`
|
|
|
|
:return Job: this job instance
|
|
|
|
"""
|
|
...
|
|
|
|
def resume(self): # -> Self:
|
|
"""
|
|
Resume the schedule of this job if previously paused.
|
|
|
|
.. seealso:: :meth:`~apscheduler.schedulers.base.BaseScheduler.resume_job`
|
|
|
|
:return Job: this job instance
|
|
|
|
"""
|
|
...
|
|
|
|
def remove(self): # -> None:
|
|
"""
|
|
Unschedules this job and removes it from its associated job store.
|
|
|
|
.. seealso:: :meth:`~apscheduler.schedulers.base.BaseScheduler.remove_job`
|
|
|
|
"""
|
|
...
|
|
|
|
@property
|
|
def pending(self): # -> bool:
|
|
"""
|
|
Returns ``True`` if the referenced job is still waiting to be added to its designated job
|
|
store.
|
|
|
|
"""
|
|
...
|
|
|
|
def __getstate__(self): # -> dict[str, Any]:
|
|
...
|
|
|
|
def __setstate__(self, state): # -> None:
|
|
...
|
|
|
|
def __eq__(self, other) -> bool:
|
|
...
|
|
|
|
def __repr__(self): # -> str:
|
|
...
|
|
|
|
def __str__(self) -> str:
|
|
...
|
|
|
|
|
|
|