flask_apscheduler实现定时推送飞书消息

于 2024-08-23 20:21:58 发布
阅读量6k 收藏 27
点赞数 19
分类专栏： common flask 文章标签： flask 飞书 python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_17328759/article/details/133185428
版权

需求场景：

  实现一个flask服务，通过接口控制一个定时任务任务（对酒店订房情况进行检查）的开启和停止。要求定时任务完成后，可以通过飞书机器人推送任务完成的消息。

展现效果：

  1. 启动定时任务
    在这里插入图片描述

  2. 关闭定时任务
    在这里插入图片描述

  3. 飞书推送消息
    在这里插入图片描述

代码实现：

  1. 项目结构：
    在这里插入图片描述

  2. 业务代码：

    1. 定时任务。先通过schedule模块实现基础的定时任务业务代码。

      # -*- coding:UTF-8 -*-

"""
 @ProjectName  : 
 @FileName     : schedule_monitor_task
 @Description  : 
 @Time         : 2023/9/18 9:21
 @Author       : Qredsun
 """
import os
import time
from datetime import datetime
from datetime import timedelta

import schedule
import functools
from utils.webhook import send_message


def read_check_list_from_excel(file):
    try:
       logger.info("业务代码")
    except Exception as e:
        logger.error(f'程序异常：{e}')
    finally:
        prompt_message = f'**酒店订房检查已完成**\n' \
                         f'检查时间：{begin_time} - {end_time} \n' \
                         f'检查报告已生成： {save_path}'
        send_message(Environment.WEBHOOK_URL, Environment.WEBHOOK_SECRET, prompt_message)


# todo  定时任务配置
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
                traceback.format_exc()
                if cancel_on_failure:
                    return schedule.CancelJob

        return wrapper

    return catch_exceptions_decorator


# 异常捕获方法的使用
@catch_exceptions(cancel_on_failure=False)
def task_job(file_path):
    # 定时任务
    read_check_list_from_excel(file_path)

file_path = r'../data/订房检查任务.xlsx'
schedule.every().day.at("09:00").do(task_job, file_path)
schedule.run_all()

while True:
    schedule.run_pending()  # 运行所有可以运行的任务
    time.sleep(60 * 30)

    2. 飞书消息推送功能实现

      # -*- coding:UTF-8 -*-

"""
 @ProjectName  : 
 @FileName     : webhook
 @Description  : 飞书消息推送
 @Time         : 2023/9/17 13:36
 @Author       : Qredsun
 """
import base64
import hashlib
import hmac
import json
from datetime import datetime

import requests

from utils.env_manager import Environment, logger

WEBHOOK_URL = '机器人推送地址'
WEBHOOK_SECRET = '机器人密码'


def gen_sign(secret, timestamp):
    # 拼接时间戳以及签名校验
    string_to_sign = '{}\n{}'.format(timestamp, secret)

    # 使用 HMAC-SHA256 进行加密
    hmac_code = hmac.new(
            string_to_sign.encode("utf-8"), digestmod=hashlib.sha256
    ).digest()

    # 对结果进行 base64 编码
    sign = base64.b64encode(hmac_code).decode('utf-8')

    return sign


