备案控制台
开发者社区 开发与运维 文章 正文

Python----使用apscheduler模块设置定时任务

2022-05-25 1089
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Python----使用apscheduler模块设置定时任务

【原文链接】

一、安装

pip install apscheduler

二、ApScheduler 简介

1 APScheduler的组件

  • triggers：触发器

triggers包含任务执行的调度逻辑，决定任务按照什么逻辑进行定时执行

  • job stores；任务存储器

存储了调度任务

  • executors：执行器

用例执行任务的，包含线程池以及进程池等的创建和调用等等

  • schedulers：调度器

属于控制面，将其他几个方面组织起来的作用、

2 调度器的种类

调度器有以下几种常见类型，其中最常用的BackgroundScheduler，即非阻塞式，因为在一般情况下，定时任务都会在放到web服务中，如果使用阻塞式，则无法启动web服务，而使用非阻塞式，则将定时任务设定后，就不管了，继续执行后面的web服务，只要web服务在运行，定时任务就是一直有效的

  • BlockingScheduler: 阻塞式
  • BackgroundScheduler: 非阻塞式（后台运行）
  • AsyncIOScheduler: 当使用asyncio模块时使用
  • GeventScheduler: 当使用gevent模块时使用
  • TornadoScheduler: 构建Tornado应用时使用
  • TwistedScheduler: 构建Twisted应用时使用
  • QtScheduler: 构建Qt应用时使用

3 内置的触发器类型

  • date: 在某个时间点执行一次时使用
  • interval: 固定的时间间隔循环执行时使用
  • cron: 在一天中特定的时间点执行时使用
  • calendarinterval: 当想在在一天中特定时间点或以日历为基础的时间间隔内执行时使用

三、使用举例

这里jiu就以非阻塞式BackgroundScheduler调度器为例展开

1 使用date类型的触发器

如下，使用了三种设置日期和时间的方法

from apscheduler.schedulers.background import BackgroundScheduler
import time
from datetime import date
from datetime import datetime


def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

def main():
    print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
    sched=BackgroundScheduler()

    # 通过date 设置指定日期执行
    sched.add_job(do_func,trigger="date",run_date=date(2022,5,25),args=("张三丰",100))

    # 通过datetime，设置指定日期额指定时刻执行
    sched.add_job(do_func, trigger="date", run_date=datetime(2022, 5, 25,14,0,10), args=("张三丰", 100))

    # 直接使用文本的方式指定日期和时刻表
    sched.add_job(do_func, trigger="date", run_date="2022-05-25 14:0:20", args=("张三丰", 100))

    sched.start()

if __name__=="__main__":
    main()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

执行结果如下,可以发现，第一个通过date指定日期的默认是0点执行，显然时间已经过了，不会执行，第二和第三个则在规定的时间点执行了，这里还需要注意的是，通过打印可以看出，main函数执行完成后，已经开始执行main函数下面的while循环打印语句了，而在执行循环的过程中，定时任务仍然生效，这就是非阻塞式调度器的原理，如果是阻塞式，则在此代码中，会一直卡在main函数中，main下面额while循环语句是不会执行的，因此在实际使用中，非阻塞式应用的是非常多的

2022-05-25 14:00:02
2022-05-25 14:00:02
C:\Users\hitre\.virtualenvs\zentaolinkgitlab-QCS5yxD9\lib\site-packages\apscheduler\util.py:436: PytzUsageWarning: The localize method is no longer necessary, as this time zone supports the fold attribute (PEP 495). For more details on migrating to a PEP 495-compliant implementation, see https://pytz-deprecation-shim.readthedocs.io/en/latest/migration.html
  return tzinfo.localize(dt)
Run time of job "do_func (trigger: date[2022-05-25 00:00:00 CST], next run at: 2022-05-25 00:00:00 CST)" was missed by 14:00:02.088260
2022-05-25 14:00:03
2022-05-25 14:00:04
2022-05-25 14:00:05
2022-05-25 14:00:06
2022-05-25 14:00:07
2022-05-25 14:00:08
2022-05-25 14:00:09
2022-05-25 14:00:10 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:00:10
2022-05-25 14:00:11
2022-05-25 14:00:12
2022-05-25 14:00:13
2022-05-25 14:00:14
2022-05-25 14:00:15
2022-05-25 14:00:16
2022-05-25 14:00:17
2022-05-25 14:00:18
2022-05-25 14:00:19
2022-05-25 14:00:20 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:00:20
2022-05-25 14:00:21
2022-05-25 14:00:22

2 使用interval类型的触发器

如下代码演示了时间间隔循环执行的使用例子

from apscheduler.schedulers.background import BackgroundScheduler
import time
from datetime import date
from datetime import datetime


