Python定时任务工具之APScheduler使用方式


Posted in Python onJuly 24, 2019

APScheduler (advanceded python scheduler)是一款Python开发的定时任务工具。

文档地址 apscheduler.readthedocs.io/en/latest/u…

特点:

  • 不依赖于Linux系统的crontab系统定时,独立运行
  • 可以 动态添加 新的定时任务,如下单后30分钟内必须支付,否则取消订单,就可以借助此工具(每下一单就要添加此订单的定时任务)
  • 对添加的定时任务可以做持久保存

1 安装

pip install apscheduler

2 组成

  • APScheduler 由以下四部分组成:
  • triggers 触发器 指定定时任务执行的时机
  • job stores 存储器 可以将定时持久存储
  • executors 执行器 在定时任务该执行时,以进程或线程方式执行任务
  • schedulers 调度器 常用的有BackgroundScheduler( 后台运行 )和BlockingScheduler( 阻塞式 )

3 使用方式

from apscheduler.schedulers.background import BlockingScheduler
#
 创建定时任务的调度器对象
scheduler = BlockingScheduler()
# 创建执行器
executors = {
 'default': ThreadPoolExecutor(20),
}
# 定义定时任务
def my_job(param1, param2): # 参数通过add_job()args传递传递过来
 print(param1) # 100
 print(param2) # python
# 向调度器中添加定时任务
scheduler.add_job(my_job, 'date', args=[100, 'python'], executors=executors)
# 启动定时任务调度器工作
scheduler.start()

4 调度器 Scheduler

负责管理定时任务

BlockingScheduler : 作为独立进程时使用

from apscheduler.schedulers.blocking import BlockingScheduler
scheduler = BlockingScheduler()
scheduler.start() # 此处程序会发生阻塞
BackgroundScheduler : 在框架程序(如Django、Flask)中使用.
from apscheduler.schedulers.background import BackgroundScheduler
scheduler = BackgroundScheduler()
scheduler.start() # 此处程序不会发生阻塞

  • AsyncIOScheduler : 当你的程序使用了asyncio的时候使用。
  • GeventScheduler : 当你的程序使用了gevent的时候使用。
  • TornadoScheduler : 当你的程序基于Tornado的时候使用。
  • TwistedScheduler : 当你的程序使用了Twisted的时候使用
  • QtScheduler : 如果你的应用是一个Qt应用的时候可以使用。

4 执行器 executors

在定时任务该执行时,以进程或线程方式执行任务

ThreadPoolExecutor
from apscheduler.executors.pool import ThreadPoolExecutor
ThreadPoolExecutor(max_workers)

使用方法

from apscheduler.executors.pool import ThreadPoolExecutor
executors = {
  'default': ThreadPoolExecutor(20) # 最多20个线程同时执行
 }
 scheduler = BackgroundScheduler(executors=executors)
ProcessPoolExecutor

from apscheduler.executors.pool import ProcessPoolExecutor
ProcessPoolExecutor(max_workers)

使用方法

from apscheduler.executors.pool import ProcessPoolExecutor
executors = {
  'default': ProcessPoolExecutor(5) # 最多5个进程同时执行
 }
scheduler = BackgroundScheduler(executors=executors)

5 触发器 Trigger

指定定时任务执行的时机。

1) date 在特定的时间日期执行

from datetime import date
# 在2019年11月6日00:00:00执行
sched.add_job(my_job, 'date', run_date=date(2019, 11, 6))
# 在2019年11月6日16:30:05
sched.add_job(my_job, 'date', run_date=datetime(2009, 11, 6, 16, 30, 5))
sched.add_job(my_job, 'date', run_date='2009-11-06 16:30:05')
# 立即执行
sched.add_job(my_job, 'date') 
sched.start()

2) interval 经过指定的时间间隔执行

weeks (int) ? number of weeks to wait
days (int) ? number of days to wait
hours (int) ? number of hours to wait
minutes (int) ? number of minutes to wait
seconds (int) ? number of seconds to wait
start_date (datetime|str) ? starting point for the interval calculation
end_date (datetime|str) ? latest possible date/time to trigger on
timezone (datetime.tzinfo|str) ? time zone to use for the date/time calculations
from datetime import datetime
# 每两小时执行一次
sched.add_job(job_function, 'interval', hours=2)
# 在2012年10月10日09:30:00 到2014年6月15日11:00:00的时间内,每两小时执行一次
sched.add_job(job_function, 'interval', hours=2, start_date='2012-10-10 09:30:00', end_date='2014-06-15 11:00:00')

3) cron 按指定的周期执行

year (int|str) ? 4-digit year

