将 Flask 路由参数传递给装饰器

Question

我编写了一个装饰器，它试图检查我们是否有 Flask POST 路由的发布数据：

这是我的装饰器：

def require_post_data(required_fields=None):
    def decorator(f):
        @wraps(f)
        def decorated_function(*args, **kwargs):
            for required_field in required_fields:
                if not request.form.get(required_field, None):
                    return jsonify({"error": "Missing %s from post data." %
                                    required_field}), 400
            else:
                if not request.form:
                    return jsonify({"error": "No post data, aborting."}), 400
            return f(*args, **kwargs)
        return decorated_function
    return decorator

我有两条路线，有一个 URL 参数，另一个没有：

from flask import Blueprint, jsonify, request

mod = Blueprint('contacts', __name__, url_prefix='/contacts')


@mod.route('/', methods=['POST'])
@require_post_data(['customer_id', 'some_other_required_field'])
def create_contact():
    # Do some business


@mod.route('/<int:contact_id>', methods=['POST'])
@require_post_data
def update_contact(contact_id):
    # Do some business

当我运行一个命中 update_contact 的测试时，我得到了以下异常：

TypeError: decorator() got an unexpected keyword argument 'contact_id'

但看起来create_contact 正在按预期工作。

为什么contact_id 被传递到decorator()？

Answer 1

我相信您只是缺少一件事，即实际调用 require_post_data 以在 update_contact 路由中生成装饰器函数。这应该可以解决它：

@mod.route('/<int:contact_id>', methods=['POST'])
@require_post_data() # <- note the parens
def update_contact(contact_id):
    # Do some business

详细的解释是，您期望发生的事情（以及在create contact 中发生的事情）是视图函数正在被decorator 修改由require_post_data 产生。在您上面的update_contact 中，实际发生的是视图函数被传递给require_post_data 本身 并简单地用作required_fields 参数的值。这不会导致错误，因此require_post_data 会愉快地返回decorator，然后在您点击/<int> 时将其路由到，从而将contact_id 作为关键字参数传递，从而导致您看到的错误。