def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

def main():
    print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
    sched=BackgroundScheduler()

    # 每3秒执行一次
    sched.add_job(do_func,trigger="interval",args=("张三丰",100),seconds=3)
    # 每3分钟执行一次
    sched.add_job(do_func, trigger="interval", args=("张三丰", 100), minutes=3)
    # 每3小时执行一次
    sched.add_job(do_func, trigger="interval", args=("张三丰", 100), hours=3)
    # 每3天执行一次
    sched.add_job(do_func, trigger="interval", args=("张三丰", 100), days=3)
    # 每3周执行一次
    sched.add_job(do_func, trigger="interval", args=("张三丰", 100), weeks=3)

    sched.start()

if __name__=="__main__":
    main()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

上面的代码中因为时间跨度比较大，这里只演示妹3秒执行一次的代码
代码如下：

from apscheduler.schedulers.background import BackgroundScheduler
import time
from datetime import date
from datetime import datetime


def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

def main():
    print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
    sched=BackgroundScheduler()

    # 每3秒执行一次
    sched.add_job(do_func,trigger="interval",args=("张三丰",100),seconds=3)

    sched.start()

if __name__=="__main__":
    main()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

执行结果如下：

2022-05-25 14:14:04
2022-05-25 14:14:04
2022-05-25 14:14:05
2022-05-25 14:14:06
2022-05-25 14:14:07 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:14:07
2022-05-25 14:14:08
2022-05-25 14:14:09
2022-05-25 14:14:10 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:14:10
2022-05-25 14:14:11
2022-05-25 14:14:12
2022-05-25 14:14:13 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:14:13

3 使用cron类型的触发器

cron的触发器有点类似linux上crontab定时器的使用，代码如下：

from apscheduler.schedulers.background import BackgroundScheduler
import time
from datetime import date
from datetime import datetime


def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

def main():
    print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
    sched=BackgroundScheduler()

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

    sched.start()

if __name__=="__main__":
    main()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

这里需要注意的是，可以省略不需要的字段。当省略时间参数时，在显式指定参数之前的参数会被设定为，之后的参数会被设定为最小值，week 和day_of_week的最小值为

day=1, minute=20
等同于
year='*', month='*', day=1, week='*', day_of_week='*', hour='*', minute=20, second=0

此外，也可以直接使用crontab表达式，如下：

from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.triggers.cron import CronTrigger
import time
from datetime import date
from datetime import datetime


def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

def main():
    print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
    sched=BackgroundScheduler()

    # 任务会在6月、7月、8月、11月和12月的第三个周五，00:00、01:00、02:00和03:00触发
    sched.add_job(do_func,trigger=CronTrigger.from_crontab('48 10 1-15 sep-nov *'),args=("张三丰",100))

    sched.start()

if __name__=="__main__":
    main()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

四、定时器使用装饰器的方法

以间隔时间循环执行的代码为例，如下为未使用装饰器的方式

from apscheduler.schedulers.background import BackgroundScheduler
import time
from datetime import date
from datetime import datetime


def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

def main():
    print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
    sched=BackgroundScheduler()

    # 每3秒执行一次
    sched.add_job(do_func,trigger="interval",args=("张三丰",100),seconds=3)

    sched.start()

if __name__=="__main__":
    main()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

修改为使用装饰器的方式如下：

from apscheduler.schedulers.background import BackgroundScheduler
import time

sched=BackgroundScheduler()

@sched.scheduled_job(trigger="interval",args=("张三丰",100),seconds=3)
def do_func(name,age):
    print(time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))+" in do func : 姓名："+name+" 年龄："+str(age))

if __name__=="__main__":
    sched.start()
    while True:
        print(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time())))
        time.sleep(1)

执行结果如下：

