Python 周期任务神器,太实用了

打印 上一主题 下一主题

主题 535|帖子 535|积分 1605

前言

如果你想在Linux服务器上周期性地执行某个 Python 脚本,最出名的选择应该是 Crontab 脚本,但是 Crontab 具有以下缺点:
1.不方便执行秒级的任务。
2.当需要执行的定时任务有上百个的时候,Crontab的管理就会特别不方便。
另外一个选择是 Celery,但是 Celery 的配置比较麻烦,如果你只是需要一个轻量级的调度工具,Celery 不会是一个好选择。
在你想要使用一个轻量级的任务调度工具,而且希望它尽量简单、容易使用、不需要外部依赖,最好能够容纳 Crontab 的所有基
本功能,那么 Schedule 模块是你的不二之选。
使用它来调度任务可能只需要几行代码,感受一下:
  1. python源码/素材/插件:903971231####
  2. # Python 实用宝典
  3. import schedule
  4. import time
  5. def job():
  6.     print("I'm working...")
  7. schedule.every(10).minutes.do(job)
  8. while True:
  9.     schedule.run_pending()
  10.     time.sleep(1)
复制代码
 
上面的代码表示每10分钟执行一次 job 函数,非常简单方便。你只需要引入 schedule 模块,通过调用 scedule.every(时间数).时
间类型.do(job) 发布周期任务。

发布后的周期任务需要用 run_pending 函数来检测是否执行,因此需要一个 While 循环不断地轮询这个函数。
下面具体讲讲Schedule模块的安装和初级、进阶使用方法。
标题1.准备

请选择以下任一种方式输入命令安装依赖:
  1. Windows 环境 打开 Cmd (开始-运行-CMD)。
  2. MacOS 环境 打开 Terminal (command+空格输入Terminal)。
  3. 如果你用的是 VSCode编辑器 或 Pycharm,可以直接使用界面下方的Terminal.
  4. pip install schedule
复制代码
 
2.基本使用

最基本的使用在文首已经提到过,下面给大家展示更多的调度任务例子:
  1. # Python 实用宝典
  2. import schedule
  3. import time
  4. def job():
  5.     print("I'm working...")
  6. # 每十分钟执行任务
  7. schedule.every(10).minutes.do(job)
  8. # 每个小时执行任务
  9. schedule.every().hour.do(job)
  10. # 每天的10:30执行任务
  11. schedule.every().day.at("10:30").do(job)
  12. # 每个月执行任务
  13. schedule.every().monday.do(job)
  14. # 每个星期三的13:15分执行任务
  15. schedule.every().wednesday.at("13:15").do(job)
  16. # 每分钟的第17秒执行任务
  17. schedule.every().minute.at(":17").do(job)
  18. while True:
  19.     schedule.run_pending()
  20.     time.sleep(1)
复制代码
 
可以看到,从月到秒的配置,上面的例子都覆盖到了。不过如果你想只运行一次任务的话,可以这么配:
  1. # Python 实用宝典
  2. import schedule
  3. import time
  4. def job_that_executes_once():
  5.     # 此处编写的任务只会执行一次...
  6.     return schedule.CancelJob
  7. schedule.every().day.at('22:30').do(job_that_executes_once)
  8. while True:
  9.     schedule.run_pending()
  10.     time.sleep(1)
复制代码
 

参数传递

如果你有参数需要传递给作业去执行,你只需要这么做:
  1. # Python 实用宝典
  2. import schedule
  3. def greet(name):
  4.     print('Hello', name)
  5. # do() 将额外的参数传递给job函数
  6. schedule.every(2).seconds.do(greet, name='Alice')
  7. schedule.every(4).seconds.do(greet, name='Bob')
复制代码
 
获取目前所有的作业

如果你想获取目前所有的作业:
  1. # Python 实用宝典
  2. import schedule
  3. def hello():
  4.     print('Hello world')
  5. schedule.every().second.do(hello)
  6. all_jobs = schedule.get_jobs()
复制代码
 
取消所有作业

如果某些机制触发了,你需要立即清除当前程序的所有作业:
  1. # Python 实用宝典
  2. import schedule
  3. def greet(name):
  4.     print('Hello {}'.format(name))
  5. schedule.every().second.do(greet)
  6. schedule.clear()
复制代码
 
标签功能

在设置作业的时候,为了后续方便管理作业,你可以给作业打个标签,这样你可以通过标签过滤获取作业或取消作业。
  1. # Python 实用宝典
  2. python插件/源码/素材加Q群:903971231####
  3. import schedule
  4. def greet(name):
  5.     print('Hello {}'.format(name))
  6. # .tag 打标签
  7. schedule.every().day.do(greet, 'Andrea').tag('daily-tasks', 'friend')
  8. schedule.every().hour.do(greet, 'John').tag('hourly-tasks', 'friend')
  9. schedule.every().hour.do(greet, 'Monica').tag('hourly-tasks', 'customer')
  10. schedule.every().day.do(greet, 'Derek').tag('daily-tasks', 'guest')
  11. # get_jobs(标签):可以获取所有该标签的任务
  12. friends = schedule.get_jobs('friend')
  13. # 取消所有 daily-tasks 标签的任务
  14. schedule.clear('daily-tasks')
复制代码
 

