【Py】使用flask-apscheduler动态调整作业参数（附源码）

已于 2022-11-27 20:41:20 修改
阅读量1.6k 收藏 4
点赞数
CC 4.0 BY-SA版权
分类专栏： Python 后端 Flask 文章标签： flask python 后端 connexion apscheduler
于 2022-11-21 16:40:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/MacwinWin/article/details/127965653

之前的项目常使用Apscheduler进行定时任务调度，但最近想通过接口对这些任务进行动态调整，比如调整任务启停、调整任务执行时间、间隔时间等等

flask-apscheduler这个基于flask的库能够满足上面的需求，而且由于基于flask，所以我常用的connexion这个库理论上也能够完美支持。

接口描述

先来看一下官方文档
在这里插入图片描述

内建API

可以看到通过配置参数，能够开启内建API，接口详情如下：

  • /scheduler [GET]
    获取webapp基本信息
    Response 200:
{
    "current_host": "6a1cc3879c58",
    "allowed_hosts": [
        "*"
    ],
    "running": true
}
  • /scheduler/jobs [POST json job data]
    给调度器添加作业
    Request:
{
    "id": "job1",
    "func": "test:task",
    "args": [1, 2],
    "trigger": "interval",
    "seconds": 10
}

其中，上例func中的test为文件名，task为函数名

Response 200:

{
    "id": "job1",
    "name": "job1",
    "func": "test:task",
    "args": [
        1,
        2
    ],
    "kwargs": {},
    "trigger": "interval",
    "start_date": "2022-11-20T21:14:13.217787+08:00",
    "seconds": 10,
    "misfire_grace_time": 1,
    "max_instances": 1,
    "next_run_time": "2022-11-20T21:14:13.217787+08:00"
}
  • /scheduler/jobs/<job_id> [GET]
    获取作业详情
    Response 200:
{
    "id": "job1",
    "name": "job1",
    "func": "test:task",
    "args": [
        1,
        2
    ],
    "kwargs": {},
    "trigger": "interval",
    "start_date": "2022-11-20T20:57:27.662972+08:00",
    "seconds": 10,
    "misfire_grace_time": 1,
    "max_instances": 1,
    "next_run_time": "2022-11-20T21:02:27.662972+08:00"
}
  • /scheduler/jobs [GET]
    获取所有作业详情
    Response 200:
[
    {
        "id": "job1",
        "name": "job1",
        "func": "test:task",
        "args": [
            1,
            2
        ],
        "kwargs": {},
        "trigger": "interval",
        "start_date": "2022-11-20T20:57:27.662972+08:00",
        "seconds": 10,
        "misfire_grace_time": 1,
        "max_instances": 1,
        "next_run_time": "2022-11-20T21:02:47.662972+08:00"
    }
]
  • /scheduler/jobs/<job_id> [DELETE]
    从调度中删除某作业
    Response 204
  • /scheduler/jobs/<job_id> [PATCH json job data]
    更新某作业
    Request:
{
    "func": "test:task",
    "args": [2, 3],
    "trigger": "interval",
    "seconds": 10
}

Response 200:

{
    "id": "job1",
    "name": "job1",
    "func": "test:task",
    "args": [
        2,
        3
    ],
    "kwargs": {},
    "trigger": "interval",
    "start_date": "2022-11-20T21:15:31.187552+08:00",
    "seconds": 10,
    "misfire_grace_time": 1,
    "max_instances": 1,
    "next_run_time": "2022-11-20T21:15:31.187552+08:00"
}
  • /scheduler/jobs/<job_id>/pause [POST]
    暂停某作业
    Response 200:
{
    "id": "job1",
    "name": "job1",
    "func": "test:task",
    "args": [
        2,
        3
    ],
    "kwargs": {},
    "trigger": "interval",
    "start_date": "2022-11-20T21:15:31.187552+08:00",
    "seconds": 10,
    "misfire_grace_time": 1,
    "max_instances": 1,
    "next_run_time": null
}
  • /scheduler/jobs/<job_id>/resume [POST]
    恢复某作业
    Response 200:
{
    "id": "job1",
    "name": "job1",
    "func": "test:task",
    "args": [
        2,
        3
    ],
    "kwargs": {},
    "trigger": "interval",
    "start_date": "2022-11-20T21:15:31.187552+08:00",
    "seconds": 10,
    "misfire_grace_time": 1,
    "max_instances": 1,
    "next_run_time": "2022-11-20T21:17:01.187552+08:00"
}
  • /scheduler/jobs/<job_id>/run [POST]
    立即执行某作业
    Response 200:
{
    "id": "job1",
    "name": "job1",
    "func": "test:task",
    "args": [
        2,
        3
    ],
    "kwargs": {},
    "trigger": "interval",
    "start_date": "2022-11-20T21:15:31.187552+08:00",
    "seconds": 10,
    "misfire_grace_time": 1,
    "max_instances": 1,
    "next_run_time": "2022-11-20T21:21:31.187552+08:00"
}