2022-05-25 14:34:10
2022-05-25 14:34:11
2022-05-25 14:34:12
2022-05-25 14:34:13 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:34:13
2022-05-25 14:34:14
2022-05-25 14:34:15
2022-05-25 14:34:16 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:34:16
2022-05-25 14:34:17
2022-05-25 14:34:18
2022-05-25 14:34:19 in do func : 姓名：张三丰 年龄：100
2022-05-25 14:34:19
2022-05-25 14:34:20
文章标签：
Java
Python
测试技术
Linux
调度
存储
关键词：
Python模块
Python设置
Python APScheduler
Python定时任务
Python apscheduler定时任务
redrose2100
目录
相关文章
小墨&晓末
|
2天前
|
Python
【Python进阶（五）】——模块搜索及工作目录
【Python进阶（五）】——模块搜索及工作目录
小墨&晓末
15 2
wljslmz
|
2天前
|
机器学习/深度学习 存储 Python
Python时间模块深度解析：从导入到应用，一网打尽
【4月更文挑战第21天】
wljslmz
22 1
小Lee
|
22小时前
|
Python
Python使用typing模块（从Python 3.5开始）
【5月更文挑战第10天】Python使用typing模块（从Python 3.5开始）
小Lee
12 3
东方睿赢
|
2天前
|
Python
在Python中，利用`os模块`的`path.exists()`函数可判断文件是否存
【5月更文挑战第12天】在Python中，利用`os模块`的`path.exists()`函数可判断文件是否存在，该函数对路径进行检查，存在则返回True，不存在则返回False。示例代码展示了如何检查'example.txt'文件是否存在并相应打印消息。此外，`os.path.isfile()`用于确认路径是否为文件，仅当是文件时返回True，否则返回False，同样配以示例说明其用法。
东方睿赢
23 2
陌陌谣
|
2天前
|
JSON 监控 调度
局域网管理软件的自动化任务调度：Python 中的 APScheduler 库的应用
使用 Python 的 APScheduler 库可简化局域网管理中的自动化任务调度。APScheduler 是一个轻量级定时任务调度库，支持多种触发方式如间隔、时间、日期和 Cron 表达式。示例代码展示了如何创建每 10 秒执行一次的定时任务。在局域网管理场景中，可以利用 APScheduler 定期监控设备状态，当设备离线时自动提交数据到网站，提升管理效率。
陌陌谣
27 0
toKeep
|
2天前
|
Python Windows
python中的异常与模块
python中的异常与模块
toKeep
11 1
众所周知
|
2天前
|
JSON 数据格式 Python
Python标准库中包含了json模块，可以帮助你轻松处理JSON数据
【4月更文挑战第30天】Python的json模块简化了JSON数据与Python对象之间的转换。使用`json.dumps()`可将字典转为JSON字符串，如`{"name": "John", "age": 30, "city": "New York"}`，而`json.loads()`则能将JSON字符串转回字典。通过`json.load()`从文件读取JSON数据，`json.dump()`则用于将数据写入文件。
众所周知
18 1
景天科技苑
|
2天前
|
Python
Python实现压缩解压---tarfile模块详解
Python实现压缩解压---tarfile模块详解
景天科技苑
7 0
魏红斌
|
2天前
|
弹性计算 运维 Shell
设置Python 支持自动命令补齐功能
【4月更文挑战第29天】
魏红斌
9 0
景天科技苑
|
2天前
|
Linux Python Windows
Python中time和datetime模块详解
Python中time和datetime模块详解
景天科技苑
11 3

热门文章

最新文章

  • 1
    人工智能：原理、应用与Python代码实现
  • 2
    Python小项目：利用tkinter开发测手速小游戏
  • 3
    人工智能：原理、应用与Python代码示例
  • 4
    流畅的 Python 第二版（GPT 重译）（一）(1)
  • 5
    流畅的 Python 第二版（GPT 重译）（十一）(1)
  • 6
    Python与NoSQL数据库（MongoDB、Redis等）面试问答
  • 7
    流畅的 Python 第二版（GPT 重译）（九）(2)
  • 8
    Python 多线程编程实战：threading 模块的最佳实践
  • 9
    Python计算股票投资组合的风险价值（VaR）
  • 10
    Python 读写 Excel 文件
  • 1
    Python中的装饰器：概念、用法和实例
    22
  • 2
    Python中的装饰器：概念、用法及实例
    19
  • 3
    使用Python实现图像处理中的边缘检测算法
    99
  • 4
    Python中如何实现字符串反转？请提供至少两种方法。
    26
  • 5
    在Python中，如何创建一个迭代器？
    22
  • 6
    请解释Python中的迭代器和生成器的区别？并分别举例说明。
    21
  • 7
    在Python中，如何使用装饰器重写类的方法？
    293
  • 8
    Python中的装饰器：概念、用法及实例
    20
  • 9
    Python中的装饰器：概念、应用与实例
    277
  • 10
    Python中的装饰器：概念、用法和实例
    24

    • 相关课程

    更多
  • Python Web开发基础
  • Python开发基础入门
  • Python常用数据科学库
  • Python网络爬虫实战
  • Python完全自学手册图文教程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • From Python Scikit-Learn to Sc
  • Data Pre-Processing in Python:
  • 双剑合璧-Python和大数据计算平台的结合

    • 相关实验场景

    更多
  • Python新手入门
  • Python入门
  • Python选择及循环结构
  • Python新手入门（Anolis OS）
  • Python网络通信程序典型应用
    • 下一篇
    2024年阿里云免费云服务器及学生云服务器申请教程参考