设定作业截止时间

如果你需要让某个作业到某个时间截止,你可以通过这个方法:
  1. # Python 实用宝典
  2. import schedule
  3. from datetime import datetime, timedelta, time
  4. def job():
  5.     print('Boo')
  6. # 每个小时运行作业,18:30后停止
  7. schedule.every(1).hours.until("18:30").do(job)
  8. # 每个小时运行作业,2030-01-01 18:33 today
  9. schedule.every(1).hours.until("2030-01-01 18:33").do(job)
  10. # 每个小时运行作业,8个小时后停止
  11. schedule.every(1).hours.until(timedelta(hours=8)).do(job)
  12. # 每个小时运行作业,11:32:42后停止
  13. schedule.every(1).hours.until(time(11, 33, 42)).do(job)
  14. # 每个小时运行作业,2020-5-17 11:36:20后停止
  15. schedule.every(1).hours.until(datetime(2020, 5, 17, 11, 36, 20)).do(job)
复制代码
 
截止日期之后,该作业将无法运行。
立即运行所有作业,而不管其安排如何
如果某个机制触发了,你需要立即运行所有作业,可以调用 schedule.run_all() :
  1. # Python 实用宝典
  2. import schedule
  3. def job_1():
  4.     print('Foo')
  5. def job_2():
  6.     print('Bar')
  7. schedule.every().monday.at("12:40").do(job_1)
  8. schedule.every().tuesday.at("16:40").do(job_2)
  9. schedule.run_all()
  10. # 立即运行所有作业,每次作业间隔10秒
  11. schedule.run_all(delay_seconds=10)
复制代码
 
3.高级使用

装饰器安排作业
如果你觉得设定作业这种形式太啰嗦了,也可以使用装饰器模式:
  1. # Python 实用宝典
  2. from schedule import every, repeat, run_pending
  3. import time
  4. # 此装饰器效果等同于 schedule.every(10).minutes.do(job)
  5. @repeat(every(10).minutes)
  6. def job():
  7.     print("I am a scheduled job")
  8. while True:
  9.     run_pending()
  10.     time.sleep(1)
复制代码
 

并行执行

默认情况下,Schedule 按顺序执行所有作业。其背后的原因是,很难找到让每个人都高兴的并行执行模型。
不过你可以通过多线程的形式来运行每个作业以解决此限制:
  1. # Python 实用宝典
  2. import threading
  3. import time
  4. import schedule
  5. def job1():
  6.     print("I'm running on thread %s" % threading.current_thread())
  7. def job2():
  8.     print("I'm running on thread %s" % threading.current_thread())
  9. def job3():
  10.     print("I'm running on thread %s" % threading.current_thread())
  11. def run_threaded(job_func):
  12.     job_thread = threading.Thread(target=job_func)
  13.     job_thread.start()
  14. schedule.every(10).seconds.do(run_threaded, job1)
  15. schedule.every(10).seconds.do(run_threaded, job2)
  16. schedule.every(10).seconds.do(run_threaded, job3)
  17. while True:
  18.     schedule.run_pending()
  19.     time.sleep(1)
复制代码
 
日志记录

Schedule 模块同时也支持 logging 日志记录,这么使用:
  1. # Python 实用宝典
  2. import schedule
  3. import logging
  4. logging.basicConfig()
  5. schedule_logger = logging.getLogger('schedule')
  6. # 日志级别为DEBUG
  7. schedule_logger.setLevel(level=logging.DEBUG)
  8. def job():
  9.     print("Hello, Logs")
  10. schedule.every().second.do(job)
  11. schedule.run_all()
  12. schedule.clear()
复制代码
 

效果如下:
  1. DEBUG:schedule:Running *all* 1 jobs with 0s delay in between
  2. DEBUG:schedule:Running job Job(interval=1, unit=seconds, do=job, args=(), kwargs={})
  3. Hello, Logs
  4. DEBUG:schedule:Deleting *all* jobs
复制代码
 
异常处理

Schedule 不会自动捕捉异常,它遇到异常会直接抛出,这会导致一个严重的问题:后续所有的作业都会被中断执行,因此我们需要捕捉到这些异常。
你可以手动捕捉,但是某些你预料不到的情况需要程序进行自动捕获,加一个装饰器就能做到了:
  1. # Python 实用宝典
  2. import functools
  3. def catch_exceptions(cancel_on_failure=False):
  4.     def catch_exceptions_decorator(job_func):
  5.         @functools.wraps(job_func)
  6.         def wrapper(*args, **kwargs):
  7.             try:
  8.                 return job_func(*args, **kwargs)
  9.             except:
  10.                 import traceback
  11.                 print(traceback.format_exc())
  12.                 if cancel_on_failure:
  13.                     return schedule.CancelJob
  14.         return wrapper
  15.     return catch_exceptions_decorator
  16. @catch_exceptions(cancel_on_failure=True)
  17. def bad_task():
  18.     return 1 / 0
  19. schedule.every(5).minutes.do(bad_task)
复制代码
 
这样,bad_task 在执行时遇到的任何错误,都会被 catch_exceptions 捕获,这点在保证调度任务正常运转的时候非常关键。


免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

光之使者

金牌会员
这个人很懒什么都没写!

标签云

快速回复 返回顶部 返回列表