内建函数

除了内建API，还提供有内建函数，功能和内建API基本一致，只是无法获取任务的详情。

示例代码

可以使用示例代码，其中包括使用connexion以及flask两种方式的代码，具体看你的项目需求而定。

进入代码根目录
执行如下代码运行容器

>>> docker-compose up -d

完成后进入容器

>>> docker exec -it falsk-apscheduler-test /bin/bash

停止supervisord

>>> supervisorctl -c Services/falsk-apscheduler-test/supervisord.conf stop all

connexion

>>> python3 swagger_server/app.py

随后可以看到定时输出如下内容：

/app/swagger_server/app.py:47: DeprecationWarning: 'app.json_encoder' is deprecated and will be removed in Flask 2.3. Customize 'app.json_provider_class' or 'app.json' instead.
  app.app.json_encoder = encoder.JSONEncoder
 * Serving Flask app 'app'
 * Debug mode: off
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on all addresses (0.0.0.0)
 * Running on http://127.0.0.1:8000
 * Running on http://172.22.0.2:8000
Press CTRL+C to quit
2022-11-20 22:21:14.358093 execute task 1+2=3
2022-11-20 22:21:24.358596 execute task 1+2=3
2022-11-20 22:21:34.357602 execute task 1+2=3
2022-11-20 22:21:44.357543 execute task 1+2=3
2022-11-20 22:21:54.357700 execute task 1+2=3
2022-11-20 22:22:04.357793 execute task 1+2=3
2022-11-20 22:22:14.358036 execute task 1+2=3
2022-11-20 22:22:24.358291 execute task 1+2=3
2022-11-20 22:22:34.358224 execute task 1+2=3

flask

>>> python3 test.py

随后可以看到定时输出如下内容：

 * Serving Flask app 'test'
 * Debug mode: off
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on http://127.0.0.1:8000
Press CTRL+C to quit
2022-11-21 16:51:19.376061 execute task 1+2=3
2022-11-21 16:51:29.377086 execute task 1+2=3
2022-11-21 16:51:39.376033 execute task 1+2=3
2022-11-21 16:51:49.376166 execute task 1+2=3
2022-11-21 16:51:59.376259 execute task 1+2=3
2022-11-21 16:52:09.376141 execute task 1+2=3
2022-11-21 16:52:19.376926 execute task 1+2=3
2022-11-21 16:52:29.376742 execute task 1+2=3

接口测试

将代码中的flask-apscheduler-test.postman_collection.json文件导入Postman中
在这里插入图片描述
依次对接口进行测试即可
在这里插入图片描述
注意：

  1. 进行接口测试时，不要关闭容器终端；
  2. 测试代码运行在8000端口，如果有占用，可以手动改为别的端口，再重新运行

2022-11-26更新

运行代码后出现警告

/usr/local/lib/python3.11/site-packages/apscheduler/util.py:436: PytzUsageWarning: The localize method is no longer necessary, as this time zone supports the fold attribute (PEP 495). For more details on migrating to a PEP 495-compliant implementation, see https://pytz-deprecation-shim.readthedocs.io/en/latest/migration.html
  return tzinfo.localize(dt)
 * Serving Flask app 'app'
 * Debug mode: off
 ...

则添加配置项即可

	...
    SCHEDULER_API_ENABLED = True
    SCHEDULER_TIMEZONE = 'Asia/Shanghai'
	...

2022-11-27更新

因为内建API无法接收自定义请求，故代码添加了使用内建函数封装的自定义接口，可以根据业务需求灵活调整。

  • POST /custom/scheduler/pause
  • POST /custom/scheduler/resume
  • POST /custom/scheduler/jobs
  • POST /custom/scheduler/jobs/{job_id}
  • PATCH /custom/scheduler/jobs/{job_id}
  • POST /custom/scheduler/jobs/{job_id}/pause
  • POST /custom/scheduler/jobs/{job_id}/resume
  • POST /custom/scheduler/jobs/{job_id}/run
