django - 如何在基于 django 类的视图上使用 permission_required 装饰器

Question

我在理解新的 CBV 的工作原理时遇到了一些麻烦。我的问题是，我需要在所有视图中登录，其中一些视图需要特定权限。在基于函数的视图中，我使用 @permission_required() 和视图中的 login_required 属性来执行此操作，但我不知道如何在新视图上执行此操作。django 文档中是否有一些部分对此进行了解释？我什么也没找到。我的代码有什么问题？

我尝试使用@method_decorator，但它回复“ TypeError at /spaces/prueba/_wrapped_view() 需要至少 1 个参数（给定 0） ”

这是代码（GPL）：

from django.utils.decorators import method_decorator
from django.contrib.auth.decorators import login_required, permission_required

class ViewSpaceIndex(DetailView):

    """
    Show the index page of a space. Get various extra contexts to get the
    information for that space.

    The get_object method searches in the user 'spaces' field if the current
    space is allowed, if not, he is redirected to a 'nor allowed' page. 
    """
    context_object_name = 'get_place'
    template_name = 'spaces/space_index.html'

    @method_decorator(login_required)
    def get_object(self):
        space_name = self.kwargs['space_name']

        for i in self.request.user.profile.spaces.all():
            if i.url == space_name:
                return get_object_or_404(Space, url = space_name)

        self.template_name = 'not_allowed.html'
        return get_object_or_404(Space, url = space_name)

    # Get extra context data
    def get_context_data(self, **kwargs):
        context = super(ViewSpaceIndex, self).get_context_data(**kwargs)
        place = get_object_or_404(Space, url=self.kwargs['space_name'])
        context['entities'] = Entity.objects.filter(space=place.id)
        context['documents'] = Document.objects.filter(space=place.id)
        context['proposals'] = Proposal.objects.filter(space=place.id).order_by('-pub_date')
        context['publication'] = Post.objects.filter(post_space=place.id).order_by('-post_pubdate')
        return context

score 234 · Accepted Answer

CBV 文档中列出了一些策略：

`urls.py`在( docs )中实例化视图时装饰视图

