Как использовать allow_required декораторы в представлениях на основе классов django - PullRequest
Новая
       75

Как использовать allow_required декораторы в представлениях на основе классов django

145 голосов
/ 20 мая 2011

У меня возникли проблемы с пониманием того, как работают новые CBV. Мой вопрос заключается в следующем: мне нужно требовать входа во все представления, а в некоторых из них - определенные разрешения. В функциональных представлениях я делаю это с помощью @permission_required () и атрибута login_required в представлении, но я не знаю, как это сделать в новых представлениях. Есть ли какой-то раздел в документации Django, объясняющий это? Я ничего не нашел. Что не так в моем коде?

Я пытался использовать @method_decorator, но он отвечает " TypeError в / space / 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

Ответы [ 11 ]

178 голосов
/ 20 мая 2011

Существует несколько стратегий, перечисленных в документах CBV :

  1. Добавьте декоратор в ваш urls.py маршрут , например, login_required(ViewSpaceIndex.as_view(..))

  2. Украсьте метод CBV dispatch с помощью method_decorator например, 

    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)

  3. Используйте миксины доступа, такие как django.contrib.auth.mixins.LoginRequiredMixin , доступные в Django 1.9+ и хорошо изложенные в других ответах здесь: 

    from django.contrib.auth.mixins import LoginRequiredMixin

class MyView(LoginRequiredMixin, View):

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

Причина получения TypeError объясняется в документации:

Примечание: method_decorator передает * args и ** kwargs в качестве параметров оформленному методу класса. Если ваш метод не принимает совместимый набор параметров, он вызовет исключение TypeError.

115 голосов
/ 23 июня 2011

Вот мой подход: я создаю защищенный миксина (он хранится в моей библиотеке миксинов): 

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)

Когда вы хотите, чтобы представление было защищено, вы просто добавляете соответствующий миксин: 

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

Просто убедитесь, что ваш миксин первый.

Обновление: Я опубликовал это в далеком 2011 году, начиная с версии 1.9Django теперь включает этот и другие полезные миксины (AccessMixin, PermissionRequiredMixin, UserPassesTestMixin) как стандарт!

45 голосов
/ 08 декабря 2011

Вот альтернативный вариант использования декораторов на основе классов: 

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
14 голосов
/ 02 марта 2016

Для тех из вас, кто использует Django> = 1,9 , он уже включен в django.contrib.auth.mixins как AccessMixin, LoginRequiredMixin, PermissionRequiredMixin и UserPassesTestMixin.

Таким образом, чтобы применить 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: Mixins должен идти со стороны left , а базовый вид должен идти в правая сторона. Если порядок отличается, вы можете получить непредсказуемые результаты.

14 голосов
/ 17 июля 2012

Я понимаю, что эта тема немного устарела, но все равно вот мои два цента.

со следующим кодом: 

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 написана для изменения представления (на основе функции), так что оно вызывает ошибку 404 всякий раз, когда это представление посещается не-ajax-вызовом. Просто применяя функцию patch в качестве декоратора, этот декоратор также может работать в представлениях на основе классов

4 голосов
/ 19 апреля 2014

Используйте Django Braces. Он предоставляет много полезных миксинов, которые легко доступны. У него есть красивые документы. Попробуйте это.

Вы даже можете создавать свои собственные миксины.

http://django -braces.readthedocs.org / ен / 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({})
4 голосов
/ 15 сентября 2013

Если это сайт, на котором большинство страниц требует входа пользователя в систему, вы можете использовать промежуточное ПО для принудительного входа в систему для всех представлений , за исключением , некоторые из которых отмечены особо.

Pre Django 1.10 middleware.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)

views.py: 

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

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

Сторонние представления, которые вы не хотите переносить, могут быть исключены в настройках:

settings.py: 

LOGIN_EXEMPT_URL_PREFIXES = ('/login/', '/reset_password/')
3 голосов
/ 30 ноября 2014

В моем коде я написал этот адаптер для адаптации функций-членов к функции, не являющейся членом: 

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')
1 голос
/ 12 апреля 2018

Это очень просто с django> 1.9 с поддержкой PermissionRequiredMixin и LoginRequiredMixin

Просто импортируйте из auth

views.py 

from django.contrib.auth.mixins import LoginRequiredMixin

class YourListView(LoginRequiredMixin, Views):
    pass

Подробнее см. Авторизация в django

0 голосов
/ 04 декабря 2015

Я сделал это исправление на основе решения Джоша 

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
Страница:
...