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

时间:2013-09-04 05:04:32

标签: python flask

我写了一个装饰器试图检查我们是否有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()

1 个答案:

答案 0 :(得分:10)

我相信你只是缺少一件事,就是实际调用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,从而产生错误在你看到的错误中。