python3的schedule模块

发布时间 2023-09-19 16:38:44作者: 凯-子

一、schedule模块:

1、基本操作:

import schedule

import time

 

def hello(name):

    print("hello %s" % name)

 

def job():

    print("I'm working...")

 

# 每十分钟执行任务

schedule.every(10).minutes.do(job)

# 每个小时执行任务

schedule.every().hour.do(job)

# 每天的10:30执行任务

schedule.every().day.at("10:30").do(job)

# 每个月执行任务

schedule.every().monday.do(job)

# 每个星期三的13:15分执行任务

schedule.every().wednesday.at("13:15").do(job)

# 每分钟的第17秒执行任务

schedule.every().minute.at(":17").do(job)

 

schedule.every(5).seconds.do(hello,"kevin")

 

while True:

    schedule.run_pending()

    time.sleep(1)

上面的代码表示每10分钟执行一次 job 函数,非常简单方便。你只需要引入 schedule 模块,通过调用scedule.every(时间数).时间类型.do(job) 发布周期任务。

发布后的周期任务需要用run_pending函数来检测是否执行,因此需要一个While循环不断地轮询这个函数。

2、只执行一次

不过如果你想只运行一次任务的话,可以这么配:

import schedule

import time

 

def job_that_executes_once():

    # 此处编写的任务只会执行一次...

    return schedule.CancelJob

 

schedule.every().day.at('22:30').do(job_that_executes_once)

 

while True:

    schedule.run_pending()

    time.sleep(1)

 

3、获取所有作业:

all_jobs = schedule.get_jobs()

print(all_jobs)

4取消所有作业:

schedule.clear()

 

5、通过标签获取或取消部分作业:

# .tag 打标签

schedule.every().day.do(greet, 'Andrea').tag('daily-tasks', 'friend')

schedule.every().hour.do(greet, 'John').tag('hourly-tasks', 'friend')

schedule.every().hour.do(greet, 'Monica').tag('hourly-tasks', 'customer')

schedule.every().day.do(greet, 'Derek').tag('daily-tasks', 'guest')

 

# get_jobs(标签):可以获取所有该标签的任务

friends = schedule.get_jobs('friend')

 

# 取消所有 daily-tasks 标签的任务

schedule.clear('daily-tasks')

 

6设定作业截止时间:

import schedule

from datetime import datetime, timedelta, time

 

def job():

    print('Boo')

 

# 每个小时运行作业,18:30后停止

schedule.every(1).hours.until("18:30").do(job)

 

# 每个小时运行作业,2030-01-01 18:33 today

schedule.every(1).hours.until("2030-01-01 18:33").do(job)

 

# 每个小时运行作业,8个小时后停止

schedule.every(1).hours.until(timedelta(hours=8)).do(job)

 

# 每个小时运行作业,11:32:42后停止

schedule.every(1).hours.until(time(11, 33, 42)).do(job)

 

# 每个小时运行作业,2020-5-17 11:36:20后停止

schedule.every(1).hours.until(datetime(2020, 5, 17, 11, 36, 20)).do(job)

 

7立即运行所有作业,而不管其安排如何

import schedule

 

def job_1():

    print('Foo')

 

def job_2():

    print('Bar')

 

schedule.every().monday.at("12:40").do(job_1)

schedule.every().tuesday.at("16:40").do(job_2)

 

schedule.run_all()

 

# 立即运行所有作业,每次作业间隔10

schedule.run_all(delay_seconds=10)

 

8装饰器安排作业

from schedule import every, repeat, run_pending

import time

 

# 此装饰器效果等同于 schedule.every(10).minutes.do(job)

@repeat(every(10).minutes)

def job():

    print("I am a scheduled job")

 

while True:

    run_pending()

    time.sleep(1)

 

 

9并行执行

不过你可以通过多线程的形式来运行每个作业以解决此限制:

import threading

import time

import schedule

 

def job1():

    print("I'm running on thread %s" % threading.current_thread())

def job2():

    print("I'm running on thread %s" % threading.current_thread())

def job3():

    print("I'm running on thread %s" % threading.current_thread())

 

def run_threaded(job_func):

    job_thread = threading.Thread(target=job_func)

    job_thread.start()

 

schedule.every(10).seconds.do(run_threaded, job1)

schedule.every(10).seconds.do(run_threaded, job2)

schedule.every(10).seconds.do(run_threaded, job3)

 

while True:

    schedule.run_pending()

    time.sleep(1)

 

10日志记录

Schedule 模块同时也支持 logging 日志记录,这么使用:

import schedule

import logging

 

logging.basicConfig()

schedule_logger = logging.getLogger('schedule')

# 日志级别为DEBUG

schedule_logger.setLevel(level=logging.DEBUG)

 

def job():

    print("Hello, Logs")

 

schedule.every().second.do(job)

 

schedule.run_all()

 

schedule.clear()

效果如下:

DEBUG:schedule:Running *all* 1 jobs with 0s delay in between

DEBUG:schedule:Running job Job(interval=1, unit=seconds, do=job, args=(), kwargs={})

Hello, Logs

DEBUG:schedule:Deleting *all* jobs

 

11、异常处理

Schedule 不会自动捕捉异常,它遇到异常会直接抛出,这会导致一个严重的问题:后续所有的作业都会被中断执行,因此我们需要捕捉到这些异常。

你可以手动捕捉,但是某些你预料不到的情况需要程序进行自动捕获,加一个装饰器就能做到了:

import functools

 

def catch_exceptions(cancel_on_failure=False):

    def catch_exceptions_decorator(job_func):

        @functools.wraps(job_func)

        def wrapper(*args, **kwargs):

            try:

                return job_func(*args, **kwargs)

            except:

                import traceback

                print(traceback.format_exc())

                if cancel_on_failure:

                    return schedule.CancelJob

        return wrapper

    return catch_exceptions_decorator

 

@catch_exceptions(cancel_on_failure=True)

def bad_task():

    return 1 / 0

 

schedule.every(5).minutes.do(bad_task)

这样,bad_task在执行时遇到的任何错误,都会被catch_exceptions 捕获,这点在保证调度任务正常运转的时候非常关键。