def send_message(WEBHOOK_URL, WEBHOOK_SECRET, MSG):
    timestamp = int(datetime.now().timestamp())
    sign = gen_sign(WEBHOOK_SECRET, timestamp)
    params = {
        "timestamp": timestamp,
        "sign"     : sign,
        "msg_type" : "interactive",
        "card"     : {
            "config"   : {
                "wide_screen_mode": True
            },
            "elements" : [
                {
                    "tag"    : "markdown",
                    "content": f"<at id=all></at> \n "
                               f"{MSG}"
                },
                {
                    "tag"    : "action",
                    "actions": [
                        {
                            "tag"      : "button",
                            "text"     : {
                                "tag"    : "plain_text",
                                "content": "跳转至订房检查"
                            },
                            "type"     : "primary",
                            "multi_url": {
                                "url"        : Environment.CALL_BACK_URL,
                                "android_url": "",
                                "ios_url"    : "",
                                "pc_url"     : ""
                            }
                        }
                    ]
                }
            ],
            "header"   : {
                "template": "blue",
                "title"   : {
                    "content": "订房检查异常提示",
                    "tag"    : "plain_text"
                }
            },
            "card_link": {
                "url"        : "",
                "pc_url"     : "",
                "android_url": "",
                "ios_url"    : ""
            }
        },
    }

    resp = requests.post(WEBHOOK_URL, json=params)
    resp.raise_for_status()
    result = resp.json()
    if result.get("code") and result.get("code") != 0:
        logger.error(f'飞书机器人消息 ： {MSG} 发送失败：{resp.text}')
    else:
        logger.debug(f'飞书机器人消息 ： {MSG} 发送成功')

    3. flask_apscheduler替换schedule

      app.schedule_job.add_job(id="check_room", func='s_app:read_check_list_from_excel', **{
    "args"   : (Environment.SRC_FILE,),
    # 'trigger': 'interval',  # 指定 定时任务的类型
    # 'seconds': 5  # 运行的间隔时间

    # 每天九点开始执行
    'trigger': 'cron',
    'day'    : '*',
    'hour'   : '09',
    'minute' : '00',
    'second' : '00'
})
app.schedule_job.start()  # 启动任务列表

    4. flask服务中启动、停止接口实现

      from flask import Flask

from utils.env_manager import Environment, logger
from utils.schedule_monitor_task import read_check_list_from_excel
from flask_apscheduler import APScheduler

app = Flask(__name__)
app.schedule_job = APScheduler()


@app.route('/', methods=['get'])
def hello_world():
    return '酒店订房检查服务!'


@app.route('/stop', methods=['get'])
def stop_job():
    if not app.schedule_job.get_jobs():
        return '没有正在执行的订房检查任务'
    else:
        app.schedule_job.remove_all_jobs()
        return '终止订房检查任务'


class Config(object):
    DEBUG = True  # flask 调试模式
    """flask_apscheduler 配置"""
    SCHEDULER_API_ENABLED = True  # 开放API
    SCHEDULER_TIMEZONE = 'Asia/Shanghai'  # 使用上海时间


@app.route('/start', methods=['get'])
def start_job():
    if app.schedule_job.get_jobs():
        return '订房检查任务已启动'
    else:
        app.schedule_job.add_job(id="check_room", func='s_app:read_check_list_from_excel', **{
            "args"   : (Environment.SRC_FILE,)
            # 每天九点开始执行
            'trigger': 'cron',
            'day'    : '*',
            'hour'   : '09',
            'minute' : '00',
            'second' : '00'
        })
        return '开始订房检查任务'


app.config.from_object(Config)
app.schedule_job.init_app(app)  # 把任务列表放入 flask
app.schedule_job.start()  # 启动任务列表
app.run()

ps：

  • 机器人推送接口的配置：
    在这里插入图片描述

  • 在flask的配置中将SCHEDULER_API_ENABLED设置为True，服务启动后自动加载flask_apscheduler提供的API接口：
    1. /scheduler [GET] > 获取服务基本信息
    2. /scheduler/jobs [POST json job data] > 添加新的任务
    3. /scheduler/jobs/<job_id> [GET] > 根据job_id返回任务的详细信息
    4. /scheduler/jobs [GET] > 返回所有任务的信息
    5. /scheduler/jobs/<job_id> [DELETE] > 删除任务
    6. /scheduler/jobs/<job_id> [PATCH json job data] > 更新一个已经存在的任务
    7. /scheduler/jobs/<job_id>/pause [POST] > 暂停一个任务并返回任务的信息
    8. /scheduler/jobs/<job_id>/resume [POST] > 重新启动一个任务并返回任务信息
    9. /scheduler/jobs/<job_id>/run [POST] > 启动一个任务并返回任务的信息
    在这里插入图片描述

  • 在实现定时任务的启动和关闭时，并没有直接flask_apscheduler使用自带的接口，而是通过flask_apscheduler提供的定时任务管理方法实现。还有下面一些方法可参考使用：

    1. scheduler.start() 开始任务
    2. scheduler.shutdown() 停止任务
    3. scheduler.pause() 暂停所有任务
    4. scheduler.resume() 开启任务
    5. scheduler.add_listener(<callback function>,<event>) 添加监听事件
    6. scheduler.remove_listener(<callback function>) 去除监听事件
    7. scheduler.add_job(<id>,<function>, **kwargs) 添加job
    8. scheduler.remove_job(<id>, **<jobstore>) 删除job
    9. scheduler.remove_all_jobs(**<jobstore>) 删除所有定时任务
    10. scheduler.get_job(<id>,**<jobstore>) 获取job信息
    11. scheduler.modify_job(<id>,**<jobstore>, **kwargs) 修改job
    12. scheduler.pause_job(<id>, **<jobstore>) 暂停job
    13. scheduler.resume_job(<id>, **<jobstore>) 恢复job
    14. scheduler.run_job(<id>, **<jobstore>) 启动job
    15. scheduler.authenticate(<function>) 验证
