Django के क्लास-आधारित विचारों पर अनुमति प्राप्त सजावटकर्ताओं का उपयोग कैसे करें


161

मुझे यह समझने में थोड़ी परेशानी हो रही है कि नए CBV कैसे काम करते हैं। मेरा सवाल यह है, मुझे सभी दृश्यों में लॉगिन की आवश्यकता है, और उनमें से कुछ में, विशिष्ट अनुमतियाँ। फ़ंक्शन-आधारित विचारों में, मैं उस दृश्य में @permission_required () और login_required विशेषता के साथ ऐसा करता हूं, लेकिन मुझे नहीं पता कि नए विचारों पर यह कैसे करना है। क्या इसको समझाने वाले django डॉक्स में कुछ सेक्शन है? मुझे कुछ नहीं मिला। मेरे कोड में क्या गलत है?

मैंने @method_decorator का उपयोग करने की कोशिश की, लेकिन यह उत्तर देता है " TypeError at / रिक्त स्थान / 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

जवाबों:


211

सीबीवी डॉक्स में सूचीबद्ध कुछ रणनीतियाँ हैं :

urls.pyजब आप अपने दृश्य को त्वरित करते हैं , तो प्रति-दृश्य आधार पर दृश्य को सजाने के लिए ( डॉक्स )

urlpatterns = [
    path('view/',login_required(ViewSpaceIndex.as_view(..)),
    ...
]

डेकोरेटर को प्रति-आवृत्ति के आधार पर लागू किया जाता है, इसलिए आप इसे आवश्यकतानुसार जोड़ सकते हैं या अलग-अलग urls.pyमार्गों में निकाल सकते हैं ।

अपने वर्ग को सजाने के लिए आपके विचार के हर उदाहरण को डेकोरेटर ( डॉक्स ) द्वारा लपेटा जाएगा।

ऐसा करने के दो तरीके हैं:

  1. एक को लागू करने method_decoratorके लिए अपने CBV प्रेषण विधि जैसे करने के लिए,

    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)
  1. आधुनिक Django (2.2+) में एक सामान्य अभ्यास django.contrib.auth.mixins जैसे उपयोग मिश्रणों का उपयोग करना है। 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 पास करता है। यदि आपकी विधि मापदंडों के संगत सेट को स्वीकार नहीं करती है तो यह टाइप-इयर अपवाद को बढ़ा देगा।


3
यहां नवीनतम डॉक्स dj.djangoproject.com/en/dev/topics/class-based-views/intro
भारथवाज

messageइसे कैसे जोड़ा जाए?
औरिलाबस

उन लोगों के लिए जो समझ में नहीं आए (जैसे मैंने पहले किया था) - 'डिस्पैच' पद्धति को व्यूस्पेसइंडेक्स क्लास में जोड़ा जाना चाहिए
o_c

क्या इन तरीकों में से किसी एक का दूसरे पर एहसान करने का कोई कारण है?
एलिस्टेयर

@ सूची मुझे लगता है कि यह व्यक्तिगत प्राथमिकता और आपकी टीम / संगठन के भीतर कोडबेस स्थिरता बनाए रखने के लिए उबालता है। मैं व्यक्तिगत रूप से मिक्सिन दृष्टिकोण की ओर रुख कर रहा हूँ अगर मैं वर्ग आधारित विचारों का निर्माण कर रहा हूँ।
एक ली

118

यहां मेरा दृष्टिकोण है, मैं एक मिश्रण बनाता हूं जो संरक्षित है (यह मेरे मिश्रण पुस्तकालय में रखा गया है):

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.9 Django के साथ शुरू हुआ जिसमें अब यह और अन्य उपयोगी मिश्रण शामिल हैं (AccessMixin, PermissionRequiredMixin, UserPassesTestMixin) मानक के रूप में!


क्या इस तरह के मिश्रणों के कई होना संभव है? यह मेरे लिए काम नहीं किया और मुझे नहीं लगता कि यह समझ में आता है।
पाइकलर

हां, कई मिश्रणों का होना संभव है क्योंकि प्रत्येक मिक्सिन सुपर को कॉल करता है जो एमआरओ के अनुसार अगली कक्षा को चुनता है
हॉब्लिन

मुझे लगता है कि यह एक सुंदर समाधान है; मुझे अपने urls.py में सज्जाकारों का एक मिश्रण और view.py में मिश्रण पसंद नहीं है। यह डेकोरेटर्स को लपेटने का एक तरीका है जो उस तर्क के सभी दृश्य को आगे बढ़ाएगा।
धाकनर

1
django- ब्रेसिज़ में यह (और अधिक)
मिक्सिन्स होता है

मेरे जैसे पूर्ण मंदता मोड में लोगों के लिए बस एक नोट: यह सुनिश्चित करें कि जब आप login_required कार्यक्षमता का परीक्षण कर रहे हैं, तो आप लॉग इन नहीं हैं ...
Visgean Skeloru

46

यहां क्लास बेस्ड डेकोरेटर्स का उपयोग कर एक विकल्प दिया गया है:

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

3
आप श्रृंखला को सजाने के लिए उपयोग कर सकते हैं सज्जाकार, अच्छी तरह से! +1
पायलियर

9
यह इतना बढ़िया है कि इसे अपस्ट्रीम IMO में शामिल करने पर विचार किया जाना चाहिए।
koniiiik

