python周期任务调度工具Schedule使用详解

如果你想周期性地执行某个 python 脚本，最出名的选择应该是 crontab 脚本，但是 crontab 具有以下缺点：

1.不方便执行秒级任务。

2.当需要执行的定时任务有上百个的时候，crontab 的管理就会特别不方便。

还有一个选择是 celery，但是 celery 的配置比较麻烦，如果你只是需要一个轻量级的调度工具，celery 不会是一个好选择。

在你想要使用一个轻量级的任务调度工具，而且希望它尽量简单、容易使用、不需要外部依赖，最好能够容纳 crontab 的所有基本功能，那么 schedule 模块是你的不二之选。

使用它来调度任务可能只需要几行代码，感受一下：

import schedule
import time
def job():
    print("i'm working...")
schedule.every(10).minutes.do(job)
while true:
    schedule.run_pending()
    time.sleep(1)

上面的代码表示每10分钟执行一次 job 函数，非常简单方便。你只需要引入 schedule 模块，通过调用 scedule.every(时间数).时间类型.do(job) 发布周期任务。

发布后的周期任务需要用 run_pending 函数来检测是否执行，因此需要一个 while 循环不断地轮询这个函数。

下面具体讲讲schedule模块的安装和初级、进阶使用方法。

1.准备

开始之前，你要确保python和pip已经成功安装在电脑上，请选择以下任一种方式输入命令安装依赖：

windows 环境 打开 cmd (开始-运行-cmd)。

macos 环境 打开 terminal (command+空格输入terminal)。

如果你用的是 vscode编辑器 或 pycharm，可以直接使用界面下方的terminal.

pip install schedule

2.基本使用

最基本的使用在文首已经提到过，下面给大家展示更多的调度任务例子：

import schedule
import time
def job():
    print("i'm working...")
# 每十分钟执行任务
schedule.every(10).minutes.do(job)
# 每个小时执行任务
schedule.every().hour.do(job)
# 每天的10:30执行任务
schedule.every().day.at("10:30").do(job)
# 每个月执行任务
schedule.every().monday.do(job)
# 每个星期三的13:15分执行任务
schedule.every().wednesday.at("13:15").do(job)
# 每分钟的第17秒执行任务
schedule.every().minute.at(":17").do(job)
while true:
    schedule.run_pending()
    time.sleep(1)

可以看到，从月到秒的配置，上面的例子都覆盖到了。不过如果你想只运行一次任务的话，可以这么配

import schedule
import time
def job_that_executes_once():
    # 此处编写的任务只会执行一次...
    return schedule.canceljob
schedule.every().day.at('22:30').do(job_that_executes_once)
while true:
    schedule.run_pending()
    time.sleep(1)

参数传递

如果你有参数需要传递给作业去执行，你只需要这么做：

import schedule
def greet(name):
    print('hello', name)
# do() 将额外的参数传递给job函数
schedule.every(2).seconds.do(greet, name='alice')
schedule.every(4).seconds.do(greet, name='bob')

获取目前所有的作业

如果你想获取目前所有的作业：

import schedule
def hello():
    print('hello world')
schedule.every().second.do(hello)
all_jobs = schedule.get_jobs()

取消所有作业

如果某些机制触发了，你需要立即清除当前程序的所有作业：

import schedule
def greet(name):
    print('hello {}'.format(name))
schedule.every().second.do(greet)
schedule.clear()

标签功能

在设置作业的时候，为了后续方便管理作业，你可以给作业打个标签，这样你可以通过标签过滤获取作业或取消作业。

import schedule
def greet(name):
    print('hello {}'.format(name))
# .tag 打标签
schedule.every().day.do(greet, 'andrea').tag('daily-tasks', 'friend')
schedule.every().hour.do(greet, 'john').tag('hourly-tasks', 'friend')
schedule.every().hour.do(greet, 'monica').tag('hourly-tasks', 'customer')
schedule.every().day.do(greet, 'derek').tag('daily-tasks', 'guest')
# get_jobs(标签)：可以获取所有该标签的任务
friends = schedule.get_jobs('friend')
# 取消所有 daily-tasks 标签的任务
schedule.clear('daily-tasks')

设定作业截止时间

如果你需要让某个作业到某个时间截止，你可以通过这个方法：

