APScheduler任务调度框架

APScheduler的全称是Advanced Python Scheduler,它是一个轻量级的 Python 定时任务调度框架,APScheduler 支持三种调度任务：固定时间间隔，固定时间点（日期），Linux 下的 Crontab 命令;同时，它还支持异步执行、后台执行调度任务。

1. APScheduler四大组件：

• 触发器 triggers:用于设定触发任务的条件

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

触发器的选择:

配置一个任务,就要设置一个任务触发器;触发器可以设定任务运行的周期,次数和时间.

有三种内置的触发器：

• date 日期：触发任务运行的具体日期

• interval 间隔：触发任务运行的时间间隔

• cron 周期：触发任务运行的周期

• calendarinterval：当您想要在一天中的特定时间以日历为基础的间隔运行任务时使用

一个任务也可以设定多种触发器,比如,可以设定同时满足所有触发器条件而触发，,或者满足一项即触发.

• 任务储存器 job stores:用于存放任务,把任务存放在内存或数据库中

默认情况下,任务存放在内存中,也可以配置存放在不同类型的数据库中;如果任务存放在数据库中,那么任务的存取就有一个序列化和反序列化的过程,同时修改和搜索任务的功能也是由任务储存器实现.

注意一个任务储存器不要共享给多个调度器,否则会导致状态混乱.

任务存储器的选择:

要看任务是否需要持久化,如果你运行的任务是无状态的,选择默认任务储存器MemoryJobStore就可以应付.但是,如果你需要在程序关闭或重启时,保存任务的状态,那么就要选择持久化的任务储存器.推荐使用SQLAlchemyJobStore并搭配PostgreSQL作为后台数据库,这个方案可以提供强大的数据整合与保护功能.

• 执行器 executors:用于执行任务,可以设定执行模式为单线程或线程池

任务会被执行器放入线程池或进程池去执行,执行完毕后,执行器会通知调度器.

执行器的选择:

默认的ThreadPoolExecutor线程池执行器方案可以满足大部分需求;如果程序是计算密集型的,那么最好用ProcessPoolExecutor进程池执行器方案来充分利用多核算力;也可以将ProcessPoolExecutor作为第二执行器,混合使用两种不同的执行器.

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

一个调度器由上方三个组件构成,一般来说,一个程序只要有一个调度器就可以了;开发者也不必直接操作任务储存器、执行器以及触发器,因为调度器提供了统一的接口,通过调度器就可以操作组件,比如任务的增删改查.

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

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

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

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

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

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

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

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

2.APScheduler使用:

2.1安装:

pip3 install apscheduler

2.2 interval触发器:

固定时间间隔触发

import datetime
from apscheduler.schedulers.blocking import BlockingScheduler


def task_1(name):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(f"My Name Is {name}")


if __name__ == '__main__':
    # 实例化选择一个调度器
    scheduler = BlockingScheduler()  # BlockingScheduler为阻塞式调度器
    # 在2023年3月14日执行
    scheduler.add_job(task_1, 'interval', seconds=10, args=['春田'])
    scheduler.start()

2.3 cron触发器:

在特定时间周期性地触发,和Linux crontab格式兼容,它是功能最强大的触发器.

cron 参数：

参数	说明
year(int or str)	年，4位数字
month(int or str)	月（范围1-12）
day(int or str)	日（范围1-31）
week(int or str)	周（范围1-53）
day_of_week(int or str)	周内第几天或者星期几（范围0-6或者mon,tue,wed,thu,fri,stat,sun）
hour(int or str)	时（0-23）
minute(int or str)	分（0-59）
second(int or str)	秒（0-59）
start_date(datetime or str)	最早开始日期（含）
end_date(datetime or str)	最晚结束日期（含）
timezone(datetime.tzinfo or str)	指定时区

表达式类型

表达式	参数类型	描述
*	所有	通配符。例：minutes=*即每分钟触发
*/a	所有	可被a整除的通配符。
a-b	所有	范围a-b触发
a-b/c	所有	范围a-b，且可被c整除时触发
xth y	日	第几个星期几触发。x为第几个，y为星期几
last x	日	一个月中，最后个星期几触发
last	日	一个月最后一天触发
x,y,z	所有	组合表达式，可以组合确定值或上方的表达式

注意：month和day_of_week参数分别接受的是英语缩写jan– dec 和 mon – sun

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


def task_1(name):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(f"My Name Is {name}")