Qredsun
关注
专栏目录
Flask 与 APScheduler
weixin_45439324的博客
12-05 1269
Flask 与 APScheduler BackgroundScheduler 调度器 Scheduler 负责管理定时任务 BlockingScheduler: 作为独立进程时使用 from apscheduler.schedulers.blocking import BlockingScheduler scheduler = BlockingScheduler() sch...
flask-apscheduler定时任务调度数据库操作报找不到app
木木三
07-03 940
flaks-apscheduler做数据库定时任务,定时任务单独放在一个py文件里导致找不到应用问题，吐槽一下，好多文章都是一模一样的连内容里的符号都懒得改一下，我就想知道copy来copy去有意思么。 解决方法：使用app_context()手动推送应用上下文。 # scheduler实例所在位置exts/__init__.pyt from flask_apscheduler import APScheduler scheduler = APScheduler() #工厂函数apps/__init__
flask_apscheduler 定时任务框架
最新发布
qazwsx_19931126的专栏
04-23 826
Flask_apscheduler是一个在Flask框架中使用的APScheduler库的扩展。APScheduler是一个用于调度任务的Python库，可以在指定的时间间隔调度函数、方法或任意可调用对象的执行。Flask_apscheduler对APScheduler进行了集成，使得在Flask应用中可以简便地使用调度任务。它提供了一个可以在Flask应用中配置和管理调度任务的接口，并且可以与Flask的上下文管理机制结合使用，确保调度任务在正确的应用上下文中运行。
flask-apscheduler实现定时任务
focus：Follow One Cause Until Success
07-11 2451
flask-apscheduler是一个支持apscheduler的flask插件，通过flask-apscheduler可以很方便的定义定时任务。
flask 定时任务 flask-apscheduler
热门推荐
段一的博客
05-27 1万+
Flask-APScheduler介绍 Flask-APScheduler是基于APScheduler库开发的Flask拓展库。APScheduler的全称是Advanced Python Scheduler。允许您将Python代码安排为稍后执行，可以只执行一次，也可以定期执行。您可以随时添加新作业或删除旧作业。如果您将作业存储在数据库中，那么调度程序重启后它们也将存活下来并保持其状态。当调度器重新启动时，它将运行它在离线时应该运行的所有作业，APScheduler文档。 pip install.
Flask-定时任务
lllhhhv的博客
04-02 9271
pip install Flask-APScheduler Flask-APScheduler:Tips - Flask APScheduler Flask-APScheduler 是基于 python 库 apscheduler 做的集成, 所以官网上只有一些简单的使用案例,详细的配置还是要看 apscheduler的文档。 apscheduler: Advanced Python Scheduler — APScheduler 3.9.1 documenta...
Flask定时任务
予非池物
01-12 1272
https://zhuanlan.zhihu.com/p/321626955
企业微信机器人小项目,，flask框架起一个服务，使用flask_APScheduler定时推送消息到企业微信群.zip
09-28
在这个项目中，开发者利用Flask创建了一个Web服务，结合flask_apscheduler实现定时任务功能，从而实现自动化信息推送。 首先，Flask是一个轻量级的Web服务器网关接口（WSGI）Web应用框架，它提供了构建Web应用所需...
python基于Flask+apscheduler的定时任务系统
04-20
在Python的Web开发中，Flask是一个轻量级且强大的框架，它允许开发者轻松地构建自己的Web应用。...在实际项目中，这样的定时任务系统可以应用于自动备份、数据统计、通知推送等多种场景，极大地提高了工作效率。
flask-apscheduler使用场景
09-10
3. 定时消息推送：flask-apscheduler可以用于定时推送消息给用户。比如，在特定的时间点上，通过flask-apscheduler可以安排发送提醒消息给用户，如节假日祝福、活动通知等，提升用户的参与度和满意度。 4. 定时数据...
flask 使用 flask_apscheduler 做定时循环任务的实现
12-23
我是初学者，对 flask 很陌生，网上搜到的文章都看不懂，很尴尬。 本意是打算对广发信用卡diy卡积分兑换签帐额的数量进行爬虫监控。将抓取到的余量通过钉钉机器人发送到群里。爬虫代码就不写了，这里只写定时任务每分钟抓一次的代码。 不扯淡，直接干 以下代码，都是当前文件和定时器相关的代码，没有将其它代码写进来辣各位的眼睛。 文件夹结构图： ├── app │ ├── test.py │ ├── __init__.py │ └── routes.py ├── config.py ├── requirements.txt └── run.py config.py : # 定时任务 c
Python - 定时调度 - apscheduler
LIN的博客
04-03 2326
目录 一、apscheduler 轻量级的定时调度 1-1 基本概念 -APScheduler 的四种组件 1-2triggers 组件 - 提供三种触发方式 1-2-1 date - 在某个时间点执行一次（一次性） 1-2-2 interval - 相隔指定时间段执行 1-2-3 cron - 指定某个时间点执行 1-3 任务操作 1-3-1 任务添加 - add_job()...
【python】 通过 flask-apscheduler 实现定期执行任务
m0_48770520的博客
06-05 2376
Flask-APScheduler是基于APScheduler库开发的Flask拓展库。APScheduler的全称是Advanced Python Scheduler。本文主要通过APScheduler中的。
Flask定时任务-flask_apscheduler
qq_41108569的博客
03-03 361
转载自知乎https://zhuanlan.zhihu.com/p/74046287 import json import pickle from flask import Flask, request from flask_apscheduler import APScheduler # 主要插件 import datetime app = Flask(__name__) scheduler = APScheduler() def task1(a, b): print('mission_1
Flask中使用定时任务
study_in的博客
06-21 8287
文章目录1. 安装所需包2. 定义定时任务配置类3. 启动时加载定时任务4. 定时任务中配置1. cron定时调度2. interval间隔调度3. date定时调度5. 注意事项6. 官方网址 1. 安装所需包 pip install SQLAlchemy pip install flask_apscheduler 2. 定义定时任务配置类 from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore from schedules.t
【Flask】 flask_apscheduler动态加持久化定时任务
wyw875960418的博客
08-13 6313
flask- APScheduler动态加持久化定时任务 概念说明： APScheduler 支持三种调度任务：固定时间间隔，固定时间点（日期），Linux 下的 Crontab 命令。 APScheduler 使用起来还算是比较简单。运行一个调度任务只需要以下三部曲。 新建一个 schedulers (调度器) 。 添加一个调度任务(job stores)。 运行调度任务 基础组件： APScheduler 有四种组件，分别是：调度器(scheduler)，作业存储(job store)，触发器(tr
flask_apscheduler 接口
11-09
Flask_Apscheduler 是一个用于在 Flask 网络应用中集成定时任务调度的插件。它基于 Apscheduler，提供了一种简单方便的方式来配置和管理后台任务。 使用 Flask_Apscheduler，我们可以在 Flask 应用中轻松地创建和...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值