基于Python的 APScheduler 的简单使用

一. 安装APScheduler

官方API文档

pip install apscheduler

二. 基本概念

APScheduler的四大组件:

  • 触发器triggers: 用于设定触发任务的条件
  • 任务存储器job stores: 用于存放任务,吧任务存放在内存或数据库中
  • 执行器 executors: 用于执行任务,可以设定执行模式为单线程或者线程池
  • 调度器 schedulers:把上方的三个组件作为参数, 通过创建调度器实例来运行

三.触发器组件

  • data 日期: 触发任务运行的具体日期
  • interval 间隔:触发任务运行的时间间隔
  • cron 周期: 触发任务运行的周期

四.调度器组件

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

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

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

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

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

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

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

五. 代码

date: 指定时间点出发任务

# 使用年月日 定时
from datetime import *
from apscheduler.schedulers.blocking import BlockingScheduler

sched = BlockingScheduler()

def temp_func(text):
    print(text)

# 在2019年11月6日执行
sched.add_job(temp_func, 'date', run_date=date(2019, 11, 6), args=['text'])

sched.start()

# 使用年月日  时分秒 定时
from datetime import *
from apscheduler.schedulers.blocking import BlockingScheduler

sched = BlockingScheduler()

def temp_func(text):
    print(text)

# 在2019年11月6日14时6分40秒执行
sched.add_job(temp_func, 'date', run_date=datetime(2019, 4, 9, 14 , 6, 40), args=['text'])

#也可以这样
#sched.add_job(temp_func, 'date', run_date='2009-11-06 16:30:05', args=['text'])

sched.start()
#如果不指定时间 就会立即执行
from datetime import *
from apscheduler.schedulers.blocking import BlockingScheduler

sched = BlockingScheduler()

def temp_func(text):
    print(text)
sched.add_job(temp_func, args=['text'])

interval周期触发任务

from datetime import datetime
from apscheduler.schedulers.blocking import BlockingScheduler

def temp_function():
    print("Hello World")

sched = BlockingScheduler()

# 每1小时触发 一次
sched.add_job(temp_function, 'interval', hours=1)
#可以设置周期的开始时间和结束时间
sched.add_job(job_function, 'interval', hours=2, start_date='2019-10-1 09:30:00', end_date='2020-06-1 11:00:00')


sched.start()

cron 强大的类crontab表达式

# 注意参数顺序
class apscheduler.triggers.cron.CronTrigger(
    year=None, 
    month=None, 
    day=None, 
    week=None, 
    day_of_week=None, 
    hour=None, 
    minute=None,
    second=None, 
    start_date=None, 
    end_date=None, 
    timezone=None, 
    jitter=None
)

month和day_of_week参数分别接受的是英语缩写jan– dec 和 mon – sun.
当省略时间参数时,在显式指定参数之前的参数会被设定为,之后的参数会被设定为最小值,week 和day_of_week的最小值为。比如,设定day=1, minute=20等同于设定year='', month='', day=1, week='', day_of_week='', hour='*', minute=20, second=0,即每个月的第一天,且当分钟到达20时就触发

表达式类型

序号 表达式 参数 类型
1 * 所有 通配符。例:minutes=*即每分钟触发
2 */a 所有 可被a整除的通配符。
3 a-b 所有 范围a-b触发。
4 a-b/c 所有 范围a-b,且可被c整除时触发。
5 xth y 第几个星期几触发。x为第几个,y为星期几。
6 last x 一个月中,最后个星期几触发。
7 last 一个月最后一天触发。
8 x,y,z 所有 组合表达式,可以组合确定值或上方的表达式。
from apscheduler.schedulers.blocking import BlockingScheduler

def temp_function():
    print "Hello World"

sched = BlockingScheduler()

# 任务会在6月、7月、8月、11月和12月的第三个周五,00:00、01:00、02:00和03:00触发
sched.add_job(temp_function, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')

sched.start()
  • start_date 和 end_date 可以用来适用时间范围
# 在2014-05-30 00:00:00前,每周一到每周五 5:30运行
sched.add_job(job_function, 'cron', day_of_week='mon-fri', hour=5, minute=30, end_date='2014-05-30')

通过装饰器来实现


from apscheduler.scheduler import BlockingScheduler


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

推荐阅读更多精彩内容