使用注意：#

  （1）传调用函数的参数时，一定要以 tuple 给，如果只有一个参数就(xx,)
  （2）sched 模块不是循环的，一次调度被执行后就 Over 了，如果想再执行，请再次 enter

APScheduler四个组件#

  APScheduler 四个组件分别为：触发器(trigger)，作业存储(job store)，执行器(executor)，调度器(scheduler)。

配置调度器#

  APScheduler提供了许多不同的方式来配置调度器，灵活性强

1
from apscheduler.schedulers.blocking import BlockingScheduler
2

3
def job():
4
   function(*args, **kargs)
5

6
# 定义BlockingScheduler
7
sched = BlockingScheduler()
8
sched.add_job(job, 'interval', seconds=5)
9
sched.start()

  上述代码创建了一个 BlockingScheduler，并使用默认内存存储和默认执行器。(默认选项分别是 MemoryJobStore 和 ThreadPoolExecutor，其中线程池的最大线程数为10)。配置完成后使用 start() 方法来启动。

如果想要显式设置 job store(使用mongo存储)和 executor 可以这样写：

1
from pymongo import MongoClient
2
from apscheduler.schedulers.blocking import BlockingScheduler
3
from apscheduler.jobstores.memory import MemoryJobStore
4
from apscheduler.jobstores.mongodb import MongoDBJobStore
5
from apscheduler.executors.pool import ThreadPoolExecutor, ProcessPoolExecutor
6
# MongoDB 参数
7
host = '127.0.0.1'
8
port = 27017
9
client = MongoClient(host, port)
10
# 输出时间
11
def job():
12
    function(*args, **kargs)
13
# 存储方式
14
jobstores = {
15
    'mongo': MongoDBJobStore(collection='job', database='test', client=client),
16
    'default': MemoryJobStore()
17
}
18
executors = {
19
    'default': ThreadPoolExecutor(10),
20
    'processpool': ProcessPoolExecutor(3)
21
}
22
job_defaults = {
23
    'coalesce': False,
24
    'max_instances': 3
25
}
26
scheduler = BlockingScheduler(jobstores=jobstores, executors=executors, job_defaults=job_defaults)
27
scheduler.add_job(job, 'interval', seconds=5, jobstore='mongo')
28
scheduler.start()

在 MongoDB 中可以看到 job 的状态

对 job 的操作#

1
apscheduler.job.Job.pause()
2
apscheduler.schedulers.base.BaseScheduler.pause_job()

1
apscheduler.job.Job.resume()
2
apscheduler.schedulers.base.BaseScheduler.resume_job()

1
job.modify(max_instances=6, name='Alternate name')
2
modify_job('my_job_id', trigger='cron', minute='*/5')

1
scheduler.shutdown()
2
scheduler.shutdown(wait=False)

1
def my_listener(event):
2
    if event.exception:
3
        print('The job crashed :(')
4
    else:
5
        print('The job worked :)')
6
# 添加监听器
7
scheduler.add_listener(my_listener, EVENT_JOB_EXECUTED | EVENT_JOB_ERROR)

trigger 规则#

date
  最基本的一种调度，作业只会执行一次。它的参数如下：

• run_date (datetime|str) – the date/time to run the job at

• timezone (datetime.tzinfo|str) – time zone for run_date if it doesn’t have one already

  1
  from datetime import date
  2
  from apscheduler.schedulers.blocking import BlockingScheduler
  3
  sched = BlockingScheduler()
  4
  def my_job(text):
  5
      print(text)
  6
  # The job will be executed on November 6th, 2009
  7
  sched.add_job(my_job, 'date', run_date=date(2009, 11, 6), args=['text'])
  8
  sched.add_job(my_job, 'date', run_date=datetime(2009, 11, 6, 16, 30, 5), args=['text'])
  9
  sched.add_job(my_job, 'date', run_date='2009-11-06 16:30:05', args=['text'])
  10
  # The 'date' trigger and datetime.now() as run_date are implicit
  11
  sched.add_job(my_job, args=['text'])
  12
  sched.start()
  

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)

表达式:

1
from apscheduler.schedulers.blocking import BlockingScheduler
2

3
def job_function():
4
    print("Hello World")
5
# BlockingScheduler
6
sched = BlockingScheduler()
7
# Schedules job_function to be run on the third Friday
8
# of June, July, August, November and December at 00:00, 01:00, 02:00 and 03:00
9
sched.add_job(job_function, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')
10
# Runs from Monday to Friday at 5:30 (am) until 2014-05-30 00:00:00
11
sched.add_job(job_function, 'cron', day_of_week='mon-fri', hour=5, minute=30, end_date='2014-05-30')
12
sched.start()

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

1
from datetime import datetime
2
from apscheduler.schedulers.blocking import BlockingScheduler
3

4
def job_function():
5
    print("Hello World")
6
# BlockingScheduler
7
sched = BlockingScheduler()
8
# Schedule job_function to be called every two hours
9
sched.add_job(job_function, 'interval', hours=2)
10
# The same as before, but starts on 2010-10-10 at 9:30 and stops on 2014-06-15 at 11:00
11
sched.add_job(job_function, 'interval', hours=2, start_date='2010-10-10 09:30:00', end_date='2014-06-15 11:00:00')
12
sched.start()

参考文章