class UserPassesTestMixin
from django.contrib.auth.mixins import UserPassesTestMixin
Deny a request with a permission error if the test_func() method returns False.
Ancestors (MRO)
- UserPassesTestMixin
- AccessMixin
Attributes
Defined in | |
---|---|
login_url = None
|
AccessMixin |
permission_denied_message = ''
|
AccessMixin |
raise_exception = False
|
AccessMixin |
redirect_field_name = 'next'
|
AccessMixin |
Methods
def
dispatch(self, request, *args, **kwargs):
UserPassesTestMixin
¶
def
dispatch(self, request, *args, **kwargs):
UserPassesTestMixin
¶
124 125 126 127 128 | 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().dispatch(request, *args, **kwargs) |
def
get_login_url(self):
AccessMixin
¶
def
get_login_url(self):
AccessMixin
¶
Override this method to override the login_url attribute.
20 21 22 23 24 25 26 27 28 29 30 | 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 str(login_url) |
def
get_permission_denied_message(self):
AccessMixin
¶
def
get_permission_denied_message(self):
AccessMixin
¶
Override this method to override the permission_denied_message attribute.
32 33 34 35 36 | 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
¶
def
get_redirect_field_name(self):
AccessMixin
¶
Override this method to override the redirect_field_name attribute.
38 39 40 41 42 | 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
¶
def
get_test_func(self):
UserPassesTestMixin
¶
Override this method to use a different test_func method.
118 119 120 121 122 | 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
¶
def
handle_no_permission(self):
AccessMixin
¶
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | def handle_no_permission(self): if self.raise_exception or self.request.user.is_authenticated: raise PermissionDenied(self.get_permission_denied_message()) path = self.request.build_absolute_uri() resolved_login_url = resolve_url(self.get_login_url()) # If the login url is the same scheme and net location then use the # path as the "next" url. login_scheme, login_netloc = urlparse(resolved_login_url)[:2] current_scheme, current_netloc = urlparse(path)[:2] if ( (not login_scheme or login_scheme == current_scheme) and (not login_netloc or login_netloc == current_netloc) ): path = self.request.get_full_path() return redirect_to_login( path, resolved_login_url, self.get_redirect_field_name(), ) |
def
test_func(self):
UserPassesTestMixin
¶
def
test_func(self):
UserPassesTestMixin
¶
113 114 115 116 | def test_func(self): raise NotImplementedError( '{} is missing the implementation of the test_func() method.'.format(self.__class__.__name__) ) |