简介:APScheduler是基于Quartz的一个Python定时任务框架。提供了基于日期、固定时间间隔以及crontab类型的任务,并且可以持久化任务。
在线文档:https://apscheduler.readthedocs.io/en/latest/userguide.html
一、安装APScheduler
pip install apscheduler
二、基本概念介绍
触发器(triggers):
触发器包含调度逻辑,描述一个任务何时被触发,按日期或按时间间隔或按 cronjob 表达式三种方式触发。每个作业都有它自己的触发器,除了初始配置之外,触发器是完全无状态的。
三种内建的trigger:
(1)date: 特定的时间点触发
(2)interval: 固定时间间隔触发
(3)cron: 在特定时间周期性地触发
作业存储器(job stores):
作业存储器指定了作业被存放的位置,默认情况下作业保存在内存,也可将作业保存在各种数据库中,当作业被存放在数据库中时,它会被序列化,当被重新加载时会反序列化。作业存储器充当保存、加载、更新和查找作业的中间商。在调度器之间不能共享作业存储。
执行器(executors):
执行器是将指定的作业(调用函数)提交到线程池或进程池中运行,当任务完成时,执行器通知调度器触发相应的事件。
调度器(schedulers):
任务调度器,属于控制角色,通过它配置作业存储器、执行器和触发器,添加、修改和删除任务。调度器协调触发器、作业存储器、执行器的运行,通常只有一个调度程序运行在应用程序中,开发人员通常不需要直接处理作业存储器、执行器或触发器,配置作业存储器和执行器是通过调度器来完成的。
根据开发需求选择相应的组件,下面是不同的调度器组件:
BlockingScheduler 阻塞式调度器:适用于只跑调度器的程序。
BackgroundScheduler 后台调度器:适用于非阻塞的情况,调度器会在后台独立运行。
AsyncIOScheduler AsyncIO调度器,适用于应用使用AsnycIO的情况。
GeventScheduler Gevent调度器,适用于应用通过Gevent的情况。
TornadoScheduler Tornado调度器,适用于构建Tornado应用。
TwistedScheduler Twisted调度器,适用于构建Twisted应用。
QtScheduler Qt调度器,适用于构建Qt应用。
三、使用步骤
1、新建一个调度器schedulers
2、添加调度任务
3、运行调度任务
四、使用实例
1、触发器date
特定的时间点触发,只执行一次。参数如下:
from datetime import datetime
from datetime import date
from apscheduler.schedulers.blocking import BlockingScheduler
def job(text):
print(text)
scheduler = BlockingScheduler()
# 在 2020-8-30 运行一次 job 方法
scheduler.add_job(job, 'date', run_date=date(2020, 8, 30), args=['text1'])
# 在 2020-8-30 01:00:00 运行一次 job 方法
scheduler.add_job(job, 'date', run_date=datetime(2020, 8, 30, 1, 0, 0), args=['text2'])
# 在 2020-8-30 01:00:01 运行一次 job 方法
scheduler.add_job(job, 'date', run_date='2020-8-30 01:00:00', args=['text3'])
scheduler.start()
2、触发器interval
固定时间间隔触发。参数如下
import time
from apscheduler.schedulers.blocking import BlockingScheduler
def job(text):
t = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))
print('{} --- {}'.format(text, t))
scheduler = BlockingScheduler()
# 每隔 1分钟 运行一次 job 方法
scheduler.add_job(job, 'interval', minutes=1, args=['job1'])
# 在 2020-08-28 15:43:00至2020-08-28 15:50:00期间,每隔1分30秒 运行一次 job 方法
scheduler.add_job(job, 'interval', minutes=1, seconds = 30, start_date='2020-08-28 15:43:00', end_date='2020-08-28 15:50:00', args=['job2'])
scheduler.start()
'''
运行结果:
job2 --- 2020-08-28 15:43:00
job1 --- 2020-08-28 15:43:19
job1 --- 2020-08-28 15:44:19
job2 --- 2020-08-28 15:44:30
job1 --- 2020-08-28 15:45:19
job2 --- 2020-08-28 15:46:00
job1 --- 2020-08-28 15:46:19
job1 --- 2020-08-28 15:47:19
job2 --- 2020-08-28 15:47:30
...余下省略...
'''
3、触发器cron
在特定时间周期性地触发。参数如下:
year (int 或 str):年,4位数字
month (int 或 str):月 (范围1-12)
day (int 或 str):日 (范围1-31)
week (int 或 str):周 (范围1-53)
day_of_week (int 或 str):周内第几天或者星期几 (范围0-6 或者mon,tue,wed,thu,fri,sat,sun)
hour (int 或 str):时 (范围0-23)
minute (int 或 str):分 (范围0-59)
second (int 或 str):秒 (范围0-59)
start_date (datetime 或 str):最早开始日期(包含)
end_date (datetime 或 str):最晚结束时间(包含)
timezone (datetime.tzinfo 或str):指定时区
import time
from apscheduler.schedulers.blocking import BlockingScheduler
def job(text):
t = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))
print('{} --- {}'.format(text, t))
scheduler = BlockingScheduler()
# 在每天22点,每隔 1分钟 运行一次 job 方法
scheduler.add_job(job, 'cron', hour=22, minute='*/1', args=['job1'])
# 在每天22和23点的25分,运行一次 job 方法
scheduler.add_job(job, 'cron', hour='22-23', minute='25', args=['job2'])
scheduler.start()
'''
运行结果:
job2 --- 2020-08-28 16:20:00
job1 --- 2020-08-28 16:30:00
job2 --- 2020-08-28 17:20:00
'''
4、通过装饰器scheduled_job()添加任务
import time
from apscheduler.schedulers.blocking import BlockingScheduler
scheduler = BlockingScheduler()
#指定时间内每1分30秒执行一次
@scheduler.scheduled_job('interval', minutes=1, seconds = 30, start_date='2020-08-28 17:10:00', end_date='2020-08-28 17:20:00',)
def job1():
t = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))
print('job1 --- {}'.format(t))
#17-18点内每10分钟执行一次
@scheduler.scheduled_job('cron', hour='17-18', minute='*/10',)
def job2():
t = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))
print('job2 --- {}'.format(t))
scheduler.start()
运行结果:
job1 --- 2020-08-28 17:10:00
job2 --- 2020-08-28 17:10:00
job1 --- 2020-08-28 17:11:30
job1 --- 2020-08-28 17:13:00
job1 --- 2020-08-28 17:14:30
job1 --- 2020-08-28 17:16:00
job1 --- 2020-08-28 17:17:30
job1 --- 2020-08-28 17:19:00
job2 --- 2020-08-28 17:20:00
job2 --- 2020-08-28 17:30:00
job2 --- 2020-08-28 17:40:00
job2 --- 2020-08-28 17:50:00