Python使用APScheduler实现定时任务

APScheduler是基于Quartz的一个Python定时任务框架。提供了基于日期、固定时间间隔以及crontab类型的任务,并且可以持久化任务。

在线文档:https://apscheduler.readthedocs.io/en/latest/userguide.html

一、安装APScheduler

pip install apscheduler

二、基本概念

APScheduler有四大组件:

1、触发器 triggers :

触发器包含调度逻辑。每个作业都有自己的触发器,用于确定下一个任务何时运行。除了初始配置之外,触发器是完全无状态的。

有三种内建的trigger:

(1)date: 特定的时间点触发

(2)interval: 固定时间间隔触发

(3)cron: 在特定时间周期性地触发

2、任务储存器 job stores:用于存放任务,把任务存放在内存(为默认MemoryJobStore)或数据库中。

3、执行器 executors: 执行器是将任务提交到线程池或进程池中运行,当任务完成时,执行器通知调度器触发相应的事件。

4、调度器 schedulers: 把上方三个组件作为参数,通过创建调度器实例来运行

根据开发需求选择相应的组件,下面是不同的调度器组件:

BlockingScheduler 阻塞式调度器:适用于只跑调度器的程序。

BackgroundScheduler 后台调度器:适用于非阻塞的情况,调度器会在后台独立运行。

AsyncIOScheduler AsyncIO调度器,适用于应用使用AsnycIO的情况。

GeventScheduler Gevent调度器,适用于应用通过Gevent的情况。

TornadoScheduler Tornado调度器,适用于构建Tornado应用。

TwistedScheduler Twisted调度器,适用于构建Twisted应用。

QtScheduler Qt调度器,适用于构建Qt应用。

三、使用步骤

1、新建一个调度器schedulers

2、添加调度任务

3、运行调度任务

四、使用实例

1、触发器date

特定的时间点触发,只执行一次。参数如下:

参数说明

run_date (datetime 或 str)作业的运行日期或时间

timezone (datetime.tzinfo 或 str)指定时区

from datetime import datetime

from datetime import date

from apscheduler.schedulers.blocking import BlockingScheduler

def job(text):   

    print(text)

scheduler = BlockingScheduler()

# 在 2019-8-30 运行一次 job 方法

scheduler.add_job(job, 'date', run_date=date(2019, 8, 30), args=['text1'])

# 在 2019-8-30 01:00:00 运行一次 job 方法

scheduler.add_job(job, 'date', run_date=datetime(2019, 8, 30, 1, 0, 0), args=['text2'])

# 在 2019-8-30 01:00:01 运行一次 job 方法

scheduler.add_job(job, 'date', run_date='2019-8-30 01:00:00', args=['text3'])

scheduler.start()

2、触发器interval

固定时间间隔触发。参数如下:

参数说明

weeks (int)间隔几周

days (int)间隔几天

hours (int)间隔几小时

minutes (int)间隔几分钟

seconds (int)间隔多少秒

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()

# 每隔 1分钟 运行一次 job 方法

scheduler.add_job(job, 'interval', minutes=1, args=['job1'])

# 在 2019-08-29 22:15:00至2019-08-29 22:17:00期间,每隔1分30秒 运行一次 job 方法

scheduler.add_job(job, 'interval', minutes=1, seconds = 30, start_date='2019-08-29 22:15:00', end_date='2019-08-29 22:17:00', args=['job2'])

scheduler.start()

'''

运行结果:

job2 --- 2019-08-29 22:15:00

job1 --- 2019-08-29 22:15:46

job2 --- 2019-08-29 22:16:30

job1 --- 2019-08-29 22:16:46

job1 --- 2019-08-29 22:17:46

...余下省略...

'''

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()

'''

运行结果:

job1 --- 2019-08-29 22:25:00

job2 --- 2019-08-29 22:25:00

job1 --- 2019-08-29 22:26:00

job1 --- 2019-08-29 22:27:00

...余下省略...

'''

4、通过装饰器scheduled_job()添加方法

 添加任务的方法有两种:

(1)通过调用add_job()---见上面1至3代码

(2)通过装饰器scheduled_job():

第一种方法是最常用的方法。第二种方法主要是方便地声明在应用程序运行时不会更改的任务。该 add_job()方法返回一个apscheduler.job.Job实例,可以使用该实例稍后修改或删除该任务。

import time

from apscheduler.schedulers.blocking import BlockingScheduler

scheduler = BlockingScheduler()

@scheduler.scheduled_job('interval', seconds=5)

def job1():   

    t = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))

    print('job1 --- {}'.format(t))

@scheduler.scheduled_job('cron', second='*/7')

def job2():   

    t = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))

    print('job2 --- {}'.format(t))

scheduler.start()

'''

运行结果:

job2 --- 2019-08-29 22:36:35

job1 --- 2019-08-29 22:36:37

job2 --- 2019-08-29 22:36:42

job1 --- 2019-08-29 22:36:42

job1 --- 2019-08-29 22:36:47

job2 --- 2019-08-29 22:36:49

...余下省略...

'''

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,186评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,858评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,620评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,888评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,009评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,149评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,204评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,956评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,385评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,698评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,863评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,544评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,185评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,899评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,141评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,684评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,750评论 2 351

推荐阅读更多精彩内容