本文轉載自：
背景
目前所在的項目組需要經常執行一些定時任務，于是選擇使用 Python 的定時器。
Python 實作定時任務
循環 sleep
這種方式最簡單，在循環裡面放入要執行的任務，然後 sleep 一段時間再執行
1
2
3
4
5
6
7
8
9
from datetime import datetime
import time
# 每n秒執行一次
def timer(n):
while True:
print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
time.sleep(n)
# 5s
timer(5)
這個方法的缺點是，隻能執行固定間隔時間的任務，如果有定時任務就無法完成，比如早上六點半喊我起床。并且 sleep 是一個阻塞函數，也就是說 sleep 這一段時間，啥都不能做。
threading子產品中的Timer
threading 子產品中的 Timer 是一個非阻塞函數，比 sleep 稍好一點，不過依然無法喊我起床。
1
2
3
4
5
6
7
8
9
from datetime import datetime
from threading import Timer
# 列印時間函數
def printTime(inc):
print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
t = Timer(inc, printTime, (inc,))
t.start()
# 5s
printTime(5)
Timer 函數第一個參數是時間間隔（機關是秒），第二個參數是要調用的函數名，第三個參數是調用函數的參數(tuple)
使用sched子產品
sched 子產品是 Python 内置的子產品，它是一個排程（延時處理機制），每次想要定時執行某任務都必須寫入一個排程。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import sched
import time
from datetime import datetime
# 初始化sched子產品的 scheduler 類
# 第一個參數是一個可以傳回時間戳的函數，第二個參數可以在定時未到達之前阻塞。
schedule = sched.scheduler(time.time, time.sleep)
# 被周期性排程觸發的函數
def printTime(inc):
print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
schedule.enter(inc, 0, printTime, (inc,))
# 預設參數60s
def main(inc=60):
# enter四個參數分别為：間隔事件、優先級（用于同時間到達的兩個事件同時執行時定序）、被調用觸發的函數，
# 給該觸發函數的參數（tuple形式）
schedule.enter(0, 0, printTime, (inc,))
schedule.run()
# 10s 輸出一次
main(10)
sched 使用步驟如下：
（1）生成排程器：
s = sched.scheduler(time.time,time.sleep)
第一個參數是一個可以傳回時間戳的函數，第二個參數可以在定時未到達之前阻塞。
（2）加入排程事件
其實有 enter、enterabs 等等，我們以 enter 為例子。
s.enter(x1,x2,x3,x4)
四個參數分别為：間隔事件、優先級（用于同時間到達的兩個事件同時執行時定序）、被調用觸發的函數，給觸發函數的參數（注意：一定要以 tuple 給，如果隻有一個參數就(xx,)）
（3）運作
s.run()
注意 sched 子產品不是循環的，一次排程被執行後就 Over 了，如果想再執行，請再次 enter
APScheduler定時架構
終于找到了可以每天定時喊我起床的方式了
APScheduler是一個 Python 定時任務架構，使用起來十分友善。提供了基于日期、固定時間間隔以及 crontab 類型的任務，并且可以持久化任務、并以 daemon 方式運作應用。
使用 APScheduler 需要安裝
1
$ pip install apscheduler
首先來看一個周一到周五每天早上6點半喊我起床的例子
1
2
3
4
5
6
7
8
9
from apscheduler.schedulers.blocking import BlockingScheduler
from datetime import datetime
# 輸出時間
def job():
print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
# BlockingScheduler
scheduler = BlockingScheduler()
scheduler.add_job(job, 'cron', day_of_week='1-5', hour=6, minute=30)
scheduler.start()
代碼中的 BlockingScheduler 是什麼呢？
BlockingScheduler是APScheduler中的排程器，APScheduler 中有兩種常用的排程器，BlockingScheduler 和 BackgroundScheduler，當排程器是應用中唯一要運作的任務時，使用 BlockingSchedule，如果希望排程器在背景執行，使用 BackgroundScheduler。
BlockingScheduler: use when the scheduler is the only thing running in your process
BackgroundScheduler: use when you’re not using any of the frameworks below, and want the scheduler to run in the background inside your application
AsyncIOScheduler: use if your application uses the asyncio module
GeventScheduler: use if your application uses gevent
TornadoScheduler: use if you’re building a Tornado application
TwistedScheduler: use if you’re building a Twisted application
QtScheduler: use if you’re building a Qt application
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
2
3
4
5
6
7
8
9
from apscheduler.schedulers.blocking import BlockingScheduler
from datetime import datetime
def job():
print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
# 定義BlockingScheduler
sched = BlockingScheduler()
sched.add_job(job, 'interval', seconds=5)
sched.start()
上述代碼建立了一個 BlockingScheduler，并使用預設記憶體存儲和預設執行器。(預設選項分别是 MemoryJobStore 和 ThreadPoolExecutor，其中線程池的最大線程數為10)。配置完成後使用 start() 方法來啟動。
如果想要顯式設定 job store(使用mongo存儲)和 executor 可以這樣寫：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
from datetime import datetime
from pymongo import MongoClient
from apscheduler.schedulers.blocking import BlockingScheduler
from apscheduler.jobstores.memory import MemoryJobStore
from apscheduler.jobstores.mongodb import MongoDBJobStore
from apscheduler.executors.pool import ThreadPoolExecutor, ProcessPoolExecutor
# MongoDB 參數
host = '127.0.0.1'
port = 27017
client = MongoClient(host, port)
# 輸出時間
def job():
print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
# 存儲方式
jobstores = {
'mongo': MongoDBJobStore(collection='job', database='test', client=client),
'default': MemoryJobStore()
}
executors = {
'default': ThreadPoolExecutor(10),
'processpool': ProcessPoolExecutor(3)
}
job_defaults = {
'coalesce': False,
'max_instances': 3
}
scheduler = BlockingScheduler(jobstores=jobstores, executors=executors, job_defaults=job_defaults)
scheduler.add_job(job, 'interval', seconds=5, jobstore='mongo')
scheduler.start()
在運作程式5秒後，第一次輸出時間。
在 MongoDB 中可以看到 job 的狀态
對 job 的操作
添加 job
添加job有兩種方式：
add_job()
scheduled_job()
第二種方法隻适用于應用運作期間不會改變的 job，而第一種方法傳回一個apscheduler.job.Job 的執行個體，可以用來改變或者移除 job。
1
2
3
4
5
6
7
8
from apscheduler.schedulers.blocking import BlockingScheduler
sched = BlockingScheduler()
# 裝飾器
@sched.scheduled_job('interval', id='my_job_id', seconds=5)
def job_function():
print("Hello World")
# 開始
sched.start()
@sched.scheduled_job() 是 Python 的裝飾器。
移除 job
移除 job 也有兩種方法：
remove_job()
job.remove()
remove_job 使用 jobID 移除
job.remove() 使用 add_job() 傳回的執行個體
1
2
3
4
5
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')
暫停和恢複 job
暫停一個 job：
1
2
apscheduler.job.Job.pause()
apscheduler.schedulers.base.BaseScheduler.pause_job()
恢複一個 job：
1
2
apscheduler.job.Job.resume()
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
2
job.modify(max_instances=6, name='Alternate name')
modify_job('my_job_id', trigger='cron', minute='*/5')
關閉 job
預設情況下排程器會等待所有的 job 完成後，關閉所有的排程器和作業存儲。将 wait 選項設定為 False 可以立即關閉。
1
2
scheduler.shutdown()
scheduler.shutdown(wait=False)
scheduler 事件
scheduler 可以添加事件監聽器，并在特殊的時間觸發。
1
2
3
4
5
6
7
def my_listener(event):
if event.exception:
print('The job crashed :(')
else:
print('The job worked :)')
# 添加監聽器
scheduler.add_listener(my_listener, EVENT_JOB_EXECUTED | EVENT_JOB_ERROR)
trigger 規則
最基本的一種排程，作業隻會執行一次。它的參數如下：
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
2
3
4
5
6
7
8
9
10
11
12
from datetime import date
from apscheduler.schedulers.blocking import BlockingScheduler
sched = BlockingScheduler()
def my_job(text):
print(text)
# The job will be executed on November 6th, 2009
sched.add_job(my_job, 'date', run_date=date(2009, 11, 6), args=['text'])
sched.add_job(my_job, 'date', run_date=datetime(2009, 11, 6, 16, 30, 5), args=['text'])
sched.add_job(my_job, 'date', run_date='2009-11-06 16:30:05', args=['text'])
# The 'date' trigger and datetime.now() as run_date are implicit
sched.add_job(my_job, args=['text'])
sched.start()
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
2
3
4
5
6
7
8
9
10
11
12
from apscheduler.schedulers.blocking import BlockingScheduler
def job_function():
print("Hello World")
# BlockingScheduler
sched = BlockingScheduler()
# Schedules job_function to be run on the third Friday
# of June, July, August, November and December at 00:00, 01:00, 02:00 and 03:00
sched.add_job(job_function, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')
# Runs from Monday to Friday at 5:30 (am) until 2014-05-30 00:00:00
sched.add_job(job_function, 'cron', day_of_week='mon-fri', hour=5, minute=30, end_date='2014-05-30')
sched.start()
參數：
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
2
3
4
5
6
7
8
9
10
11
12
from datetime import datetime
from apscheduler.schedulers.blocking import BlockingScheduler
def job_function():
print("Hello World")
# BlockingScheduler
sched = BlockingScheduler()
# Schedule job_function to be called every two hours
sched.add_job(job_function, 'interval', hours=2)
# The same as before, but starts on 2010-10-10 at 9:30 and stops on 2014-06-15 at 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')
sched.start()