APScheduler定时任务框架

定时任务框架

ipm中定时给运维发消息，定时用任务模板生成任务

操作系统有会提供定时任务的实现，比如windos自带的任务计划，以及linux自带的crontab，但是无法跨平台使用这些，那么就需要自己实现定时任务这个功能。

from flask import Flask
from flask_apscheduler import APScheduler


class SchedulerConfig(object):
    JOBS = [
        {
            "id": 'NO1',
            'func': '__main__:print_obj',
            'args': None,
            'trigger': 'interval',
            'seconds': 5
        }
    ]


def print_obj():
    print('hello_word')


app = Flask(__name__)

app.config.from_object(SchedulerConfig)
if __name__ == '__main__':
    sh = APScheduler()
    sh.init_app(app)
    sh.start()
    app.run()
# flask-APScheduler 底层调用的BackgroundScheduler()类
"""
BlockingScheduler ：适用于调度程序是进程中唯一运行的进程，调用 start 函数会阻塞当前线程，不能立即返回。
BackgroundScheduler ：适用于调度程序在应用程序的后台运行，调用 start 后主线程不会阻塞
"""

def start(self, paused=False):
   #import socket
   #socket.gethostname()  #获取主机名
   if flask.helpers.get_debug_flag() and not werkzeug.serving.is_running_from_reloader():
            return

   if self.host_name not in self.allowed_hosts and '*' not in self.allowed_hosts:
            LOGGER.debug('Host name %s is not allowed to start the APScheduler. Servers allowed: %s' %(self.host_name, ','.join(self.allowed_hosts)))
            return

    self._scheduler.start(paused=paused)   #BackgroundScheduler().start(paused=paused)

基础概念

1. 触发器（triggers) :调度逻辑，自己设定时间，何时被触发，比如按时间间隔，或者按date的某时某刻

2.任务存储器(job_stroes):时间到时调用的函数

3.执行器(executros):将指定的函数提交到线程池或者进程池去执行，执行完成通知调度器去触发相应事件

4.调度器(scheduler):与触发器执行器协调进行定时任务

运行流程为调度器通过任务存储器取出函数给触发器，触发器按照预定的时间以及满足自己设定的条件后交给执行器去执行，再将结果返回。

间隔性任务

def tick_print_time():
    print(f"现在的时间是{datetime.now()}")


if __name__ == '__main__':
    scheduler = BlockingScheduler()
    scheduler.add_job(tick_print_time, "interval", seconds=3)
    print(f"开始时间{datetime.now()}")
    scheduler.start()
    print(f"结束时间{datetime.now()}")
#BlockingScheduler是最基础调度器，阻塞性调度器。
#每三秒执行一次tick_print_time函数

	scheduler.add_job(tick_print_time, "interval", hour=21, minute=50)
    """
    interval触发器
    weeks ：周。整形。
    days ：一个月中的第几天。整形。
    hours ：小时。整形。
    minutes ：分钟。整形。
    seconds ：秒。整形。
    start_date ：间隔触发的起始时间。
    end_date ：间隔触发的结束时间。
    jitter ：触发的时间误差。
    corn  定时去执行tick_print_time函数，21点的五十分去执行
    例如：minute = '*/3'表示每五分钟去执行
         hour = '19-21' minute = '15' 表示19 20 21 每个小时的第十五分执行
    """
    scheduler.add_job(tick_print_time, 'date', run_date=date(2021, 7, 21))
    """
    date触发器：只触发一次
    """
    jobs = scheduler.add_job(tick_print_time, 'cron', day_of_week='*')
    jobs.remove()  # 移除任务
    print(scheduler.get_jobs())  # 获取任务列表
    scheduler.pause()  # 暂停任务
    scheduler.shutdown()  # 停止任务
    """
    cron(crontab) 触发器
    day_of_week ：一个礼拜中的第几天（ 0 - 6 或者 mon 、 tue 、 wed 、 thu 、 fri 、 sat 、 sun ）。
    """
    #下面代码执行不到，因为BlockingScheduler会阻塞主线程
	whilt true:
        print("main")
        time.sellp(1) 

from apscheduler.schedulers.background import BackgroundScheduler
import time

def job():
    print('job 3s')
    time.sleep(5)

if __name__=='__main__':
	job()  #在start开始时直接先执行一条job
    sched = BackgroundScheduler(timezone='MST')
    sched.add_job(job, 'interval', id='3_second_job', seconds=3)  
    sched.start()
	#下边会继续执行
    while(True):
        print('main 1s')
        time.sleep(1)

应用场景：例如定时去远程服务器下载数据到本地，定时修改用户状态

相同功能模块：sched

import sched
import time
from datetime import datetime
# 初始化sched模块的 scheduler 类
# 第一个参数是一个可以返回时间戳的函数，第二个参数可以在定时未到达之前阻塞。
schedule = sched.scheduler(time.time, time.sleep)
# 被周期性调度触发的函数
def print_time(inc):
    print(datetime.now().strftime("%Y-%m-%d %H:%M:%S"))
    schedule.enter(inc, 0, print_time, (inc,))   #类似于递归不停的定时去执行该函数
# 默认参数60s
def main(inc=60):
    # enter四个参数分别为：间隔事件、优先级（用于同时间到达的两个事件同时执行时定序）、被调用触发的函数，
    # 给该触发函数的参数（tuple形式）
    schedule.enter(0, 0, print_time, (inc,))
    schedule.run()
# 10s 输出一次
main(10)