if __name__ == '__main__':
    # 实例化选择一个调度器
    # scheduler = BackgroundScheduler()  #  后台调度器：适用于非阻塞的情况，调度器会在后台独立运行
    scheduler = BlockingScheduler()  # 阻塞调度器
    # 在2023年每个月的每天的21点53分的00秒，10秒，20秒各执行一次
    scheduler.add_job(task_1, 'cron', month='1-12', day='1-31', hour='21-22', minute=53, second="0,10,20", args=['春田'])
    scheduler.start()

3. 使用 scheduled_job() 装饰器添加任务

import datetime

from apscheduler.schedulers.blocking import BlockingScheduler

# 实例化选择一个调度器
scheduler = BlockingScheduler()  # BlockingScheduler为阻塞式调度器


@scheduler.scheduled_job('interval', seconds=10, args=['春田'])  # 每10s执行一次
def task_1(name):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(f"task_1 says: My Name Is {name}")


@scheduler.scheduled_job('cron', second='*/3', args=['5'])  # 每3s执行一次
def task_2(age):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(f"task_2 says:I am {age} years old")


if __name__ == '__main__':
    scheduler.start()

4. 添加任务

添加任务方法有两种：

4.1 通过调用add_job()

add_job()最常用,方法会返回一个apscheduler.job.Job实例,这样就可以在运行时,修改或删除任务.

4.2通过装饰器scheduled_job()

最方便,但缺点就是运行时,不能修改任务

5.移除任务

5.1通过add_job()创建的任务实例上调用remove()方法

        job = scheduler.add_job(func_name, 'interval', second=12)
        job.remove()

5.2调用remove_job()，参数为：任务ID，任务储存器名称

import datetime
import time

from apscheduler.schedulers.blocking import BlockingScheduler

# 实例化选择一个调度器
scheduler = BlockingScheduler()  # BlockingScheduler为阻塞式调度器


@scheduler.scheduled_job('interval', seconds=10, args=['春田'], id="task_add")  # 每10s执行一次
def task_add(name):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(f"task_1 says: My Name Is {name}")


@scheduler.scheduled_job('cron', second='*/3', args=['5'], id="task_2")  # 每3s执行一次
def task_two(age):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(f"task_2 says:I am {age} years old")


def task_remove(text):
    print("当前时间：", datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M:%S.%f"))
    print(text)
    scheduler.remove_job('task_2')


if __name__ == '__main__':
    scheduler.add_job(task_remove, args=('*****删除任务*****',),
                      next_run_time=datetime.datetime.now() + datetime.timedelta(seconds=12),
                      id="delete_task")
    scheduler.start()
    time.sleep(11)
    print("开始移除task_2的任务")
    scheduler.remove_job("task_2")

6.暂停和恢复任务(原理同移除任务)

通过任务实例或调度器,就能暂停和恢复任务;如果一个任务被暂停了,那么该任务的下一次运行时间就会被移除;在恢复任务前,运行次数计数也不会被统计.

6.1 暂停任务

6.1.1 通过apscheduler.job.Job.pause()

6.1.2 通过apscheduler.schedulers.base.BaseScheduler.pause_job()

6.2 恢复任务

6.2.1 通过apscheduler.job.Job.resume()

6.2.2 通过apscheduler.schedulers.base.BaseScheduler.resume_job()

7.获取任务列表

7.1 get_jobs()

通过get_jobs()就可以获得一个可修改的任务列表;get_jobs()第二个参数可以指定任务储存器名称,那么就会获得对应任务储存器的任务列表

7.2 print_jobs()

print_jobs()可以快速打印格式化的任务列表,包含触发器,下次运行时间等信息.

8.修改任务

可以修改任务当中除了id的任何属性

8.1通过apscheduler.job.Job.modify()

8.2通过modify_job()

job.modify(max_instances=6, name='Alternate name')

9.重新调度任务（就是改变触发器)

重新创建触发器，并重新计算下次运行时间。

9.1 通过apscheduler.job.Job.reschedule()

9.2 通过reschedule_job()

scheduler.reschedule_job('my_job_id', trigger='cron', minute='*/5')

10.关闭调度器

10.1 通过scheduler.shutdown()

10.2 scheduler.shutdown(wait=False)

默认情况下，调度器会先把正在执行的任务处理完，再关闭任务储存器和执行器;但是，如果想直接关闭，你可以添加参数wait=False,这样,不管有没有任务在执行，会强制关闭调度器。

11.暂停、恢复任务进程

11.1 暂停任务进程scheduler.pause()

11.2恢复任务进程scheduler.resume()

11.3 调度器启动时,默认所有任务设为暂停状态scheduler.start(paused=True)