Python定時任務框架APScheduler原理及常用代碼

APScheduler簡介

在平常的工作中幾乎有一半的功能模塊都需要定時任務來推動，例如項目中有一個定時統(tǒng)計程序，定時爬出網站的URL程序，定時檢測釣魚網站的程序等等，都涉及到了關于定時任務的問題，第一時間想到的是利用time模塊的time.sleep()方法使程序休眠來達到定時任務的目的，雖然這樣也可以，但是總覺得不是那么的專業(yè)，^_^所以就找到了python的定時任務模塊APScheduler：

APScheduler基于Quartz的一個Python定時任務框架，實現(xiàn)了Quartz的所有功能，使用起來十分方便。提供了基于日期、固定時間間隔以及crontab類型的任務，并且可以持久化任務。基于這些功能，我們可以很方便的實現(xiàn)一個python定時任務系統(tǒng)。

安裝

1、利用pip進行安裝

$ pip install apscheduler

2、源碼安裝（https://pypi.python.org/pypi/APScheduler/）

$ python setup.py install

APScheduler有四種組成部分：

觸發(fā)器(trigger)包含調度邏輯，每一個作業(yè)有它自己的觸發(fā)器，用于決定接下來哪一個作業(yè)會運行。除了他們自己初始配置意外，觸發(fā)器完全是無狀態(tài)的。

作業(yè)存儲(job store)存儲被調度的作業(yè)，默認的作業(yè)存儲是簡單地把作業(yè)保存在內存中，其他的作業(yè)存儲是將作業(yè)保存在數(shù)據(jù)庫中。一個作業(yè)的數(shù)據(jù)講在保存在持久化作業(yè)存儲時被序列化，并在加載時被反序列化。調度器不能分享同一個作業(yè)存儲。

執(zhí)行器(executor)處理作業(yè)的運行，他們通常通過在作業(yè)中提交制定的可調用對象到一個線程或者進城池來進行。當作業(yè)完成時，執(zhí)行器將會通知調度器。

調度器(scheduler)是其他的組成部分。你通常在應用只有一個調度器，應用的開發(fā)者通常不會直接處理作業(yè)存儲、調度器和觸發(fā)器，相反，調度器提供了處理這些的合適的接口。配置作業(yè)存儲和執(zhí)行器可以在調度器中完成，例如添加、修改和移除作業(yè)?！?/p>

簡單應用：
import time
from apscheduler.schedulers.blocking import BlockingScheduler

def my_job():
print time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))

sched = BlockingScheduler()
sched.add_job(my_job, 'interval', seconds=5)
sched.start()
上面的例子表示每隔5s執(zhí)行一次my_job函數(shù)，輸出當前時間信息

操作作業(yè)

1. 添加作業(yè)

上面是通過add_job()來添加作業(yè)，另外還有一種方式是通過scheduled_job()修飾器來修飾函數(shù)

import time
from apscheduler.schedulers.blocking import BlockingScheduler

sched = BlockingScheduler()

@sched.scheduled_job('interval', seconds=5)
def my_job():
print time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))

sched.start()

2. 移除作業(yè)

job = scheduler.add_job(myfunc, 'interval', minutes=2)
job.remove()
#如果有多個任務序列的話可以給每個任務設置ID號，可以根據(jù)ID號選擇清除對象，且remove放到start前才有效
sched.add_job(myfunc, 'interval', minutes=2, id='my_job_id')
sched.remove_job('my_job_id')

3. 暫停和恢復作業(yè)

暫停作業(yè):

apsched.job.Job.pause()
apsched.schedulers.base.BaseScheduler.pause_job()

恢復作業(yè):

apsched.job.Job.resume()
apsched.schedulers.base.BaseScheduler.resume_job()

4. 獲得job列表

獲得調度作業(yè)的列表，可以使用get_jobs()來完成，它會返回所有的job實例?；蛘呤褂胮rint_jobs()來輸出所有格式化的作業(yè)列表。也可以利用get_job(任務ID)獲取指定任務的作業(yè)列表

job = sched.add_job(my_job, 'interval', seconds=2 ,id='123')
print sched.get_job(job_id='123')
print sched.get_jobs()

5. 關閉調度器

默認情況下調度器會等待所有正在運行的作業(yè)完成后，關閉所有的調度器和作業(yè)存儲。如果你不想等待，可以將wait選項設置為False。

sched.shutdown()
sched.shutdown(wait=False)

作業(yè)運行的控制（trigger）

add_job的第二個參數(shù)是trigger，它管理著作業(yè)的調度方式。它可以為date, interval或者cron。對于不同的trigger，對應的參數(shù)也相同。

(1). cron定時調度（某一定時時刻執(zhí)行）

(int|str) 表示參數(shù)既可以是int類型，也可以是str類型
(datetime | str) 表示參數(shù)既可以是datetime類型，也可以是str類型
year (int|str) – 4-digit year -（表示四位數(shù)的年份，如2008年）
month (int|str) – month (1-12) -（表示取值范圍為1-12月）
day (int|str) – day of the (1-31) -（表示取值范圍為1-31日）
week (int|str) – ISO week (1-53) -（格里歷2006年12月31日可以寫成2006年-W52-7（擴展形式）或2006W527（緊湊形式））
day_of_week (int|str) – number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun) - （表示一周中的第幾天，既可以用0-6表示也可以用其英語縮寫表示）
hour (int|str) – hour (0-23) - （表示取值范圍為0-23時）
minute (int|str) – minute (0-59) - （表示取值范圍為0-59分）
second (int|str) – second (0-59) - （表示取值范圍為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) -（表示時區(qū)取值）

參數(shù)的取值格式：

例子：

#表示2017年3月22日17時19分07秒執(zhí)行該程序
sched.add_job(my_job, 'cron', year=2017,month = 03,day = 22,hour = 17,minute = 19,second = 07)
#表示任務在6,7,8,11,12月份的第三個星期五的00:00,01:00,02:00,03:00 執(zhí)行該程序
sched.add_job(my_job, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')
#表示從星期一到星期五5:30（AM）直到2014-05-30 00:00:00
sched.add_job(my_job(), 'cron', day_of_week='mon-fri', hour=5, minute=30,end_date='2014-05-30')
#表示每5秒執(zhí)行該程序一次，相當于interval 間隔調度中seconds = 5
sched.add_job(my_job, 'cron',second = '*/5')

(2). interval 間隔調度（每隔多久執(zhí)行）

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

例子：

#表示每隔3天17時19分07秒執(zhí)行一次任務
sched.add_job(my_job, 'interval',days = 03,hours = 17,minutes = 19,seconds = 07)

(3). date 定時調度（作業(yè)只會執(zhí)行一次）

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

例子：

# The job will be executed on November 6th, 2009
sched.add_job(my_job, 'date', run_date=date(2009, 11, 6), args=['text'])
# The job will be executed on November 6th, 2009 at 16:30:05
sched.add_job(my_job, 'date', run_date=datetime(2009, 11, 6, 16, 30, 5), args=['text'])

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。