为什么Flask的url_for在Python中对该项使用装饰器时会抛出错误?

时间:2013-01-01 21:14:51

标签: python flask decorator build-error

我正在创建一个Python Flask应用程序并在下面创建了装饰器和视图。装饰器在查看索引时效果很好,但是当您注销并使用url_for索引重定向时,它会抛出一个构建器错误。为什么会

def logged_in(fn):
    def decorator():
        if 'email' in session:
            return fn()
        else:
            return render_template('not-allowed.html', page="index")
    return decorator


@app.route('/')
@logged_in
def index():
    email = session['email']    
    return render_template('index.html', auth=True, page="index", marks=marks)

@app.route('/sign-out')
def sign_out():
    session.pop('email')
    print(url_for('index'))
    return redirect(url_for('index'))

有什么想法吗?错误是:BuildError: ('index', {}, None)

1 个答案:

答案 0 :(得分:10)

此处的问题是,您返回的decorator()函数的名称与其正在装饰的函数的名称不同,因此URL构建器无法找到您的index视图。您需要使用wraps()模块中的functools装饰器来复制原始函数的名称。另一个问题(您仍然需要遇到)是您不接受装饰器中的参数并将其传递给原始函数。这是纠正的装饰者:

from functools import wraps

def logged_in(fn):
    @wraps(fn)
    def decorator(*args, **kwargs):
        if 'email' in session:
            return fn(*args, **kwargs)
        else:
            # IMO it's nicer to abort here and handle it in errorhandler.
            abort(401)
    return decorator

更多解释:在Python装饰器中是一个函数,它将另一个函数作为其参数并返回一个函数作为其结果。以下是

@logged_in
def index(): pass

基本相同
def index(): pass
index = logged_in(index)

这种情况下的问题是你的logged_in装饰器返回的不是原始函数,而是包装器(在代码中称为decorator),它包装了原始函数。此包装器具有与其包装的原始函数不同的名称(decorator)。现在,您在app.route()之后调用的logged_in装饰器会看到这个新函数,并使用其名称(decorator)为其注册路由。问题在于:您希望装饰函数具有相同的名称(index),因此可以在url_for()中使用它来获取它的路径。这就是你需要手动复制名称的原因

decorator.__name__ = fn.__name__

或者更好地使用update_wrapper模块中的wrapsfunctools帮助程序,这些帮助程序可以为您提供帮助。