django @login_required 超级用户的装饰器

django @login_required decorator for a superuser

django 中是否有类似于@login_required 的装饰器也可以测试用户是否是超级用户?

谢谢


使用 user_passes_test 装饰器:

1
2
3
4
5
from django.contrib.auth.decorators import user_passes_test

@user_passes_test(lambda u: u.is_superuser)
def my_view(request):
    ...


如果员工人数足够并且您不需要检查用户是否是超级用户,您可以使用 @staff_member_required 装饰器:

1
2
3
4
5
from django.contrib.admin.views.decorators import staff_member_required

@staff_member_required
def my_view(request):
    ...


如果您想拥有与@staff_member_required 类似的功能,您可以轻松编写自己的装饰器。以@staff_member 为例,我们可以这样做:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from django.contrib.auth import REDIRECT_FIELD_NAME
from django.contrib.admin.views.decorators import user_passes_test

def superuser_required(view_func=None, redirect_field_name=REDIRECT_FIELD_NAME,
                   login_url='account_login_url'):
   """
    Decorator for views that checks that the user is logged in and is a
    superuser, redirecting to the login page if necessary.
   """
    actual_decorator = user_passes_test(
        lambda u: u.is_active and u.is_superuser,
        login_url=login_url,
        redirect_field_name=redirect_field_name
    )
    if view_func:
        return actual_decorator(view_func)
    return actual_decorator

这个例子是一个修改过的staff_member_required,只是在lambda里改了一个check。


我推荐使用 Mixins,例如:

1
2
3
4
5
6
from django.contrib.auth.mixins import UserPassesTestMixin


class SuperUserCheck(UserPassesTestMixin, View):
    def test_func(self):
        return self.request.user.is_superuser

然后你可以将 SuperUserCheck 添加到 View 类:

1
class MyView(SuperUserCheck, View):

对于基于类的视图,创建一个可重用的装饰器:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from django.contrib.auth.mixins import UserPassesTestMixin
from django.views.generic import View


def superuser_required():
    def wrapper(wrapped):
        class WrappedClass(UserPassesTestMixin, wrapped):
            def test_func(self):
                return self.request.user.is_superuser

        return WrappedClass
    return wrapper

@superuser_required()
class MyClassBasedView(View):
    def get(self, request):
        # ...

如果你有你的用户资料,你可以这样做

1
2
3
4
@login_required
@user_passes_test(lambda u: True if u.profile.role==2 else False )
def add_listing(request):
    #...

在基于类的视图上要求超级用户而不编写新代码:

1
2
3
4
5
6
7
8
from django.utils.decorators import method_decorator
from django.contrib.auth.decorators import user_passes_test

@method_decorator(user_passes_test(lambda u: u.is_superuser), name='dispatch')
class AdminCreateUserView(LoginRequiredMixin, FormView):
    ...
    ...
    ...