web-dev-qa-db-ja.com

Djangoクラスベースビューでpermission_requiredデコレータを使用する方法

新しいCBVの仕組みを理解するのに少し苦労しています。私の質問はこれです。すべてのビューでログインを要求する必要があります。一部のビューでは特定のアクセス許可が必要です。関数ベースのビューでは、ビューの@permission_required()およびlogin_required属性を使用してこれを行いますが、新しいビューでこれを行う方法はわかりません。 Djangoドキュメントにこれを説明するセクションがありますか?何も見つかりませんでした。私のコードの何が問題になっていますか?

@method_decoratorを使用しようとしましたが、「Typespace 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
147
Oscar Carballal

これが私のアプローチです。保護されたミックスインを作成します(これはミックスインライブラリに保持されます)。

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'

ミックスインが最初であることを確認してください。

更新:バージョン1.9から2011年に投稿しました。Djangoには、これとその他の便利なミックスイン(AccessMixin、PermissionRequiredMixin、UserPassesTestMixin)が標準で含まれています。

115
Gert Steyn

クラスベースのデコレータを使用する代替手段は次のとおりです。

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
45
mjtamlyn

Django> = 1.9を使用している場合は、すでにDjango.contrib.auth.mixinsAccessMixinLoginRequiredMixinPermissionRequiredMixin および 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 Mixinの順序を覚えておくと良いでしょう:Mixinsleft側に移動しbase viewクラスは、right側に配置する必要があります。順序が異なる場合、破損した予測不能な結果が生じる可能性があります。

14
vishes_shell

私はこのスレッドが少し時代遅れであることを理解していますが、とにかくここに私の2セントがあります。

次のコードで:

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エラーが発生します。パッチ関数をデコレータとして適用するだけで、このデコレータはすべてクラスベースのビューでも機能するように設定されます。

14
mephisto

Djangoブレースを使用します。簡単に利用できる便利な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({})
4
shap4th

ほとんどのページでユーザーのログインが必要なサイトの場合、ミドルウェアを使用してすべてのビューで強制的にログインできますexcept特にマークされているユーザー。

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/')
4
kaleissin

私のコードでは、メンバー関数を非メンバー関数に適合させるためにこのアダプターを作成しました。

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')
3
rabbit.aaron

これはDjango> 1.9でPermissionRequiredMixinおよびLoginRequiredMixinのサポートが付属しているため非常に簡単です。

認証からインポートするだけ

views.py

from Django.contrib.auth.mixins import LoginRequiredMixin

class YourListView(LoginRequiredMixin, Views):
    pass

詳細については、 Djangoでの認証 を参照してください。

1
Amar

さまざまな許可テストを必要とするプロジェクトを実行している場合、このクラスを継承できます。

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)

私はジョシュのソリューションに基づいてその修正を行いました

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
0
Ramast