apscheduler 的使用

??我們專案中總是避免不了要使用一些定時任務，比如說最近的專案，用戶點擊報名考試以后需要在考試日期臨近的時候推送小程式訊息提醒到客戶微信上，翻了翻 fastapi 中的實作，雖然方法和包也不少，但是要不就是太重了（比如需要再開服務，還要依賴 redis，都不好用），雖然也可以使用 time 模塊的 time.sleep()機上 fastapi 的后臺任務變相實作，但是相對簡單的功能還行，復雜點的代碼起來就麻煩了，所以還是專人專事找個負責這個額的包吧，找來找去發現 APScheduler 就挺適合，代碼簡單，實作效果也很好，這里做個記錄！

安裝

pip install apscheduler

主要組成部分

概念性東西，混個臉熟，代碼比這些定義好理解，

觸發器(trigger)包含調度邏輯，每一個作業有它自己的觸發器，用于決定接下來哪一個作業會運行，除了他們自己初始配置意外，觸發器完全是無狀態的，說人話就是你指定那種方式觸發當前的任務，

干貨主要有：

① 200 多本 Python 電子書（和經典的書籍）應該有

② Python標準庫資料（最全中文版）

③ 專案原始碼（四五十個有趣且可靠的練手專案及原始碼）

④ Python基礎入門、爬蟲、網路開發、大資料分析方面的視頻（適合小白學習）

⑤ Python學習路線圖（告別不入流的學習）

Python學習交流Q群101677771

作業存盤(job store)存盤被調度的作業，默認的作業存盤是簡單地把作業保存在記憶體中，其他的作業存盤是將作業保存在資料庫中，一個作業的資料講在保存在持久化作業存盤時被序列化，并在加載時被反序列化，調度器不能分享同一個作業存盤，

Jobstore在scheduler中初始化，另外也可通過scheduler的add_jobstore動態添加Jobstore，每個jobstore
都會系結一個alias，scheduler在Add Job時，根據指定的jobstore在scheduler中找到相應的jobstore，并
將job添加到jobstore中，

Jobstore主要是通過pickle庫的loads和dumps【實作核心是通過python的__getstate__和__setstate__重寫
實作】，每次變更時將Job動態保存到存盤中，使用時再動態的加載出來，作為存盤的可以是redis，也可以
是資料庫【通過sqlarchemy這個庫集成多種資料庫】，也可以是mongodb等
目前APScheduler支持的Jobstore：

MemoryJobStore
MongoDBJobStore
RedisJobStore
RethinkDBJobStore
SQLAlchemyJobStore
ZooKeeperJobStore

執行器(executor)處理作業的運行，他們通常通過在作業中提交制定的可呼叫物件到一個執行緒或者進城池來進行，當作業完成時，執行器將會通知調度器，

- 說人話就是添加任務時候用它來包裝的，executor的種類會根據不同的調度來選擇，如果選擇AsyncIO作為調度的庫，那么選擇AsyncIOExecutor，如果選擇tornado作為調度的庫，選擇TornadoExecutor，如果選擇啟動行程作為調度，選擇ThreadPoolExecutor或者ProcessPoolExecutor都可以Executor的選擇需要根據實際的scheduler來選擇不同的執行器
目前APScheduler支持的Executor：
AsyncIOExecutor
GeventExecutor
ThreadPoolExecutor
ProcessPoolExecutor
TornadoExecutor
TwistedExecutor

調度器(scheduler)是其他的組成部分，你通常在應用只有一個調度器，應用的開發者通常不會直接處理作業存盤、調度器和觸發器，相反，調度器提供了處理這些的合適的介面，配置作業存盤和執行器可以在調度器中完成，例如添加、修改和移除作業.

Scheduler是APScheduler的核心，所有相關組件通過其定義，scheduler啟動之后，將開始按照配置的任務進行調度，
除了依據所有定義Job的trigger生成的將要調度時間喚醒調度之外，當發生Job資訊變更時也會觸發調度，

scheduler可根據自身的需求選擇不同的組件，如果是使用AsyncIO則選擇AsyncIOScheduler，使用tornado則
選擇TornadoScheduler，
目前APScheduler支持的Scheduler：

AsyncIOScheduler
BackgroundScheduler
BlockingScheduler
GeventScheduler
QtScheduler
TornadoScheduler
TwistedScheduler

