跳转至

Python-APSchedule:定时任务

  • advanceded python scheduler 是Python开发的定时任务工具
  • 不依赖于Linux系统的crontab系统定时,独立运行
  • 可以动态添加新的定时任务,如 '下单后30分钟内必须支付,否则取消订单,就可以借助此工具(每下一单就要添加此订单的定时任务)'
  • 对添加的定时任务可以做持久保存

安装

sudo pip install apscheduler

Demo

import time
from datetime import datetime

from apscheduler.schedulers.background import BackgroundScheduler # 导入子进程调度器
from apscheduler.schedulers.background import BlockingScheduler # 导入进程调度器
from apscheduler.executors.pool import ThreadPoolExecutor # 执行器



# 创建多线程执行器 进行并发处理
executor = ThreadPoolExecutor(max_workers=10) # 处理任务时最多可以开十个线程

# 创建进程调度器(使用BackgroundScheduler集成在现有的程序中, 使用子进程进行计时. 使用BlockingScheduler则为一个独立的进程)
scheduler = BackgroundScheduler(executors = {'default': executor})


def my_job(name, age):
    print('{}: {}'.format(name, age))


# 添加任务(形参需要创建任务时使用args传入)
# scheduler.add_job(my_job, 'date', run_date = datetime(2019, 6, 22, 20, 16, 30), args=['zs', 20]) # date模式只执行一次,run_date接收一个datetime.datetime对象,在2019-06-22日20点16分20秒执行
scheduler.add_job(my_job, 'interval', seconds = 1, args=['zs', 20]) # interval 周期性执行任务, 现在是 1s 执行一次
# scheduler.add_job(my_job, 'cron', hour= 22, minute= 24, args=['zs', 20]) # cron 周期行执行任务 每天的22点24分执行任务

# 启动定时器
scheduler.start()


time.sleep(10)

执行器 executors

  • ThreadPoolExecutor: 以线程的方式执行任务
  from apscheduler.executors.pool import ThreadPoolExecutor
  ThreadPoolExecutor(max_workers)  
  ThreadPoolExecutor(20) # 最多20个线程同时执行
    executors = {
      'default': ProcessPoolExecutor(3)
  }
  • ProcessPoolExecutor: 以进程的方式执行任务
  from apscheduler.executors.pool import ProcessPoolExecutor
  ProcessPoolExecutor(max_workers)
  ProcessPoolExecutor(5) # 最多5个进程同时执行
    executors = {
      'default': ProcessPoolExecutor(3)
  }

调度器 Scheduler

  • BlockingScheduler: 作为独立进程进行调度执行器
from apscheduler.schedulers.blocking import BlockingScheduler
scheduler = BlockingScheduler()
scheduler.start(executors=executors)  # 此处程序会发生阻塞
  • BackgroundScheduler: 在框架程序(如Django、Flask)的子进程中调度执行器
from apscheduler.schedulers.background import BackgroundScheduler
scheduler = BackgroundScheduler()
scheduler.start(executors=executors)  # 此处程序不会发生阻塞

触发器

  • 指定定时任务执行的时机

date: 在特定的时间日期执行

from datetime import date

## 在2019年11月6日00:00:00执行
sched.add_job(my_job, 'date', run_date=date(2009, 11, 6))

## 在2019年11月6日16:30:05
sched.add_job(my_job, 'date', run_date=datetime(2009, 11, 6, 16, 30, 5))
sched.add_job(my_job, 'date', run_date='2009-11-06 16:30:05')

## 立即执行
sched.add_job(my_job, 'date')  
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
from datetime import datetime

## 每两小时执行一次
sched.add_job(job_function, 'interval', hours=2)

## 在2010年10月10日09:30:00 到2014年6月15日的时间内,每两小时执行一次
sched.add_job(job_function, 'interval', hours=2, start_date='2010-10-10 09:30:00', end_date='2014-06-15 11:00:00')

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)
## 在6、7、8、11、12月的第三个周五的00:00, 01:00, 02:00和03:00 执行
sched.add_job(job_function, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')

## 在2014年5月30日前的周一到周五的5:30执行
sched.add_job(job_function, 'cron', day_of_week='mon-fri', hour=5, minute=30, end_date='2014-05-30')

任务管理

  • 使用管理器对象管理任务
job = scheduler.add_job(myfunc, 'interval', minutes=2)  # 添加任务
job.remove()  # 删除任务
job.pause() # 暂定任务
job.resume()  # 恢复任务
  • 使用管理器本身管理任务
scheduler.add_job(myfunc, 'interval', minutes=2, id='my_job_id')  # 添加任务    
scheduler.remove_job('my_job_id')  # 删除任务
scheduler.pause_job('my_job_id')  # 暂定任务
scheduler.resume_job('my_job_id')  # 恢复任务
  • 调整任务周期
job.modify(max_instances=6, name='Alternate name')
scheduler.reschedule_job('my_job_id', trigger='cron', minute='*/5')
  • 停止任务
scheduler.shutdown()