說明
APScheduler是一個 Python 定時任務框架，使用起來十分方便。提供了基於日期、固定時間間隔以及 crontab 類型的任務，並且可以持久化任務、並以 daemon 方式運行應用。
使用 APScheduler 需要安裝
安裝：
1 pip install apscheduler
首先來看一個週一到週五每天早上6點半喊我起牀的例子：
1 from apscheduler.schedulers.blocking import BlockingScheduler
2 from datetime import datetime
3 # 輸出時間
4 def job():
5 print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
6 # BlockingScheduler
7 scheduler = BlockingScheduler()
8 scheduler.add_job(job, 'cron', day_of_week='1-5', hour=6, minute=30)
9 scheduler.start()
代碼中的 BlockingScheduler 是什麼呢？
BlockingScheduler是APScheduler中的調度器，APScheduler 中有兩種常用的調度器，BlockingScheduler 和 BackgroundScheduler，當調度器是應用中唯一要運行的任務時，使用 BlockingSchedule，如果希望調度器在後臺執行，使用 BackgroundScheduler。
APScheduler四個組件
APScheduler 四個組件分別爲：觸發器(trigger)，作業存儲(job store)，執行器(executor)，調度器(scheduler)。
觸發器(trigger)
包含調度邏輯，每一個作業有它自己的觸發器，用於決定接下來哪一個作業會運行。除了他們自己初始配置意外，觸發器完全是無狀態的
APScheduler 有三種內建的 trigger:
- date: 特定的時間點觸發
- interval: 固定時間間隔觸發
- cron: 在特定時間週期性地觸發
作業存儲(job store)
存儲被調度的作業，默認的作業存儲是簡單地把作業保存在內存中，其他的作業存儲是將作業保存在數據庫中。一個作業的數據講在保存在持久化作業存儲時被序列化，並在加載時被反序列化。調度器不能分享同一個作業存儲。
APScheduler 默認使用 MemoryJobStore，可以修改使用 DB 存儲方案
執行器(executor)
處理作業的運行，他們通常通過在作業中提交制定的可調用對象到一個線程或者進城池來進行。當作業完成時，執行器將會通知調度器。
最常用的 executor 有兩種：
- ProcessPoolExecutor
- ThreadPoolExecutor
調度器(scheduler)
通常在應用中只有一個調度器，應用的開發者通常不會直接處理作業存儲、調度器和觸發器，相反，調度器提供了處理這些的合適的接口。配置作業存儲和執行器可以在調度器中完成，例如添加、修改和移除作業。
配置調度器
APScheduler提供了許多不同的方式來配置調度器，你可以使用一個配置字典或者作爲參數關鍵字的方式傳入。你也可以先創建調度器，再配置和添加作業，這樣你可以在不同的環境中得到更大的靈活性。
下面來看一個簡單的 BlockingScheduler 例子
1 from apscheduler.schedulers.blocking import BlockingScheduler
2 from datetime import datetime
3
4
5 def job():
6 print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
7 # 定義BlockingScheduler
8 sched = BlockingScheduler()
9 sched.add_job(job, 'interval', seconds=5)
10 sched.start()
上述代碼創建了一個 BlockingScheduler，並使用默認內存存儲和默認執行器。(默認選項分別是 MemoryJobStore 和 ThreadPoolExecutor，其中線程池的最大線程數爲10)。配置完成後使用 start() 方法來啓動。
如果想要顯式設置 job store(使用mongo存儲)和 executor 可以這樣寫：
![]()
1 from datetime import datetime
2 from pymongo import MongoClient
3 from apscheduler.schedulers.blocking import BlockingScheduler
4 from apscheduler.jobstores.memory import MemoryJobStore
5 from apscheduler.jobstores.mongodb import MongoDBJobStore
6 from apscheduler.executors.pool import ThreadPoolExecutor, ProcessPoolExecutor
7 # MongoDB 參數
8 host = '127.0.0.1'
9 port = 27017
10 client = MongoClient(host, port)
11 # 輸出時間
12 def job():
13 print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
14 # 存儲方式
15 jobstores = {
16 'mongo': MongoDBJobStore(collection='job', database='test', client=client),
17 'default': MemoryJobStore()
18 }
19 executors = {
20 'default': ThreadPoolExecutor(10),
21 'processpool': ProcessPoolExecutor(3)
22 }
23 job_defaults = {
24 'coalesce': False,
25 'max_instances': 3
26 }
27 scheduler = BlockingScheduler(jobstores=jobstores, executors=executors, job_defaults=job_defaults)
28 scheduler.add_job(job, 'interval', seconds=5, jobstore='mongo')
29 scheduler.start()
在運行程序5秒後，第一次輸出時間。
在 MongoDB 中可以看到 job 的狀態
對 job 的操作
添加 job
添加job有兩種方式：
-
add_job()
-
scheduled_job()
第二種方法只適用於應用運行期間不會改變的 job，而第一種方法返回一個
apscheduler.job.Job 的實例，可以用來改變或者移除 job。
1 from apscheduler.schedulers.blocking import BlockingScheduler
2 sched = BlockingScheduler()
3 # 裝飾器
4 @sched.scheduled_job('interval', id='my_job_id', seconds=5)
5 def job_function():
6 print("Hello World")
7 # 開始
8 sched.start()
@sched.scheduled_job() 是 Python 的裝飾器。
移除 job
移除 job 也有兩種方法：
-
remove_job()
-
job.remove()
remove_job 使用 jobID 移除
job.remove() 使用 add_job() 返回的實例
1 job = scheduler.add_job(myfunc, 'interval', minutes=2)
2 job.remove()
3 # id
4 scheduler.add_job(myfunc, 'interval', minutes=2, id='my_job_id')
5 scheduler.remove_job('my_job_id')
暫停和恢復 job
暫停一個 job：
1 apscheduler.job.Job.pause()
2 apscheduler.schedulers.base.BaseScheduler.pause_job()恢復一個 job：
1 apscheduler.job.Job.resume()
2 apscheduler.schedulers.base.BaseScheduler.resume_job()希望你還記得 apscheduler.job.Job 是 add_job() 返回的實例
獲取 job 列表
獲得可調度 job 列表，可以使用
get_jobs() 來完成，它會返回所有的 job 實例。
也可以使用
print_jobs() 來輸出所有格式化的 job 列表
修改 job
除了 jobID 之外 job 的所有屬性都可以修改，使用 apscheduler.job.Job.modify() 或者 modify_job() 修改一個 job 的屬性
1 job.modify(max_instances=6, name='Alternate name')
2 modify_job('my_job_id', trigger='cron', minute='*/5')
關閉 job
默認情況下調度器會等待所有的 job 完成後，關閉所有的調度器和作業存儲。將 wait 選項設置爲 False 可以立即關閉。
1 scheduler.shutdown()
2 scheduler.shutdown(wait=False)
scheduler 事件
scheduler 可以添加事件監聽器，並在特殊的時間觸發。
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)
中文釋義：
|
參數
|
說明
|
|
(int|str)
|
表示參數既可以是int類型，也可以是str類型
|
|
(datetime | str)
|
表示參數既可以是datetime類型，也可以是str類型
|
|
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) | 指定時區 |
表達式:
示例：
1 from apscheduler.schedulers.blocking import BlockingScheduler
2
3
4 def job_function():
5 print("Hello World")
6 # BlockingScheduler
7 sched = BlockingScheduler()
8 # Schedules job_function to be run on the third Friday
9 # of June, July, August, November and December at 00:00, 01:00, 02:00 and 03:00
10 sched.add_job(job_function, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')
11 # Runs from Monday to Friday at 5:30 (am) until 2014-05-30 00:00:00
12 sched.add_job(job_function, 'cron', day_of_week='mon-fri', hour=5, minute=30, end_date='2014-05-30')
13 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
5 def job_function():
6 print("Hello World")
7 # BlockingScheduler
8 sched = BlockingScheduler()
9 # Schedule job_function to be called every two hours
10 sched.add_job(job_function, 'interval', hours=2)
11 # The same as before, but starts on 2010-10-10 at 9:30 and stops on 2014-06-15 at 11:00
12 sched.add_job(job_function, 'interval', hours=2, start_date='2010-10-10 09:30:00', end_date='2014-06-15 11:00:00')
13 sched.start()
踩坑記錄：
1、cron編寫場景爲每週五上午十點執行一次時，day_of_week字段爲4，即當前星期數-1，也可以寫成'fri'