apscheduler任务存储器的选择，要看任务是否需要持久化，如果你运行的任务是无状态的，选择默认任务存储器Memor

原文链接https://www.jianshu.com/p/4f5305e220f0

安装APScheduler

pip install apscheduler

快速开始

from apscheduler.schedulers.blocking import BlockingScheduler

scheduler = BlockingScheduler()
@scheduler.scheduled_job('cron', hour='8-23')
def request_update_status():
	print('Doing job)
	
scheduler.start()

基本概念

APScheduler四大组件：

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

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

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

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

触发器

每一个任务都有自己的触发器，触发器用于决定任务下次运行的时间。

任务存储器

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

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

执行器

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

调度器

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

调度器组件详解

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

BlockingScheduler # 阻塞式调度器：适用于只跑调度器的程序。
BackgroundScheduler # 后台调度器：适用于非阻塞的情况，调度器会在后台进行独立运行
AsyncIOScheduler # AsyncIO调度器：适用于应用使用AsyncIO的情况
GeventScheduler # Gevent调度器：适用于应用通过Gevent的情况
TornadoScheduler # Tornado调度器：适用于构建Tornado的应用
TwistedScheduler # Twisted调度器：适用于构建Twisted应用
QtScheduler # QT调度器，适用于构建QT应用

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

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

配置一个任务，就要设置一个任务触发器。触发器可以设定任务运行的周期、次数和时间。APScheduler有三种内置的触发器：

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

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

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

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

触发器详解

data在指定时间点触发任务

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

sched = BlockingScheduler()
def my_job(text):
    print(text)

sched.add_job(my_job, 'date', run_date=date(2009, 11, 6), args=['text'])
sched.start()

其中run_date参数可以是date类型、datetime类型或者为本类型

datetime类型(用于精确时间)

# 在2009年11月6日 16:30:05执行
sched.add_job(my_job, 'date', run_date='2009-11-6 16:30:05', args=['text'])

文本类型

sched.add_job(my_job, 'date', run_date='2009-11-06 16:30:05', args=['text'])

未指定时间，则会立即执行

# 未显示指定时间，那么则立即执行
sched.add_job(my_job, args=['text'])

interval周期触发任务

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

def job_function():
    print("hello world")

sched = BlockingScheduler()
# 每2小时触发
sched.add_job(job_function, 'interval', hours=2)
sched.start()

你可以框定周期开始时间和结束时间

# 周期触发的时间范围在2010-10-10 9:30 至 2014-06-15 11:00
sched.add_job(job_function, 'interval', hours=2, start_date='2010-10-10 09:30:00', end_date='2014-06-15 11:00:00')

也可以通过scheduler_job()装饰器实现

@sched.scheduled_job('interval', id='my_job_id', hours=2)
def job_function():
    print("hello world")

jitter振动参数，给每次触发添加一个随机浮动秒数，一般适用于多服务器，避免同时运行造成服务拥堵

# 每小时(上下浮动120秒区间内)运行'job_function'
sched.add_job(job_function, 'interval', hours=1, jitter=120)

cron强大的类crontab表达式

class apscheduler.triggers.cron.CronTrigger(
year=None,
month=None,
dat=None,
week=None,
day_of_week=None,
hour=None,
second=None,
start_date=None,
end_date=None,
timezone=None,
jitter=None
)

当省略时间参数时，在显示指定参数之前的参数会被设定为*，之后的参数会被设定为最小值，week和day_of_week的最小值为[*]。比如，设定day=1, minute=20等同于设定year='*', month='*', day=1, week='*', day_of_weel='*', hour='*', minute=20, second=0


表达式类型
表达式			参数类型		描述
*			  所有			通配符。例：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

from apscheduler.schedulers.blocking import BlockingScheduler
def job_function():
    print("hello world")

sched = BlockingScheduler()

# 任务会在6月、7月、8月11月、12月的第三个周五，00:00、02:00和03:00触发
sched.add_job(job_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')

通过scheduler_job()来实现

@sched.scheduled_job('cron', id='my_job_id', day='last sun')
def job_function():
    print("hello world")

使用标准crontab表达式

from apscheduler.triggers.cron import CronTrigger
sched.add_job(job_function, CronTrigger.from_crontab('0 0 1-15 may-aug'))

也可以添加jitter振动参数

# 每小时上下浮动120秒触发
sched.add_job(job_function, 'cron', hour='*', jitter=120)

夏令时问题

有些timezone时区可能会有夏令时的问题，这个可能导致令时切换时，人物不执行或任务执行两次。避免这个问题，可以使用UTC时间，或提前预知并规划好执行的问题。

# 在Europe/Helsinki时区，在三月最后一个周一就不会触发；在十月最后一个周一会触发两次
sched.add_job(job_function, 'cron', hour=3, minute=30)

配置调度器

APScheduler有多种不同的配置方法，你可以选择直接串子店或参数的方式创建调度器；也可以先实例一个调度器对象，再添加配置信息。灵活的配置方式可以满足各种应用场景的需要。

整套的配置选项可以参考API文档BaseScheduler类。一些调度器子类可能有它们自己特有的配置选项，以及独立的任务存储器和执行器也可能有自己特有的配置选项个，可以查阅API文档了解

下面举一个例子，创建一个使用默认任务存储器和执行器的BackgroundScheduler:

from apscheduler.schedulers.background import BackgroundScheduler

scheduler = BackgroundScheduler()
# 因为是非阻塞的后台调度器，所以程序会继续向下执行

这样就可以创建了一个后台调度器。这个调度器有一个名称为default的MemoryJobStore(内存任务存储器)和一个名称是default且最大线程是10的ThreadPoolExecutor(线程池执行器)。

假如你现在有这样的需求，两个任务存储器分别搭配两个执行器；同时，还要修改任务的默认参数；最后还要改时区。可以参考下面例子，它们是完全等价的。

名称为"mongo"的MongoDBJobStore

名称为"defaule"的SQLAlchemyJobStore

名称为"ThreadPoolExecutor"的ThreadPoolExecutor，最大线程20个

名称为"processpool"的ProcessPoolExecutor，最大进程5个

UTC时间作为调度器的时区

默认为新任务关闭合并模式()

设置新任务的默认最大实例数为3

方法一：

启动调度器

启动调度器是只需调用start()即可。除了BlockingScheduler，非阻塞调度器都会立即返回，可以进行运行之后的代码，比如添加任务等。

对于BlockingScheduler，程序则会阻塞在start()位置，所以，要运行的代码必须卸载start()之前。

注意：调度器启动后，就不能修改配置了。

添加任务

添加任务的方法有两种：

1.通过调用add_job()

2.通过装饰器scheduler_job()

第一种方法是最常用的；第二种方法是最方便的，但缺点就是运行时，不能修改任务。

第一种add_job()方法会返回一个apscheduler.job.job实例，这样就可以在运行时，修改或删除任务。

在任何时候你都能配置任务。但是如果调度器还没有启动，此时添加任务，那么任务就处于一个暂存的状态。只有当调度器启动时，才会开始计算下次运行时间。

还有一点要注意：如果你的执行器或任务存储器是会序列化任务的，那么这些任务就必须符合：

1.回调函数必须全局可用

2.回调函数参数必须也是可以被序列化的

内置任务存储器中，只有MemoryJobStore不会序列化任务；内置执行器中，只有ProcessPoolExecutor会序列化任务

重要提醒

如果在程序初始化时，是从数据库读取任务的，那么必须为每个任务定义个明确的ID，并且使用replace_existing=True，否则每次重启程序，你都会得到一份新的任务拷贝，也就意味着任务的状态不会保存

建议

如果想要立刻运行任务，可以在添加任务时省略trigger参数

移除任务

如果想要从调度器移除一个任务，name你就要从相应的任务存储器中移除它，这样才算移除了。有两种方式：

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

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

第二种方式更方便，但前提必须在创建任务实例时，实例被保存在变量中。对于通过scheduler_job()创建的任务，只能选择第一种方式

当任务调度结束时(比如，某个任务的触发器不在产生下次运行的时间)，任务就会自动移除

job = scheduler.add_job(myfunc, 'interval', minutes=2)
job.remove()

同样，通过任务的具体ID：

scheduler.add_job(myfunc, 'interval', minutes=2, id='my_job_id')
scheduler.remove_job('my_job_id')

暂停和恢复任务

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

暂停任务，有以下两个方法：

apscheduler.job.job.pause()
apscheduler.schedulers.base.BaseScheduler.pause_job()

恢复任务

apscheduler.job.job.resume()
apscheduler.scheduler.base.BaseScheduler.resume_job()

获取任务列表

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

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

修改任务

通过apscheduler.job.job.modify()或modify_job()，你可以修改人物当中除了id的任何属性。

比如：

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

如果想要重新调度任务(就是改变触发器)，你能通过apscheduler.job.job.reschedule()或reschedule_job()来实现。这些方法会重新创建触发器，并重新计算下次运行时间

比如：

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

关闭调度器

异常捕获

通过logging模块，可以添加apscheduler日志至debug级别，这样就能捕获异常信息。

关于logging初始化的方式如下：

import logging
logging.basicConfig()
logginggetLogger('apscheduler').setLevel(logging.DEBUG)