检查基于Django类的视图

时间:2017-05-10 08:51:38

标签: python django django-class-based-views class-based-views

我在Django项目中创建了一个装饰器,用于将参数值注入到装饰方法的参数中。

我是通过使用inspect.getargspec检查方法中存在哪些参数并将它们放在kwargs中来实现的。否则,由于方法中的参数数量不正确,我会收到错误。

虽然这在单个视图方法中正常工作,但在Django的基于类的视图方面却失败了。

我认为这可能是因为在类级别使用@method_decorator将装饰器应用于dispatch方法,而不是单独的getpost方法。

我是一个蟒蛇新手,可能会忽视这里显而易见的事情。

有没有更好的方法来做我正在做的事情?是否可以在基于类的视图中获取方法参数名称?

我使用的是Python 2.7和Django 1.11

装饰者

def need_jwt_verification(decorated_function):
    @wraps(decorated_function)
    def decorator(*args, **kwargs):
        request = args[0]
        if not isinstance(request, HttpRequest):
            raise RuntimeError(
                "This decorator can only work with django view methods accepting a HTTPRequest as the first parameter")

        if AUTHORIZATION_HEADER_NAME not in request.META:
            return HttpResponse("Missing authentication header", status=401)

        jwt_token = request.META[AUTHORIZATION_HEADER_NAME].replace(BEARER_METHOD_TEXT, "")

        try:
            decoded_payload = jwt_service.verify_token(jwt_token)

            parameter_names = inspect.getargspec(decorated_function).args

            if "phone_number" in parameter_names or "phone_number" in parameter_names:
                kwargs["phone_number"] = decoded_payload["phone"]
            if "user_id" in parameter_names:
                kwargs["user_id"] = decoded_payload["user_id"]
            if "email" in parameter_names:
                kwargs["email"] = decoded_payload["email"]

            return decorated_function(*args, **kwargs)
        except JWTError as e:
            return HttpResponse("Incorrect or expired authentication header", status=401)

    return decorator

基于类的视图

@method_decorator([csrf_exempt, need_jwt_verification], name="dispatch")
class EMController(View):
    def get(self, request, phone_number, event_id):
        data = get_data()

        return JsonResponse(data, safe=False)

    def post(self, request, phone_number, event_id):


        return JsonResponse("Operation successful", safe=False)

编辑:

在方法级别应用装饰器的明显解决方案不适用于Django的基于类的视图。您需要在url配置中应用装饰器或将装饰器应用于调度方法。

编辑: 我发布了与我正在探索的解决方法相关的代码,将参数名称作为参数传递给装饰器。

2 个答案:

答案 0 :(得分:5)

我发现了这篇文章:Function decorators with parameters on a class based view in Django

可能会为您的问题提供答案:

  

如果要传递带参数的装饰器,只需:

     
      
  • 评估decorator-creator函数中的参数。

  •   
  • 将评估值传递给@method_decorator

  •   

上面提到的和在考虑的链接答案中提供的代码,你应该:

injectables=[inject_1, inject_2, ..., inject_n]
decorators = [csrf_exempt, need_jwt_verification(injectables)]

@method_decorator(decorators, name="dispatch")
class EMController(View):
    ...

<小时/> 由于遗留原因,我在此留下我之前的错误答案,不要在家里(或任何地方,在django,尝试!!)

如果我们观察"decorating a class"文档,我们可以看到以下内容:

  

或者,更简洁地说,您可以装饰类而不是并将要装饰的方法的名称作为关键字参数名称传递:

因此您必须更改name的{​​{1}}参数以匹配适用于的方法:

@method_decorator

我个人更喜欢将装饰者置于他们将适用的特定方法之上:

decorators = [csrf_exempt, need_jwt_verification(injectables=[])]

@method_decorator(decorators, name='get')
@method_decorator(decorators, name='post')
class EMController(View):

答案 1 :(得分:1)

在库的当前状态下,我想要的东西似乎是不可能的。所以这就是我最终的目标。

            parameter_names = inspect.getargspec(decorated_function).args

            if "phone_number" in parameter_names or "phone_number" in injectables:
                kwargs["phone_number"] = decoded_payload["phone"]
            if "user_id" in parameter_names:
                kwargs["user_id"] = decoded_payload["user_id"]
            if "email" in parameter_names:
                kwargs["email"] = decoded_payload["email"]

            request.__setattr__("JWT", {})
            request.JWT["phone_number"] = decoded_payload["phone"]
            request.JWT["user_id"] = decoded_payload["user_id"]
            request.JWT["email"] = decoded_payload["email"]

此装饰器将根据需要自动填充基于方法的视图中的参数。

但是它还会为请求对象注入JWT属性,以便使用基于类的视图。与request.GETrequest.POST一样。