schedule 文档

schedule 文档

基本类

schedule.default_scheduler = <schedule.Scheduler object>

默认scheduler对象

Scheduler实例化的对象是用于创建作业的工厂，它保留计划作业的记录并处理其执行过程。

run_pending()

运行所有计划运行的作业。

请注意，run_pending（）不会运行丢失的作业是一种预期行为。 例如，如果您注册了应该每分钟运行一次的作业，并且仅以一小时的增量调用run_pending（），则您的作业将不会运行60次，而只能运行一次。

run_all(delay_seconds=0)

运行所有作业，无论它们是否计划运行。

每个作业之间添加了延迟秒数的延迟。 这有助于随着时间的推移更均匀地分配作业生成的系统负载。
参数：delay_seconds-每个执行的作业之间添加的延迟

clear(tag=None)

删除标有给定标签的计划作业，或者如果省略标签则删除所有作业。
参数：tag-用于标识要删除的作业子集的标识符

cancel_job(job)

删除计划的作业。
参数：job-要取消调度的作业

every(interval=1)

安排新的定期工作。
参数：interval –一定时间单位的间隔
返回：未配置的Job对象

next_run

下一个作业应运行的日期时间。
返回：日期时间对象

idle_seconds

返回：直到next_run的秒数。

schedule.jobs = []

计划程序使用的定期作业。

参数：

interval –一定时间单位的间隔
scheduler  –在Job.do（）中完全配置该作业后将向其注册的Scheduler实例。

每个作业均以给定的固定时间间隔运行，该时间间隔由以下内容定义：

• 时间单位
• 由间隔定义的时间

通常由Scheduler.every（）方法创建并返回作业，该方法还定义了其间隔。

second

seconds

minute

minutes

hour

hours

day

days

week

weeks

monday

tuesday

wednesday

thursday

friday

saturday

sunday

tag(*tags)

使用一个或多个唯一标识符来标记作业。

标签必须是可哈希的。 重复的标签将被丢弃。

参数：tags –哈希标签的唯一列表。
返回：调用的作业实例

at(time_str)

指定运行作业的特定时间。

参数：time_str –具有以下格式之一的字符串：

• HH：MM：SS，
• HH：MM，
• ：MM，
• ：SS。

考虑到工作重复的频率，格式必须有意义。

例如，每分钟重复一次的工作不应以HH：MM：SS的形式给出字符串。

：MM和：SS之间的差异是根据选定的时间单位推断出来的（例如 every().hour.at(‘:30’) vs. every().minute.at(‘:30’))
返回：调用的作业实例

to(latest)

计划作业以不规则（随机）间隔运行。

作业的时间间隔将随机变化，从每个值到最新的值。 定义的范围包括两端。 例如，every（A）.to（B）.seconds每N秒执行一次作业函数，这样A <= N <=B。

参数：latest –随机作业运行之间的最大间隔
返回：调用的作业实例

do(job_func, *args,**kwargs)

指定每次作业运行时应调用的job_func。

作业运行时，所有其他参数都会传递给job_func。

参数：job_func-要调度的函数
返回：调用的作业实例

should_run

返回：如果应该立即运行作业，则为True。

run()

运行该作业，然后立即重新计划它。

返回值：job_func返回的返回值