Flask:Decorator来验证JSON和JSON模式

2024-05-21 11:40:36 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个flask应用程序,其调用需要JSON负载。在处理每个调用之前,我有一个两步错误检查过程:

  • 断言负载是有效的JSON
  • 断言JSON负载符合特定模式

其实现方式如下:

@app.route('/activate', methods=['POST'])
def activate():
    request_id = request.__hash__()

    # Assert that the payload is a valid JSON
    try:
        input = request.json
    except BadRequest, e:
        msg = "payload must be a valid json"
        return jsonify({"error": msg}), 400

    # JSON Schema Validation
    try:
        validate(request.json, app.config['activate_schema'])
    except ValidationError, e:
        return jsonify({"error": e.message}), 400

由于这段代码在多次调用中重复,我想知道是否可以优雅地将它移到一个decorator中,它的形式如下:

@validate_json
@validate_schema(schema=app.config['activate_schema'])
@app.route('/activate', methods=['POST'])
def activate():
    ....

问题是request参数是隐式的:我可以在函数中引用它,但它不是函数的参数。因此,我不确定如何在装饰器中使用它。

如何使用Python decorators实现验证检查?


Tags: jsonapprequestschemadef断言validatepost
2条回答

一个迟来的答案,但你可能正在寻找像棉花糖(烧瓶棉花糖)或烤马蹄糖。

只需在装饰器中使用request上下文全局。它在任何请求期间都可用。

from functools import wraps
from flask import (
    current_app,
    jsonify,
    request,
)


def validate_json(f):
    @wraps(f)
    def wrapper(*args, **kw):
        try:
            request.json
        except BadRequest, e:
            msg = "payload must be a valid json"
            return jsonify({"error": msg}), 400
        return f(*args, **kw)
    return wrapper


def validate_schema(schema_name):
    def decorator(f):
        @wraps(f)
        def wrapper(*args, **kw):
            try:
                validate(request.json, current_app.config[schema_name])
            except ValidationError, e:
                return jsonify({"error": e.message}), 400
            return f(*args, **kw)
        return wrapper
    return decorator

在应用@routedecorator之前应用这些decorators;您要注册包装的函数,而不是路由的原始函数:

@app.route('/activate', methods=['POST'])
@validate_json
@validate_schema('activate_schema')
def activate():
    input = request.json

相关问题 更多 >