import schedule
from datetime import datetime, timedelta, time
def job():
    print('boo')
# 每个小时运行作业，18:30后停止
schedule.every(1).hours.until("18:30").do(job)
# 每个小时运行作业，2030-01-01 18:33 today
schedule.every(1).hours.until("2030-01-01 18:33").do(job)
# 每个小时运行作业，8个小时后停止
schedule.every(1).hours.until(timedelta(hours=8)).do(job)
# 每个小时运行作业，11:32:42后停止
schedule.every(1).hours.until(time(11, 33, 42)).do(job)
# 每个小时运行作业，2020-5-17 11:36:20后停止
schedule.every(1).hours.until(datetime(2020, 5, 17, 11, 36, 20)).do(job)

截止日期之后，该作业将无法运行。

立即运行所有作业，而不管其安排如何

如果某个机制触发了，你需要立即运行所有作业，可以调用 schedule.run_all() :

import schedule
def job_1():
    print('foo')
def job_2():
    print('bar')
schedule.every().monday.at("12:40").do(job_1)
schedule.every().tuesday.at("16:40").do(job_2)
schedule.run_all()
# 立即运行所有作业，每次作业间隔10秒
schedule.run_all(delay_seconds=10)

3.高级使用

装饰器安排作业

如果你觉得设定作业这种形式太啰嗦了，也可以使用装饰器模式：

from schedule import every, repeat, run_pending
import time
# 此装饰器效果等同于 schedule.every(10).minutes.do(job)
@repeat(every(10).minutes)
def job():
    print("i am a scheduled job")
while true:
    run_pending()
    time.sleep(1)

并行执行

默认情况下，schedule 按顺序执行所有作业。其背后的原因是，很难找到让每个人都高兴的并行执行模型。

不过你可以通过多线程的形式来运行每个作业以解决此限制：

import threading
import time
import schedule
def job1():
    print("i'm running on thread %s" % threading.current_thread())
def job2():
    print("i'm running on thread %s" % threading.current_thread())
def job3():
    print("i'm running on thread %s" % threading.current_thread())
def run_threaded(job_func):
    job_thread = threading.thread(target=job_func)
    job_thread.start()
schedule.every(10).seconds.do(run_threaded, job1)
schedule.every(10).seconds.do(run_threaded, job2)
schedule.every(10).seconds.do(run_threaded, job3)
while true:
    schedule.run_pending()
    time.sleep(1)

日志记录

schedule 模块同时也支持 logging 日志记录，这么使用：

import schedule
import logging
logging.basicconfig()
schedule_logger = logging.getlogger('schedule')
# 日志级别为debug
schedule_logger.setlevel(level=logging.debug)
def job():
    print("hello, logs")
schedule.every().second.do(job)
schedule.run_all()
schedule.clear()

效果如下：

debug:schedule:running *all* 1 jobs with 0s delay in between
debug:schedule:running job job(interval=1, unit=seconds, do=job, args=(), kwargs={})
hello, logs
debug:schedule:deleting *all* jobs

异常处理

schedule 不会自动捕捉异常，它遇到异常会直接抛出，这会导致一个严重的问题：后续所有的作业都会被中断执行，因此我们需要捕捉到这些异常。

你可以手动捕捉，但是某些你预料不到的情况需要程序进行自动捕获，加一个装饰器就能做到了：

import functools
def catch_exceptions(cancel_on_failure=false):
    def catch_exceptions_decorator(job_func):
        @functools.wraps(job_func)
        def wrapper(*args, **kwargs):
            try:
                return job_func(*args, **kwargs)
            except:
                import traceback
                print(traceback.format_exc())
                if cancel_on_failure:
                    return schedule.canceljob
        return wrapper
    return catch_exceptions_decorator
@catch_exceptions(cancel_on_failure=true)
def bad_task():
    return 1 / 0
schedule.every(5).minutes.do(bad_task)

这样，bad_task 在执行时遇到的任何错误，都会被 catch_exceptions 捕获，这点在保证调度任务正常运转的时候非常关键。

我们的文章到此就结束啦，如果你喜欢今天的python 实战教程，请持续关注。

以上就是python周期任务调度工具schedule使用详解的详细内容，更多关于周期任务调度工具schedule的资料请关注其它相关文章！