网站建设咨询有客诚信网站建设咨询,网站没备案可以上线吗,网站功能分析,wordpress 扫码支付介绍
APScheduler的全称是Advanced Python Scheduler。它是一个轻量级的 Python 定时任务调度框架。APScheduler 支持三种调度任务#xff1a;固定时间间隔#xff0c;固定时间点#xff08;日期#xff09;#xff0c;Linux 下的 Crontab 命令。同时#xff0c;它还支持…介绍
APScheduler的全称是Advanced Python Scheduler。它是一个轻量级的 Python 定时任务调度框架。APScheduler 支持三种调度任务固定时间间隔固定时间点日期Linux 下的 Crontab 命令。同时它还支持异步执行、后台执行调度任务。
APScheduler基于Quartz的一个Python定时任务框架实现了Quartz的所有功能使用起来十分方便。
安装
pip install apscheduler官方地址
https://apscheduler.readthedocs.io/en/latest/userguide.html#starting-the-scheduler
基本概念
1.APScheduler四大组件 触发器 triggers 用于设定触发任务的条件 任务储存器 job stores用于存放任务把任务存放在内存或数据库中 执行器 executors 用于执行任务可以设定执行模式为单线程或线程池 调度器 schedulers 把上方三个组件作为参数通过创建调度器实例来运行
1.1 触发器triggers
触发器包含调度逻辑。每个任务都有自己的触发器用于确定何时应该运行作业。除了初始配置之外触发器完全是无状态的。
1.2 任务储存器 job stores
默认情况下任务存放在内存中。也可以配置存放在不同类型的数据库中。如果任务存放在数据库中那么任务的存取有一个序列化和反序列化的过程同时修改和搜索任务的功能也是由任务储存器实现。
注意一个任务储存器不要共享给多个调度器否则会导致状态混乱
1.3 执行器 executors
任务会被执行器放入线程池或进程池去执行执行完毕后执行器会通知调度器。
1.4 调度器 schedulers
一个调度器由上方三个组件构成一般来说一个程序只要有一个调度器就可以了。开发者也不必直接操作任务储存器、执行器以及触发器因为调度器提供了统一的接口通过调度器就可以操作组件比如任务的增删改查。
调度器工作流程
2. 调度器组件详解
根据开发需求选择相应的组件下面是不同的调度器组件
BlockingScheduler 阻塞式调度器适用于只跑调度器的程序。BackgroundScheduler 后台调度器适用于非阻塞的情况调度器会在后台独立运行。AsyncIOScheduler AsyncIO调度器适用于应用使用AsnycIO的情况。GeventScheduler Gevent调度器适用于应用通过Gevent的情况。TornadoScheduler Tornado调度器适用于构建Tornado应用。TwistedScheduler Twisted调度器适用于构建Twisted应用。QtScheduler Qt调度器适用于构建Qt应用。
2.1 任务储存器的选择
要看任务是否需要持久化。如果你运行的任务是无状态的选择默认任务储存器MemoryJobStore就可以应付。但是如果你需要在程序关闭或重启时保存任务的状态那么就要选择持久化的任务储存器。如果作者推荐使用SQLAlchemyJobStore并搭配PostgreSQL作为后台数据库。这个方案可以提供强大的数据整合与保护功能。
2.2 执行器的选择
同样要看你的实际需求。默认的ThreadPoolExecutor线程池执行器方案可以满足大部分需求。如果你的程序是计算密集型的那么最好用ProcessPoolExecutor进程池执行器方案来充分利用多核算力。也可以将ProcessPoolExecutor作为第二执行器混合使用两种不同的执行器。
配置一个任务就要设置一个任务触发器。触发器可以设定任务运行的周期、次数和时间。
3. APScheduler有三种内置的触发器
date 日期触发任务运行的具体日期interval 间隔触发任务运行的时间间隔cron 周期触发任务运行的周期calendarinterval当您想要在一天中的特定时间以日历为基础的间隔运行任务时使用
一个任务也可以设定多种触发器比如可以设定同时满足所有触发器条件而触发或者满足一项即触发。
3.0 触发器代码示例
date 是最基本的一种调度作业任务只会执行一次。它表示特定的时间点触发。它的参数如下
run_date(datetime or str):任务运行的日期或者时间timezone(datetime.tzinfo or str):指定时区
from datetime import date
from apscheduler.schedulers.blocking import BlockingSchedulerscheduler BlockingScheduler()
def my_job(text):print(text)# 注意run_date参数可以是date类型、datetime类型或文本类型。
# 在2019年4月15日执行
scheduler.add_job(my_job, date, run_datedate(2019, 4, 15), args[测试任务])
# datetime类型用于精确时间
# scheduler.add_job(my_job, date, run_datedatetime(2019, 4, 15, 17, 30, 5), args[测试任务])
# 字符串
#scheduler.add_job(my_job, date, run_date2009-11-06 16:30:05, args[测试任务])scheduler.start()3.2 interval 周期触发任务
固定时间间隔触发。interval 间隔调度参数如下
weeks(int)间隔几周days(int)间隔几天hours(int)间隔几小时minutes(int)间隔几分钟seconds(int)间隔多少秒start_date(datetime or str)开始日期end_date(datetime or str)结束日期timezone(datetime.tzinfo or str)时区
from datetime import datetime
from apscheduler.schedulers.blocking import BlockingSchedulerdef job_func():print(当前时间, datetime.datetime.utcnow().strftime(%Y-%m-%d %H:%M:%S.%f)scheduler BlockingScheduler()# 每2小时触发
scheduler.add_job(job_func, interval, hours2)# 在 2019-04-15 17:00:00 ~ 2019-12-31 24:00:00 之间, 每隔两分钟执行一次 job_func 方法
scheduler .add_job(job_func, interval, minutes2, start_date2019-04-15 17:00:00 , end_date2019-12-31 24:00:00)# jitter振动参数给每次触发添加一个随机浮动秒数一般适用于多服务器避免同时运行造成服务拥堵。
scheduler.add_job(job_func, interval, hours1, jitter120)scheduler.start()3.3 cron 触发器
在特定时间周期性地触发和Linux crontab格式兼容。它是功能最强大的触发器。
year(int or str) 年4位数字month(int or str) 月范围1-12day(int or str) 日范围1-31week(int or str) 周范围1-53day_of_week(int or str) 周内第几天或者星期几范围0-6或者mon,tue,wed,thu,fri,stat,sunhour(int or str) 时0-23minute(int or str) 分0-59second(int or str) 秒0-59start_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 BackgroundSchedulerdef job_func(text):print(当前时间, datetime.datetime.utcnow().strftime(%Y-%m-%d %H:%M:%S.%f)[:-3])scheduler BackgroundScheduler()
# 在每年 1-3、7-9 月份中的每个星期一、二中的 00:00, 01:00, 02:00 和 03:00 执行 job_func 任务
scheduler.add_job(job_func, cron, month1-3,7-9,day0, tue, hour0-3)scheduler.start()使用 scheduled_job() 装饰器添加任务
scheduler.scheduled_job(cron, idmy_job_id, daylast sun)
def some_decorated_task():print(I am printed at 00:00:00 on the last Sunday of every month!)注意夏令时问题
有些timezone时区可能会有夏令时的问题。这个可能导致令时切换时任务不执行或任务执行两次。避免这个问题可以使用UTC时间或提前预知并规划好执行的问题。
pri# 在Europe/Helsinki时区, 在三月最后一个周一就不会触发在十月最后一个周一会触发两次
scheduler.add_job(job_function, cron, hour3, minute30)4. 配置调度程序
APScheduler提供了许多不同的方法来配置调度程序。您可以使用配置字典也可以将选项作为关键字参数传递。您还可以先实例化调度程序然后添加任务并配置调度程序。这样您就可以在任何环境中获得最大的灵活性
可以在BaseScheduler类的API引用中找到调度程序级别配置选项的完整列表 。调度程序子类还可以具有其各自API引用中记录的其他选项。各个任务存储和执行程序的配置选项同样可以在其API参考页面上找到。
假设您希望在应用程序中使用默认作业存储和默认执行程序运行BackgroundScheduler
from apscheduler.schedulers.background import BackgroundSchedulerscheduler BackgroundScheduler()这将为您提供一个BackgroundScheduler其MemoryJobStore内存任务储存器名为“default”ThreadPoolExecutor线程池执行器名为“default”默认最大线程数为10。
假如你现在有这样的需求两个任务储存器分别搭配两个执行器同时还要修改任务的默认参数最后还要改时区。可以参考下面例子它们是完全等价的。
名称为“mongo”的MongoDBJobStore名称为“default”的SQLAlchemyJobStore名称为“ThreadPoolExecutor ”的ThreadPoolExecutor最大线程20个名称“processpool”的ProcessPoolExecutor最大进程5个UTC时间作为调度器的时区默认为新任务关闭合并模式设置新任务的默认最大实例数为3
方法一
from pytz import utcfrom apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.jobstores.mongodb import MongoDBJobStore
from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
from apscheduler.executors.pool import ThreadPoolExecutor, ProcessPoolExecutorjobstores {mongo: MongoDBJobStore(),default: SQLAlchemyJobStore(urlsqlite:///jobs.sqlite)
}
executors {default: ThreadPoolExecutor(20),processpool: ProcessPoolExecutor(5)
}
job_defaults {coalesce: False,max_instances: 3
}
scheduler BackgroundScheduler(jobstoresjobstores, executorsexecutors, job_defaultsjob_defaults, timezoneutc)方法二
from apscheduler.schedulers.background import BackgroundScheduler# The apscheduler. prefix is hard coded
scheduler BackgroundScheduler({apscheduler.jobstores.mongo: {type: mongodb},apscheduler.jobstores.default: {type: sqlalchemy,url: sqlite:///jobs.sqlite},apscheduler.executors.default: {class: apscheduler.executors.pool:ThreadPoolExecutor,max_workers: 20},apscheduler.executors.processpool: {type: processpool,max_workers: 5},apscheduler.job_defaults.coalesce: false,apscheduler.job_defaults.max_instances: 3,apscheduler.timezone: UTC,
})方法三
from pytz import utcfrom apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
from apscheduler.executors.pool import ProcessPoolExecutorjobstores {mongo: {type: mongodb},default: SQLAlchemyJobStore(urlsqlite:///jobs.sqlite)
}
executors {default: {type: threadpool, max_workers: 20},processpool: ProcessPoolExecutor(max_workers5)
}
job_defaults {coalesce: False,max_instances: 3
}
scheduler BackgroundScheduler()# ..这里可以添加任务scheduler.configure(jobstoresjobstores, executorsexecutors, job_defaultsjob_defaults, timezoneutc)启动调度器
启动调度器是只需调用start()即可。除了BlockingScheduler非阻塞调度器都会立即返回可以继续运行之后的代码比如添加任务等。
对于BlockingScheduler程序则会阻塞在start()位置所以要运行的代码必须写在start()之前。
注意:调度器启动后就不可以修改配置。
5. 添加任务
添加任务方法有两种
通过调用add_job()通过装饰器scheduled_job()
5.1 利弊
第一种方法是最常用的第二种方法是最方便的但缺点就是运行时不能修改任务。第一种add_job()方法会返回一个apscheduler.job.Job实例这样就可以在运行时修改或删除任务。
在任何时候你都能配置任务。但是如果调度器还没有启动此时添加任务那么任务就处于一个暂存的状态。只有当调度器启动时才会开始计算下次运行时间。
还有一点要注意如果你的执行器或任务储存器是会序列化任务的那么这些任务就必须符合
回调函数必须全局可用回调函数参数必须也是可以被序列化的 重要提醒 如果在程序初始化时是从数据库读取任务的那么必须为每个任务定义一个明确的ID并且使用replace_existingTrue否则每次重启程序你都会得到一份新的任务拷贝也就意味着任务的状态不会保存。 内置任务储存器中只有MemoryJobStore不会序列化任务内置执行器中只有ProcessPoolExecutor会序列化任务。 建议如果想要立刻运行任务可以在添加任务时省略trigger参数
6. 移除任务
如果想从调度器移除一个任务那么你就要从相应的任务储存器中移除它这样才算移除了。有两种方式
调用remove_job()参数为任务ID任务储存器名称在通过add_job()创建的任务实例上调用remove()方法
第二种方式更方便但前提必须在创建任务实例时实例被保存在变量中。对于通过scheduled_job()创建的任务只能选择第一种方式。
当任务调度结束时比如某个任务的触发器不再产生下次运行的时间任务就会自动移除。
job scheduler.add_job(myfunc, interval, minutes2)
job.remove()# 同样通过任务的具体ID
scheduler.add_job(myfunc, interval, minutes2, idmy_job_id)
scheduler.remove_job(my_job_id)7. 暂停和恢复任务
通过任务实例或调度器就能暂停和恢复任务。如果一个任务被暂停了那么该任务的下一次运行时间就会被移除。在恢复任务前运行次数计数也不会被统计。
暂停任务有以下两个方法
apscheduler.job.Job.pause()apscheduler.schedulers.base.BaseScheduler.pause_job()
恢复任务
apscheduler.job.Job.resume()apscheduler.schedulers.base.BaseScheduler.resume_job()
8. 获取任务列表
通过get_jobs()就可以获得一个可修改的任务列表。get_jobs()第二个参数可以指定任务储存器名称那么就会获得对应任务储存器的任务列表。
print_jobs()可以快速打印格式化的任务列表包含触发器下次运行时间等信息。
修改任务
通过apscheduler.job.Job.modify()或modify_job()你可以修改任务当中除了id的任何属性。
比如
job.modify(max_instances6, nameAlternate name)如果想要重新调度任务就是改变触发器你能通过apscheduler.job.Job.reschedule()或reschedule_job()来实现。这些方法会重新创建触发器并重新计算下次运行时间。
比如
scheduler.reschedule_job(my_job_id, triggercron, minute*/5)9. 关闭调度器
scheduler.shutdown()默认情况下调度器会先把正在执行的任务处理完再关闭任务储存器和执行器。但是如果你就直接关闭你可以添加参数
scheduler.shutdown(waitFalse)上述方法不管有没有任务在执行会强制关闭调度器。
10. 暂停、恢复任务进程
# 暂停正在执行的任务
scheduler.pause()# 恢复任务
scheduler.resume()# 也可以在调度器启动时默认所有任务设为暂停状态。
scheduler.start(pausedTrue)