month (int|str) ? month (1-12)

day (int|str) ? day of the (1-31)

week (int|str) ? ISO week (1-53)

day_of_week (int|str) ? number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun)

hour (int|str) ? hour (0-23)

minute (int|str) ? minute (0-59)

second (int|str) ? second (0-59)

start_date (datetime|str) ? earliest possible date/time to trigger on (inclusive)

end_date (datetime|str) ? latest possible date/time to trigger on (inclusive)

timezone (datetime.tzinfo|str) ? time zone to use for the date/time calculations (defaults to scheduler timezone)

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

# 在2014年5月30日前的周一到周五的5:30执行
sched.add_job(job_function, 'cron', day_of_week='mon-fri', hour=5, minute=30, end_date='2014-05-30')

6.任务存储

MemoryJobStore 默认内存存储
MongoDBJobStore 任务保存到MongoDB
from apscheduler.jobstores.mongodb import MongoDB
JobStoreMongoDBJobStore()复制代码
RedisJobStore 任务保存到redis
from apscheduler.jobstores.redis import RedisJobStore
RedisJobStore()

7 配置方法

方法1

from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.executors.pool import ThreadPoolExecutor

executors = {
 'default': ThreadPoolExecutor(20),
}
conf = { # redis配置
 "host":127.0.0.1,
 "port":6379,
 "db":15, # 连接15号数据库
 "max_connections":10 # redis最大支持300个连接数
}
scheduler = BackgroundScheduler(executors=executors)
scheduler.add_jobstore(jobstore='redis', **conf) # 添加任务持久化存储方式,如果未安装redis可省略此步骤

方法2

from pytz import utc

from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
from apscheduler.executors.pool import ProcessPoolExecutor
executors = {
 'default': {'type': 'threadpool', 'max_workers': 20},
 'processpool': ProcessPoolExecutor(max_workers=5)
}
scheduler = BackgroundScheduler()
# .. 此处可以编写其他代码
# 使用configure方法进行配置
scheduler.configure(executors=executors)

8 启动

scheduler.start()

对于BlockingScheduler ,程序会阻塞在这,防止退出,作为独立进程时使用。(可以用来生成静态页面)

对于BackgroundScheduler,可以在应用程序中使用。不再以单独的进程使用。(如30分钟内取消订单)

9 扩展

任务管理

方式1

job = scheduler.add_job(myfunc, 'interval', minutes=2) # 添加任务
job.remove() # 删除任务
job.pause() # 暂定任务
job.resume() # 恢复任务

方式2

scheduler.add_job(myfunc, 'interval', minutes=2, id='my_job_id') # 添加任务 
scheduler.remove_job('my_job_id') # 删除任务
scheduler.pause_job('my_job_id') # 暂定任务
scheduler.resume_job('my_job_id') # 恢复任务

调整任务调度周期

job.modify(max_instances=6, name='Alternate name')
scheduler.reschedule_job('my_job_id', trigger='cron', minute='*/5')复制代码
停止APScheduler运行
scheduler.shutdown()

10 综合使用

这里提供30分钟取消订单支付的思路,可以使用Flask或者Django程序都能实现,这里是在django应用中动态的添加一个定时任务,调度器需要使用BackgroundScheduler。下面先定义执行订单取消的任务。

from apscheduler.executors.pool import ThreadPoolExecutor
from datetime import datetime, timedelta
from apscheduler.schedulers.blocking import BackgroundScheduler
from goods.models import SKU
from orders.models import OrderGoods
def cancel_order_job(order_id, sku_id, stock, sales):
 # 将订单商品和订单信息筛选出来
 order_goods = OrderGoods.objects.filter( order_id=order_id, sku_id=sku_id)
 order_goods.delete() # 删除订单
 try:
  sku = SKU.objects.get(id=sku_id)
  sku.stock += stock # 订单删掉后商品表里的库存恢复
  sku.sales -= sales # 商品表里销量还原
  sku.save()
 except Exception as e:
  print(e)

具体操作哪些表要根据自身表的设计来定,大致是上面的思路。然后在生成订单的视图中同时生成取消订单的任务。然后将取消订单cancel_order_job()需要的参数传递过去,注意要判定当前订单的状态为未支付状态。

from datetime import datetime, timedelta

class OrderCommitView(View):

 def post(self, request):
 # ... 此处省略生成订单相关逻辑
   if status == OrderInfo.STATUS.UNPADED: # 待支付状态
  
    executors = {
    'default': ThreadPoolExecutor(10) 
    }
    now = datetime.now()
    delay = now + timedelta(minutes=30) # 从当前下订单延时30分钟后
    scheduler = BackgroundScheduler(executors=executors)
    # 添加定时任务
    scheduler.add_job(cancel_order_job, 'date', run_date=delay,
    args=[order_id, sku.id, sku.stock, sku.sales])
    scheduler.start()
    # ....省略其他业务及返回

