Python 装饰器内部调用了错误的函数

Question

我们已经实现了一个扭曲的 web api。

为了处理身份验证，我们使用了一个装饰器，我们用它来包装一些路由。

@requires_auth(roles=[Roles.Admin])
def get_secret_stuff(request):
    return 42

requires_auth 包装器实现如下。

def requires_auth(roles):
    def wrap(f):
        def wrapped_f(request, *args, **kwargs):
            # If the user is authenticated then...
            return f(request, *args, **kwargs)
        return wrapped_f
    return wrap

问题是如果这个装饰器有多个路由，那么调用 它们中的任何一个都会导致调用要装饰的最新路由。

这显然不是我想要的，与我对装饰器应该如何工作的理解背道而驰。 我在代码中添加了一些打印语句来尝试弄清楚：

def requires_auth(roles):
    def wrap(f):
        print(f) # This shows that the decorator is being called correctly once per each
                 # route that is decorated
        def wrapped_f(request, *args, **kwargs):
            # If the user is authenticated then...
            return f(request, *args, **kwargs)
        return wrapped_f
    return wrap

如果它很重要，我将使用 twisted 的 inlineCallbacks 来处理其中一些路由，以及使用 twisted web 的 @app.route(url, methods) 装饰器来处理所有这些路由。

感谢您的阅读:)

编辑： 我删除了构造函数的默认参数，因为有人告诉我这是一个坏主意:)

编辑：这是一个说明问题的最小示例：

from klein import Klein
import json
app = Klein()

def requires_auth(roles):
    def wrap(f):
        print('inside the first clojure with f=%s' % str(f))
        def wrapped_f(request, *args, **kwargs):
            print('inside the second closure with f=%s' % str(f))
            return f(request, *args, **kwargs)
        return wrapped_f
    return wrap

@app.route('/thing_a')
@requires_auth(roles=['user'])
def get_a(request):
    return json.dumps({'thing A': 'hello'})

@app.route('/thing_b')
@requires_auth(roles=['admin'])
def get_b(request):
    return json.dumps({'thing B': 'goodbye'})

app.run('0.0.0.0', 8080)

去路由'/thing_a'会产生来自route_b的json

Answer 1

试试这个：

from functools import wraps

def require_auth(roles=(Roles.USER,), *args, **kwargs):

    def call(f, *args, **kwargs):
        return f(*args, **kwargs)

    def deco(f):
        @wraps(f)
        def wrapped_f(request, *a, **kw):
            # do your authentication here
            return call(f, request, *a, **kw)

        return wrapped_f

    return deco

Answer 2

避免使用可变参数（例如列表）作为任何函数或方法的默认参数。 More on why this is a bad idea.

我无法确认，但很有可能这是导致您的问题的原因。

编辑：如果我不清楚，我指的是

def requires_auth(roles=[Roles.USER]):

默认参数是可变的（一个列表）。

Answer 3

您需要以正确的顺序应用您的装饰器。这可能会起作用：

@route(...)
@requires_auth(roles=[Roles.Admin])
def get_secret_stuff(request):
    return 42

这可能不会：

@requires_auth(roles=[Roles.Admin])
@route(...)
def get_secret_stuff(request):
    return 42

因为这些分别意味着

将get_secret_stuff包装在一个授权器中，并将结果用作路由

和

使用get_secret_stuff 作为路由，并将结果包装在授权方中。授权者永远不会进入路由。