urlpatterns = [
    path('view/',login_required(ViewSpaceIndex.as_view(..)),
    ...
]

urls.py装饰器是基于每个实例应用的，因此您可以根据需要在不同的路由中添加或删除它。

装饰您的类，以便包装视图的每个实例（文档）

有两种方法可以做到这一点：

适用method_decorator于您的 CBV 调度方法，例如，

 from django.utils.decorators import method_decorator

 @method_decorator(login_required, name='dispatch')
 class ViewSpaceIndex(TemplateView):
     template_name = 'secret.html'

如果您使用的是 Django < 1.9（您不应该这样做，它不再受支持），则您不能method_decorator在该类上使用，因此您必须dispatch手动覆盖该方法：

    class ViewSpaceIndex(TemplateView):

        @method_decorator(login_required)
        def dispatch(self, *args, **kwargs):
            return super(ViewSpaceIndex, self).dispatch(*args, **kwargs)

使用像django.contrib.auth.mixins.LoginRequiredMixin这样的 mixin ，在此处的其他答案中得到了很好的概述：

 from django.contrib.auth.mixins import LoginRequiredMixin

 class MyView(LoginRequiredMixin, View):

     login_url = '/login/'
     redirect_field_name = 'redirect_to'

确保将 mixin 类放在继承列表的首位（这样 Python 的方法解析顺序算法会选择正确的东西）。

您获得 a 的原因TypeError在文档中进行了解释：

注意：method_decorator 将 *args 和 **kwargs 作为参数传递给类上的装饰方法。如果您的方法不接受一组兼容的参数，它将引发 TypeError 异常。

score 120 · Accepted Answer

这是我的方法，我创建了一个受保护的 mixin（它保存在我的 mixin 库中）：

from django.contrib.auth.decorators import login_required
from django.utils.decorators import method_decorator

class LoginRequiredMixin(object):
    @method_decorator(login_required)
    def dispatch(self, request, *args, **kwargs):
        return super(LoginRequiredMixin, self).dispatch(request, *args, **kwargs)

每当您想要保护视图时，只需添加适当的 mixin：

class SomeProtectedViewView(LoginRequiredMixin, TemplateView):
    template_name = 'index.html'

只要确保你的 mixin 是第一个。

更新：我早在 2011 年就发布了这个，从 1.9 版开始，Django 现在包括这个和其他有用的 mixin（AccessMixin、PermissionRequiredMixin、UserPassesTestMixin）作为标准！

score 47 · Accepted Answer

这是使用基于类的装饰器的替代方法：

from django.utils.decorators import method_decorator

def class_view_decorator(function_decorator):
    """Convert a function based decorator into a class based decorator usable
    on class based Views.

    Can't subclass the `View` as it breaks inheritance (super in particular),
    so we monkey-patch instead.
    """

    def simple_decorator(View):
        View.dispatch = method_decorator(function_decorator)(View.dispatch)
        return View

    return simple_decorator

然后可以像这样简单地使用它：

@class_view_decorator(login_required)
class MyView(View):
    # this view now decorated

score 17 · Accepted Answer

对于那些使用Django >= 1.9的人，它已经包含在django.contrib.auth.mixinsas AccessMixin、LoginRequiredMixin和.PermissionRequiredMixinUserPassesTestMixin

因此，将 LoginRequired 应用于 CBV（例如DetailView）：

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.detail import DetailView


class ViewSpaceIndex(LoginRequiredMixin, DetailView):
    model = Space
    template_name = 'spaces/space_index.html'
    login_url = '/login/'
    redirect_field_name = 'redirect_to'

记住 GCBV Mixin 的顺序也很好：Mixin必须放在左侧，而基视图类必须放在右侧。如果顺序不同，您可能会得到破坏和不可预测的结果。

score 14 · Accepted Answer

我意识到这个线程有点过时了，但无论如何这是我的两分钱。

使用以下代码：

from django.utils.decorators import method_decorator
from inspect import isfunction

class _cbv_decorate(object):
    def __init__(self, dec):
        self.dec = method_decorator(dec)

    def __call__(self, obj):
        obj.dispatch = self.dec(obj.dispatch)
        return obj

def patch_view_decorator(dec):
    def _conditional(view):
        if isfunction(view):
            return dec(view)

        return _cbv_decorate(dec)(view)

    return _conditional

我们现在有办法修补装饰器，所以它会变得多功能。这实际上意味着当应用于常规视图装饰器时，如下所示：

login_required = patch_view_decorator(login_required)

这个装饰器在按照最初的预期方式使用时仍然可以工作：

@login_required
def foo(request):
    return HttpResponse('bar')

但像这样使用时也能正常工作：

@login_required
class FooView(DetailView):
    model = Foo

在我最近遇到的几种情况下，这似乎工作正常，包括这个现实世界的例子：

@patch_view_decorator
def ajax_view(view):
    def _inner(request, *args, **kwargs):
        if request.is_ajax():
            return view(request, *args, **kwargs)
        else:
            raise Http404

    return _inner

ajax_view 函数用于修改（基于函数的）视图，以便在非 ajax 调用访问该视图时引发 404 错误。通过简单地应用补丁函数作为装饰器，这个装饰器也可以在基于类的视图中工作

score 5 · Accepted Answer

使用 Django 大括号。它提供了许多很容易获得的有用的 mixin。它有漂亮的文档。试试看。

你甚至可以创建你的自定义 mixin。

http://django-braces.readthedocs.org/en/v1.4.0/

示例代码：

from django.views.generic import TemplateView

from braces.views import LoginRequiredMixin


class SomeSecretView(LoginRequiredMixin, TemplateView):
    template_name = "path/to/template.html"

    #optional
    login_url = "/signup/"
    redirect_field_name = "hollaback"
    raise_exception = True

    def get(self, request):
        return self.render_to_response({})

score 4 · Accepted Answer

在我的代码中，我编写了这个适配器来使成员函数适应非成员函数：

from functools import wraps


def method_decorator_adaptor(adapt_to, *decorator_args, **decorator_kwargs):
    def decorator_outer(func):
        @wraps(func)
        def decorator(self, *args, **kwargs):
            @adapt_to(*decorator_args, **decorator_kwargs)
            def adaptor(*args, **kwargs):
                return func(self, *args, **kwargs)
            return adaptor(*args, **kwargs)
        return decorator
    return decorator_outer

您可以像这样简单地使用它：

from django.http import HttpResponse
from django.views.generic import View
from django.contrib.auth.decorators import permission_required
from some.where import method_decorator_adaptor


class MyView(View):
    @method_decorator_adaptor(permission_required, 'someapp.somepermission')
    def get(self, request):
        # <view logic>
        return HttpResponse('result')

score 4 · Accepted Answer

如果它是一个大多数页面要求用户登录的站点，您可以使用中间件强制登录所有视图，除了一些特别标记的视图。

Pre Django 1.10 中间件.py：

from django.contrib.auth.decorators import login_required
from django.conf import settings

EXEMPT_URL_PREFIXES = getattr(settings, 'LOGIN_EXEMPT_URL_PREFIXES', ())

class LoginRequiredMiddleware(object):
    def process_view(self, request, view_func, view_args, view_kwargs):
        path = request.path
        for exempt_url_prefix in EXEMPT_URL_PREFIXES:
            if path.startswith(exempt_url_prefix):
                return None
        is_login_required = getattr(view_func, 'login_required', True)
        if not is_login_required:
            return None
        return login_required(view_func)(request, *view_args, **view_kwargs)

视图.py：

def public(request, *args, **kwargs):
    ...
public.login_required = False

class PublicView(View):
    ...
public_view = PublicView.as_view()
public_view.login_required = False

您不想包装的第三方视图可以在设置中排除：

设置.py：

LOGIN_EXEMPT_URL_PREFIXES = ('/login/', '/reset_password/')

score 3 · Accepted Answer

现在已经有一段时间了，现在 Django 已经发生了很大的变化。

在这里查看如何装饰基于类的视图。

https://docs.djangoproject.com/en/2.2/topics/class-based-views/intro/#decorating-the-class

该文档没有包含“接受任何参数的装饰器”的示例。但是接受参数的装饰器是这样的：

def mydec(arg1):
    def decorator(func):
         def decorated(*args, **kwargs):
             return func(*args, **kwargs) + arg1
         return decorated
    return deocrator

因此，如果我们要将 mydec 用作不带参数的“普通”装饰器，我们可以这样做：

mydecorator = mydec(10)

@mydecorator
def myfunc():
    return 5

所以同样地，permission_required与method_decorator

我们可以做的：

@method_decorator(permission_required("polls.can_vote"), name="dispatch")
class MyView:
    def get(self, request):
        # ...

score 1 · Accepted Answer

我已经根据 Josh 的解决方案进行了修复

class LoginRequiredMixin(object):

    @method_decorator(login_required)
    def dispatch(self, *args, **kwargs):
        return super(LoginRequiredMixin, self).dispatch(*args, **kwargs)

示例用法：

class EventsListView(LoginRequiredMixin, ListView):

    template_name = "events/list_events.html"
    model = Event

score 1 · Accepted Answer

django > 1.9 支持PermissionRequiredMixin和LoginRequiredMixin

只需从身份验证导入

视图.py

from django.contrib.auth.mixins import LoginRequiredMixin

class YourListView(LoginRequiredMixin, Views):
    pass

有关更多详细信息，请阅读django 中的授权

score 0 · Accepted Answer

如果你正在做一个需要各种权限测试的项目，你可以继承这个类。

from django.contrib.auth.decorators import login_required
from django.contrib.auth.decorators import user_passes_test
from django.views.generic import View
from django.utils.decorators import method_decorator



class UserPassesTest(View):

    '''
    Abstract base class for all views which require permission check.
    '''


    requires_login = True
    requires_superuser = False
    login_url = '/login/'

    permission_checker = None
    # Pass your custom decorator to the 'permission_checker'
    # If you have a custom permission test


    @method_decorator(self.get_permission())
    def dispatch(self, *args, **kwargs):
        return super(UserPassesTest, self).dispatch(*args, **kwargs)


    def get_permission(self):

        '''
        Returns the decorator for permission check
        '''

        if self.permission_checker:
            return self.permission_checker

        if requires_superuser and not self.requires_login:
            raise RuntimeError((
                'You have assigned requires_login as False'
                'and requires_superuser as True.'
                "  Don't do that!"
            ))

        elif requires_login and not requires_superuser:
            return login_required(login_url=self.login_url)

        elif requires_superuser:
            return user_passes_test(lambda u:u.is_superuser,
                                    login_url=self.login_url)

        else:
            return user_passes_test(lambda u:True)

score 0 · Accepted Answer

这里是 permission_required 装饰器的解决方案：

class CustomerDetailView(generics.GenericAPIView):

@method_decorator(permission_required('app_name.permission_codename', raise_exception=True))
    def post(self, request):
        # code...
        return True

django - 如何在基于 django 类的视图上使用 permission_required 装饰器

13 回答 13

urls.py在( docs )中实例化视图时装饰视图

装饰您的类，以便包装视图的每个实例（文档）

Related

Reference

`urls.py`在( docs )中实例化视图时装饰视图