Flask接收Webhook POST请求返回字典触发TypeError问题求助

根因分析 #

该报错由3个常见的Flask开发问题共同导致：

• 缺失sys模块导入：代码中调用了sys.stdout.flush()，但没有提前导入sys模块，执行到这一行会直接抛出NameError，导致视图函数异常中断，没有返回合法响应
• 直接返回Python字典不符合Flask响应规范：Flask视图不支持直接返回Python字典类型，必须封装为标准的JSON响应对象
• 未处理请求参数缺失场景：直接用request.json['key']的方式取值，如果请求JSON缺少对应键会抛出KeyError，同样会导致函数异常退出，触发报错

修复代码 #

# 补全缺失的导入
import sys
from flask import Flask, request, abort, jsonify
from Webhooks.TGSearchEngine import TGSearch

app = Flask(__name__)

# 路由已经限定仅接受POST请求，不需要额外判断请求方法
@app.route('/', methods=['POST'])
def webhook():
    sys.stdout.flush()
    try:
        # 获取请求参数
        reply = request.json['reply']
        query = request.json['query']
        channel = request.json['channel']
        messageid = request.json['id']
        # 用jsonify将字典封装为合法的JSON响应
        return jsonify(TGSearch.main(reply, query, channel, messageid)), 200
    except (KeyError, TypeError):
        # 请求参数不符合要求时返回400错误
        abort(400)

额外说明 #

如果你的Flask版本在2.0以上，原生支持直接返回字典，但仍然建议显式使用jsonify保证兼容性，同时需要确保TGSearch.main()返回的字典一定不是None，否则仍然会触发报错。

内容的提问来源于stack exchange，提问作者Exosylver