APScheduler动态增、删、改任务
weixin_42000303的博客
09-10 4894
记一次通过faust读取kafka数据动态增、删、改APScheduler任务的笔记，手敲无测！ # -*- coding: utf-8 -*- import asyncio import logging import faust import ujson from apscheduler.executors.pool import ThreadPoolExecutor from apscheduler.jobstores.mongodb import MongoDBJobStore from aps
gunicorn多进程不死_Gunicorn 部署 Flask-Apscheduler 之踩坑记录
weixin_39834488的博客
12-19 1428
flask-apscheduler 是一款 flask 的定时任务框架，其本质上是和 apscheduler 一样的，具体的使用操作和其他的 flask 组件一样。在开发环境上定时任务跑起来很顺利，但是到了生产环境用 Gunicorn 部署的时候出现了各种问题。踩坑一：TimeZone offset does not match system offset部署生产环境时，一上去就给我丢了一个大大的...
FastAPI+apSheduler动态定时任务
灰寨小学的python---小陈
11-18 6293
一、apSheduler 第一部分内容限于apSheduler3.0以下版本，以上版本可移步至FastAPI+apSheduler动态定时任务 https://www.cnblogs.com/zhangliang91/p/11603916.html 1. 引子（Introduction） Advanced Python Scheduler (APScheduler) 是一个轻量级但功能强大的进程内任务调度器，允许您调度函数(或任何其他python可调用文件)在您选择的时间执行。 2. 特性（Fe.
python apscheduler调度模块动态修改参数
python小白
04-23 1136
动态修改调度周期 from apscheduler.schedulers.background import BackgroundScheduler from apscheduler.triggers.interval import IntervalTrigger import time import random scheduler = BackgroundScheduler() self.scheduler.add_job( print, args=(time.time(),),
python flask 的 APScheduler
duan737174646的博客
01-28 1562
Python任务调度模块 – APScheduler，Flask-APScheduler实现定时任务 1.安装　　 pip install apscheduler 　　 　　安装完毕   2. 简单任务 　　首先，来个最简单的例子，看看它的威力。 1 # coding:utf-8 2 from apscheduler.schedulers.blocking import...
PythonWeb开发框架—Flask-APScheduler超详细使用讲解
最新发布
weixin_42476668的博客
03-16 1368
本文介绍了用Flask-APScheduler实现定时任务的两种方式：用@scheduler.task装饰任务的方式和用add_job添加任务的方式，还介绍了完成一个定时任务必须用到的四个重要组件调度器(scheduler)、触发器(trigger)、执行器(executor)的分类及各自分类的适用场景
【python】 通过 flask-apscheduler 实现定期执行任务
m0_48770520的博客
06-05 2797
Flask-APScheduler是基于APScheduler库开发的Flask拓展库。APScheduler的全称是Advanced Python Scheduler。本文主要通过APScheduler中的。
python大作业基于django+APScheduler的定时任务管理系统源码.zip
06-14
功能：基于python+APScheduler的定时任务管理系统，目前定时执行的任务为获取指定网页的源码并与关键字比对，若比对通过则发送邮件通知。 开发语言及框架为后端为：python+django 安装教程 系统中完成python3安装后...
python基于Flask+apscheduler的定时任务系统
04-20
此外，ApScheduler提供了丰富的API，可以用来暂停、恢复、删除任务，甚至动态调整任务的执行策略。通过这些API，我们可以根据实际需求灵活地管理我们的定时任务。 总结起来，通过Flask和ApScheduler的结合，我们...
APScheduler-3.2.0-py2.py3-none-any.whl.zip
03-01
APScheduler 是一个强大的任务调度库，...使用 `APScheduler-3.2.0-py2.py3-none-any.whl.zip` 压缩包，用户可以便捷地在 Python 2 或 3 环境中安装并开始利用其功能。务必参考 `使用说明.txt` 来获取具体的操作指导。
Python-FlaskAPScheduler是Flask扩展增加了对APScheduler的支持
08-10
Flask-APScheduler 是Flask扩展，增加了对APScheduler的支持
详解Python下Flask-ApScheduler快速指南
09-19
Flask是Python社区非常流行的一个Web开发框架，本文将尝试将介绍APScheduler应用于Flask之中，非常具有实用价值，需要的朋友可以参考下
APScheduler-3.0.1-py2.py3-none-any.whl.zip
03-11
这个压缩包 "APScheduler-3.0.1-py2.py3-none-any.whl.zip" 包含了 APScheduler 的特定版本，即3.0.1，以及适用于 Python 2 和 Python 3 的兼容版本。"whl" 标签表明这是一个 Wheel 文件，它是 Python 的二进制包...
定时任务框架APScheduler学习详解
weixin_33889245的博客
12-23 2073
APScheduler简介 在平常的工作中几乎有一半的功能模块都需要定时任务来推动，例如项目中有一个定时统计程序，定时爬出网站的URL程序，定时检测钓鱼网站的程序等等，都涉及到了关于定时任务的问题，第一时间想到的是利用time模块的time.sleep()方法使程序休眠来达到定时任务的目的，虽然这样也可以，但是总觉得不是那么的专业，^_^所以就找到了python的定时任务模块APSch...
Python任务调度模块 – APScheduler，Flask-APScheduler实现定时任
qq_40584960的博客
11-23 529
https://www.cnblogs.com/huchong/p/9088611.html
Apscheduler结合flask进行动态任务管理
u013896904的博客
08-17 2936
​ Apscheduler是一个轻量级的 Python 定时任务调度框架。APScheduler 支持三种调度任务：固定时间间隔，固定时间点（日期），Linux 下的 Crontab 命令。同时，它还支持异步执行、后台执行调度任务。
Python 全栈系列74 - 使用flask_apscheduler创建动态的定时任务管理
yukai08008的博客
02-02 1293
说明 我想使用flask_apscheduler进行动态的定时任务调度，这样可以搭建一个建的分布式任务处理系统。 内容 这篇文章总结的很好，使用apscheduler常见的三种方式： 1 基于flask,在视图函数中进行任务管理（本篇采用这种） 2 基于flask,在配置项中管理。（网上其他常见的） 3 直接使用apscheduler启动，比较适合本地的worker，任务相对固定。 采用第一种(flask + 视图函数)的原因： 1 使用网页的形式管理任务更方便（增加、暂定、删除） 2 观察任务的执行
Python Flask_APScheduler定时任务的正确(最佳)使用
weixin_41934979的博客
09-08 2694
使用的Python 软件包下的__init__.py文件中初始化生成scheduler对象,此对象项目启动后只生成一次，然后导入scheduler对象，在定时任务执行的方法使用: with scheduler.app.app_context(): 就可以 获取flask当前app上下文，不需要create app,个人觉得这才是真正正确使用Flask_APScheduler参考资料。
flask-apscheduler使用场景
09-10
### 回答1： Flask-APscheduler 是一个在 Flask 框架中使用 APscheduler 的扩展包。APscheduler 是一个 Python 中的定时任务框架。使用 Flask-APscheduler 可以在 Flask 项目中方便地使用定时任务。常见场景包括： - 定时执行爬虫程序 - 定时发送邮件 - 定时备份数据库 - 定时清理无用文件 等等。 ### 回答2： flask-apscheduler是一个用于在Flask应用中调度定时任务的扩展。它基于APScheduler库，并提供了一种简单而灵活的方式来安排和管理这些任务。flask-apscheduler的使用场景如下： 1. 定时任务调度：使用flask-apscheduler可以轻松地在Flask应用中安排和管理定时任务。无论是需要每天定时执行数据备份、生成报表，还是需要每小时定时清理临时文件等任务，都可以通过flask-apscheduler来实现。 2. 异步任务处理：通过flask-apscheduler，可以将一些耗时的任务转为后台异步执行，提高系统的响应性能。比如，可以使用flask-apscheduler来处理邮件发送、文件处理、数据分析等耗时任务，让主线程及时返回给用户响应，并将耗时任务交给flask-apscheduler来异步处理。 3. 定时消息推送：flask-apscheduler可以用于定时推送消息给用户。比如，在特定的时间点上，通过flask-apscheduler可以安排发送提醒消息给用户，如节假日祝福、活动通知等，提升用户的参与度和满意度。 4. 定时数据更新：使用flask-apscheduler可以定时更新数据库中的数据，保持数据的最新性。通过设定合适的定时任务，可以定期从外部数据源获取最新数据，或者利用一些算法对数据库中的数据进行更新和优化，保持系统的稳定性和性能。 总之，flask-apscheduler在Flask应用中可以广泛应用于定时任务调度、异步任务处理、定时消息推送和定时数据更新等场景。它提供了简单且灵活的方式来管理这些任务，提高系统的性能和用户体验。 ### 回答3： flask-apscheduler是一个基于Flask框架的定时任务调度插件，用于在Flask应用程序中自动执行预定义的任务。它可以在特定的时间间隔内启动、暂停或终止任务。 flask-apscheduler的使用场景可以包括以下几个方面： 1. 定时任务执行：flask-apscheduler可以用于在指定的时间间隔内执行一些任务，比如定期清理数据库、定时发送邮件、定时生成报表等。通过预先定义的调度器和任务函数，可以很方便地配置和管理这些定时任务。 2. 后台处理：在一些需要长时间处理的业务场景中，可以使用flask-apscheduler将这些任务放入后台进行处理，而不会阻塞主线程。比如在用户提交一个表单后需要进行数据处理或发送通知，在后台执行任务可以提升用户的体验。 3. 数据同步：flask-apscheduler还可以用于调度不同数据库之间的数据同步任务。例如，将从一个数据库中提取的数据同步到另一个数据库中，可以使用定时任务来定期检查数据更新并执行同步操作。 4. 缓存刷新：如果应用程序中有一些需要定期刷新的缓存数据，可以使用flask-apscheduler来定时更新这些数据，确保数据的及时性和准确性。 总而言之，flask-apscheduler适用于需要定时执行任务、后台处理、数据同步和缓存刷新等场景。它提供了简单易用的API和配置方式，使得在Flask应用程序中实现定时任务调度变得非常方便。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值