class UserPassesTestMixin

from django.contrib.auth.mixins import UserPassesTestMixin
CBV Mixin that allows you to define a test function which must return True
if the current user can access the view.

Ancestors (MRO)

  1. UserPassesTestMixin
  2. AccessMixin

Attributes

  Defined in
login_url = None AccessMixin
permission_denied_message = '' AccessMixin
raise_exception = False AccessMixin
redirect_field_name = 'next' AccessMixin
Expand Collapse

Methods

def dispatch(self, request, *args, **kwargs): UserPassesTestMixin

112
113
114
115
116
def dispatch(self, request, *args, **kwargs):
    user_test_result = self.get_test_func()()
    if not user_test_result:
        return self.handle_no_permission()
    return super(UserPassesTestMixin, self).dispatch(request, *args, **kwargs)

def get_login_url(self): AccessMixin

Override this method to override the login_url attribute.
19
20
21
22
23
24
25
26
27
28
29
def get_login_url(self):
    """
    Override this method to override the login_url attribute.
    """
    login_url = self.login_url or settings.LOGIN_URL
    if not login_url:
        raise ImproperlyConfigured(
            '{0} is missing the login_url attribute. Define {0}.login_url, settings.LOGIN_URL, or override '
            '{0}.get_login_url().'.format(self.__class__.__name__)
        )
    return force_text(login_url)

def get_permission_denied_message(self): AccessMixin

Override this method to override the permission_denied_message attribute.
31
32
33
34
35
def get_permission_denied_message(self):
    """
    Override this method to override the permission_denied_message attribute.
    """
    return self.permission_denied_message

def get_redirect_field_name(self): AccessMixin

Override this method to override the redirect_field_name attribute.
37
38
39
40
41
def get_redirect_field_name(self):
    """
    Override this method to override the redirect_field_name attribute.
    """
    return self.redirect_field_name

def get_test_func(self): UserPassesTestMixin

Override this method to use a different test_func method.
106
107
108
109
110
def get_test_func(self):
    """
    Override this method to use a different test_func method.
    """
    return self.test_func

def handle_no_permission(self): AccessMixin

43
44
45
46
def handle_no_permission(self):
    if self.raise_exception:
        raise PermissionDenied(self.get_permission_denied_message())
    return redirect_to_login(self.request.get_full_path(), self.get_login_url(), self.get_redirect_field_name())

def test_func(self): UserPassesTestMixin

101
102
103
104
def test_func(self):
    raise NotImplementedError(
        '{0} is missing the implementation of the test_func() method.'.format(self.__class__.__name__)
    )