注意: 如果需要周期性的执行一个定时任务,如果用到了django中模型类或者Flask的配置信息等相关信息,需要将框架的配置信息导入。

总结

以上所述是小编给大家介绍的Python定时任务工具之APScheduler详解,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

Python 相关文章推荐
Python中装饰器的一个妙用
Feb 08 Python
在Django框架中编写Contact表单的教程
Jul 17 Python
Python+Socket实现基于UDP协议的局域网广播功能示例
Aug 31 Python
django认证系统实现自定义权限管理的方法
Jul 16 Python
pygame实现雷电游戏雏形开发
Nov 20 Python
python dict 相同key 合并value的实例
Jan 21 Python
python批量爬取下载抖音视频
Jun 17 Python
Python2.7版os.path.isdir中文路径返回false的解决方法
Jun 21 Python
python打造爬虫代理池过程解析
Aug 15 Python
Python合并2个字典成1个新字典的方法(9种)
Dec 19 Python
python通过matplotlib生成复合饼图
Feb 06 Python
python创建文本文件的简单方法
Aug 30 Python
Python实现一个带权无回置随机抽选函数的方法
Jul 24 #Python
Django的用户模块与权限系统的示例代码
Jul 24 #Python
python3字符串操作总结
Jul 24 #Python
django数据关系一对多、多对多模型、自关联的建立
Jul 24 #Python
django如何自己创建一个中间件
Jul 24 #Python
django如何通过类视图使用装饰器
Jul 24 #Python
django 类视图的使用方法详解
Jul 24 #Python
You might like
第4章 数据处理-php正则表达式-郑阿奇(续)
2011/07/04 PHP
PHP数组操作汇总 php数组的使用技巧
2011/07/17 PHP
php自动载入类用法实例分析
2016/06/24 PHP
jQuery.autocomplete 支持中文输入(firefox)修正方法
2011/03/10 Javascript
js中的setInterval和setTimeout使用实例
2014/05/09 Javascript
Jquery焦点图实例代码
2014/11/25 Javascript
使用AngularJS处理单选框和复选框的简单方法
2015/06/19 Javascript
js实现选中复选框文字变色的方法
2015/08/14 Javascript
thinkphp实现无限分类(使用递归)
2015/12/19 Javascript
在Mac OS上安装使用Node.js的项目自动化构建工具Gulp
2016/06/18 Javascript
数据结构中的各种排序方法小结(JS实现)
2016/07/23 Javascript
Vue.js鼠标悬浮更换图片功能
2017/05/17 Javascript
bootstrap Table的一些小操作
2017/11/01 Javascript
Vue拖拽组件开发实例详解
2018/05/11 Javascript
详解基于electron制作一个node压缩图片的桌面应用
2019/01/29 Javascript
解析vue、angular深度作用选择器
2019/09/11 Javascript
TypeScript高级用法的知识点汇总
2019/12/17 Javascript
从Python的源码来解析Python下的freeblock
2015/05/11 Python
Python实现朴素贝叶斯分类器的方法详解
2018/07/04 Python
python 利用pandas将arff文件转csv文件的方法
2019/02/12 Python
python使用mitmproxy抓取浏览器请求的方法
2019/07/02 Python
DAWGS鞋官方网站:鞋,凉鞋,靴子
2016/10/04 全球购物
世界排名第一的万圣节服装店:Spirit Halloween
2018/10/16 全球购物
国际贸易专业个人求职信格式
2014/02/02 职场文书
质量承诺书格式
2014/05/20 职场文书
人力资源管理专业自荐信
2014/06/24 职场文书
普通党员四风问题对照检查材料
2014/09/27 职场文书
给老婆的保证书
2015/01/16 职场文书
2015年纪念“卢沟桥事变”78周年活动方案
2015/05/06 职场文书
Python编写可视化界面的全过程(Python+PyCharm+PyQt)
2021/05/17 Python
Javascript设计模式之原型模式详细
2021/10/05 Javascript
详解Python如何批量采集京东商品数据流程
2022/01/22 Python
Go语言读取txt文档的操作方法
2022/01/22 Golang
Github 使用python对copilot做些简单使用测试
2022/04/14 Python
Redis高并发缓存架构性能优化
2022/05/15 Redis
Redis sentinel哨兵集群的实现步骤
2022/07/15 Redis