मुझे यह पसंद है! Im सोच रहा था कि क्या arg / kwargs को class_view_decorator से function_decorator तक पहुंचाना संभव है ??? यह बहुत अच्छा होगा यदि login_decorator सशर्त अनुरोध को कह सकता है। METHOD तो यह केवल पोस्ट के लिए लागू होता है?
माइक वेट

1
आर्ग / क्वार्ग्स का उपयोग करके आसानी से प्राप्त किया जाना चाहिए class_view_decorator(my_decorator(*args, **kwargs))। सशर्त विधि मिलान के लिए - आप खुद को View.getया View.postइसके बजाय लागू करने के लिए class_view_decorator को संशोधित कर सकते हैं View.dispatch
mjtamlyn

14

मुझे पता है कि यह धागा थोड़ा दिनांकित है, लेकिन यहाँ मेरे दो सेंट वैसे भी हैं।

निम्नलिखित कोड के साथ:

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 त्रुटि उठाता है। बस पैच फ़ंक्शन को डेकोरेटर के रूप में लागू करके, यह डेकोरेटर क्लास आधारित दृश्यों में भी काम करने के लिए तैयार है


14

आप में से जो लोग उपयोग Django> = 1.9 , यह पहले से ही में शामिल है django.contrib.auth.mixinsके रूप में AccessMixin, LoginRequiredMixin, PermissionRequiredMixinऔर UserPassesTestMixin

तो सीबीवी (जैसे DetailView) के लिए LoginRequired लागू करने के लिए :

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 मिक्सिन ऑर्डर को ध्यान में रखना भी अच्छा है: मिक्सिन्स को बाईं ओर जाना चाहिए , और बेस व्यू क्लास को राइट साइड में जाना चाहिए । यदि आदेश अलग है, तो आप टूटे और अप्रत्याशित परिणाम प्राप्त कर सकते हैं।


2
यह 2019 में सबसे अच्छा जवाब है। इसके अलावा, मिक्सिन ऑर्डर के बारे में शानदार बात।
क्रिश्चियन लॉन्ग

5

Django ब्रेसिज़ का उपयोग करें। यह बहुत सारे उपयोगी मिश्रण प्रदान करता है जो आसानी से उपलब्ध है। इसमें खूबसूरत डॉक्स हैं। कोशिश करके देखो।

तुम भी अपने कस्टम मिश्रण बना सकते हैं।

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

यदि यह एक ऐसी साइट है जहाँ अधिकांश पृष्ठों पर उपयोगकर्ता को लॉग इन करने की आवश्यकता होती है, तो आप विशेष रूप से चिह्नित कुछ को छोड़कर सभी दृश्यों पर लॉगिन को बाध्य करने के लिए एक मिडलवेयर का उपयोग कर सकते हैं ।

प्री जोंगो 1.10 मिडलवेयर एरोमाड:

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

मेरे कोड में मैंने इस एडॉप्टर को गैर-सदस्य फ़ंक्शन के लिए सदस्य फ़ंक्शन को अनुकूलित करने के लिए लिखा है:

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')

यह अच्छा होगा कि यह Django (बिलकुल जैसा method_decoratorहै) पर बिल्ट-इन था । यह इसे प्राप्त करने का एक अच्छा और पठनीय तरीका लगता है।
मारियससुरम

1

यह django> 1.9 के लिए समर्थन के साथ आ रहा है PermissionRequiredMixinऔर के साथ सुपर आसान हैLoginRequiredMixin

बस से आयात करें

views.py

from django.contrib.auth.mixins import LoginRequiredMixin

class YourListView(LoginRequiredMixin, Views):
    pass

अधिक जानकारी के लिए django में प्राधिकरण पढ़ें


1

अभी कुछ समय हुआ है और अब Django बहुत बदल गया है।

क्लास-आधारित दृश्य को कैसे सजाने के लिए यहां देखें।

https://docs.djangoproject.com/en/2.2/topics/class-based-views/intro/#decorating-the-class

प्रलेखन में "डेकोरेटर्स का तर्क शामिल नहीं है जो किसी भी तर्क को लेता है"। लेकिन तर्क देने वाले सज्जाकार इस तरह हैं:

def mydec(arg1):
    def decorator(func):
         def decorated(*args, **kwargs):
             return func(*args, **kwargs) + arg1
         return decorated
    return deocrator

इसलिए अगर हम mydec को तर्कों के बिना "सामान्य" डेकोरेटर के रूप में उपयोग करते हैं, तो हम यह कर सकते हैं:

mydecorator = mydec(10)

@mydecorator
def myfunc():
    return 5

तो इसी तरह, के permission_requiredसाथ उपयोग करने के लिएmethod_decorator

हम कर सकते हैं:

@method_decorator(permission_required("polls.can_vote"), name="dispatch")
class MyView:
    def get(self, request):
        # ...

0

यदि आप ऐसी परियोजना कर रहे हैं, जिसमें विभिन्न प्रकार के अनुमति परीक्षणों की आवश्यकता होती है, तो आप इस श्रेणी को प्राप्त कर सकते हैं।

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)

0

मैंने जोश के समाधान के आधार पर यह तय किया है

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

यहां अनुमति के लिए समाधान_आयातित सज्जाकार:

class CustomerDetailView(generics.GenericAPIView):

@method_decorator(permission_required('app_name.permission_codename', raise_exception=True))
    def post(self, request):
        # code...
        return True
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.