簡單應用

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()

完整代碼

# trigeers 觸發器
# job stores job 存盤
# executors 執行器
# schedulers 調度器

from pytz import utc
from sqlalchemy import func

from apscheduler.schedulers.background import BackgroundScheduler,AsyncIOScheduler
from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
from apscheduler.executors.pool import ProcessPoolExecutor


jobstores = {
    # 可以配置多個存盤
    #'mongo': {'type': 'mongodb'}, 
    'default': SQLAlchemyJobStore(url='sqlite:///jobs.sqlite')  # SQLAlchemyJobStore指定存盤鏈接
}
executors = {
    'default': {'type': 'threadpool', 'max_workers': 20},     # 最大作業執行緒數20
    'processpool': ProcessPoolExecutor(max_workers=5)         # 最大作業行程數為5
}
job_defaults = {
    'coalesce': False,   # 關閉新job的合并，當job延誤或者例外原因未執行時
    'max_instances': 3   # 并發運行新job默認最大實體多少
}
scheduler = BackgroundScheduler()

# .. do something else here, maybe add jobs etc.

scheduler.configure(jobstores=jobstores, executors=executors, job_defaults=job_defaults, timezone=utc) # utc作為調度程式的時區


import os
import time

def print_time(name):
    print(f'{name} - {time.ctime()}')

def add_job(job_id, func, args, seconds):
    """添加job"""
    print(f"添加間隔執行任務job - {job_id}")
    scheduler.add_job(id=job_id, func=func, args=args, trigger='interval', seconds=seconds)

def add_coun_job(job_id, func, args, start_time):
    """添加job"""
    print(f"添加一次執行任務job - {job_id}")
    scheduler.add_job(id=job_id, func=func, args=args, trigger='date',timezone='Asia/Shanghai', run_date=start_time)
    # scheduler.add_job(func=print_time, trigger='date',timezone='Asia/Shanghai', run_date=datetime(2022, 2, 19, 17, 57, 0).astimezone(), args=['text2'])

def remove_job(job_id):
    """移除job"""
    scheduler.remove_job(job_id)
    print(f"移除job - {job_id}")

def pause_job(job_id):
    """停止job"""
    scheduler.pause_job(job_id)
    print(f"停止job - {job_id}")

def resume_job(job_id):
    """恢復job"""
    scheduler.resume_job(job_id)
    print(f"恢復job - {job_id}")

def get_jobs():
    """獲取所有job資訊,包括已停止的"""
    res = scheduler.get_jobs()
    print(f"所有job - {res}")

def print_jobs():
    print(f"詳細job資訊")
    scheduler.print_jobs()

def start():
    """啟動調度器"""
    scheduler.start()

def shutdown():
    """關閉調度器"""
    scheduler.shutdown()

if __name__ == '__main__':
    scheduler = BackgroundScheduler()
    # start()
    # print('Press Ctrl+{0} to exit \n'.format('Break' if os.name == 'nt' else 'C'))
    # add_job('job_A', func=print_time, args=("A", ), seconds=1)
    # add_job('job_B', func=print_time, args=("B", ), seconds=2)
    # time.sleep(6)
    # pause_job('job_A') # 停止a
    # get_jobs()   #得到所有job
    # time.sleep(6)
    # print_jobs()
    # resume_job('job_A')
    # time.sleep(6)
    # remove_job('job_A')
    # time.sleep(6)
    from datetime import datetime
    import pytz
    start()
    
    date_temp = datetime(2022, 2, 19, 17, 30, 5)
    # scheduler.add_job(print_time, 'date', run_date=datetime.now(pytz.timezone('America/Manaus')), args=['text'])
    # scheduler.add_job(print_time, 'date',timezone='Asia/Shanghai', run_date=datetime(2022, 2, 19, 17, 57, 0).astimezone(), args=['text2'])
    add_coun_job(job_id="job_C",func=print_time,args=('一次性執行任務',),start_time=datetime(2022, 2, 19, 18, 4, 0).astimezone())
    time.sleep(130)
    try:
        shutdown()
    except RuntimeError:
        pass

標籤：其他

上一篇：超詳細的SpringBoot框架入門教程

下一篇：阿里云智能編碼插件，更Cosy的開發體驗