get_object_from_classbased_instance() - Code Metrics - lambdalisue/django-permission - Measure and Improve Code Quality continuously with Scrutinizer

get_object_from_classbased_instance() F
last analyzed 2017-03-28 05:50 UTC

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
c	1
b	0
f	0
dl	0
loc	52
rs	3.8571

How to fix Long Method Complexity

# coding=utf-8
"""
permission_required decorator for generic classbased view from django 1.3
"""
from functools import wraps
from django.utils.decorators import available_attrs
from django.core.exceptions import PermissionDenied
from permission.decorators.utils import redirect_to_login


def permission_required(perm, queryset=None,
                        login_url=None, raise_exception=False):
    """
    Permission check decorator for classbased generic view

    This decorator works as class decorator
    DO NOT use ``method_decorator`` or whatever while this decorator will use
    ``self`` argument for method of classbased generic view.

    Parameters
    ----------
    perm : string
        A permission string
    queryset : queryset or model
        A queryset or model for finding object.
        With classbased generic view, ``None`` for using view default queryset.
        When the view does not define ``get_queryset``, ``queryset``,
        ``get_object``, or ``object`` then ``obj=None`` is used to check
        permission.
        With functional generic view, ``None`` for using passed queryset.
        When non queryset was passed then ``obj=None`` is used to check
        permission.

    Examples
    --------
    >>> @permission_required('auth.change_user')
    >>> class UpdateAuthUserView(UpdateView):
    ...     pass
    """
    def wrapper(cls):
        def view_wrapper(view_func):
            @wraps(view_func, assigned=available_attrs(view_func))
            def inner(self, request, *args, **kwargs):
                # get object
                obj = get_object_from_classbased_instance(
                        self, queryset, request, *args, **kwargs
                    )

                if not request.user.has_perm(perm, obj=obj):
                    if raise_exception:
                        raise PermissionDenied
                    else:
                        return redirect_to_login(request, login_url)
                return view_func(self, request, *args, **kwargs)
            return inner
        cls.dispatch = view_wrapper(cls.dispatch)
        return cls
    return wrapper


def get_object_from_classbased_instance(
        instance, queryset, request, *args, **kwargs):
    """
    Get object from an instance of classbased generic view

    Parameters
    ----------
    instance : instance
        An instance of classbased generic view
    queryset : instance
        A queryset instance
    request : instance
        A instance of HttpRequest

    Returns
    -------
    instance
        An instance of model object or None
    """
    from django.views.generic.edit import BaseCreateView
    # initialize request, args, kwargs of classbased_instance
    # most of methods of classbased view assumed these attributes
    # but these attributes is initialized in ``dispatch`` method.
    instance.request = request
    instance.args = args
    instance.kwargs = kwargs

    # get queryset from class if ``queryset_or_model`` is not specified
    if hasattr(instance, 'get_queryset') and not queryset:
        queryset = instance.get_queryset()
    elif hasattr(instance, 'queryset') and not queryset:
        queryset = instance.queryset
    elif hasattr(instance, 'model') and not queryset:
        queryset = instance.model._default_manager.all()

    # get object
    if hasattr(instance, 'get_object'):
        try:
            obj = instance.get_object(queryset)
        except AttributeError as e:
            # CreateView has ``get_object`` method but CreateView
            # should not have any object before thus simply set
            # None
            if isinstance(instance, BaseCreateView):
                obj = None
            else:
                raise e
    elif hasattr(instance, 'object'):
        obj = instance.object
    else:
        obj = None
    return obj



1			# coding=utf-8
2			"""
3			permission_required decorator for generic classbased view from django 1.3
4			"""
5			from functools import wraps
6			from django.utils.decorators import available_attrs
7			from django.core.exceptions import PermissionDenied
8			from permission.decorators.utils import redirect_to_login
9
10
11			def permission_required(perm, queryset=None,
12			login_url=None, raise_exception=False):
13			"""
14			Permission check decorator for classbased generic view
15
16			This decorator works as class decorator
17			DO NOT use ``method_decorator`` or whatever while this decorator will use
18			``self`` argument for method of classbased generic view.
19
20			Parameters
21			----------
22			perm : string
23			A permission string
24			queryset : queryset or model
25			A queryset or model for finding object.
26			With classbased generic view, ``None`` for using view default queryset.
27			When the view does not define ``get_queryset``, ``queryset``,
28			``get_object``, or ``object`` then ``obj=None`` is used to check
29			permission.
30			With functional generic view, ``None`` for using passed queryset.
31			When non queryset was passed then ``obj=None`` is used to check
32			permission.
33
34			Examples
35			--------
36			>>> @permission_required('auth.change_user')
37			>>> class UpdateAuthUserView(UpdateView):
38			... pass
39			"""
40			def wrapper(cls):
41			def view_wrapper(view_func):
42			@wraps(view_func, assigned=available_attrs(view_func))
43			def inner(self, request, args, *kwargs):
44			# get object
45			obj = get_object_from_classbased_instance(
46			self, queryset, request, args, *kwargs
47			)
48
49			if not request.user.has_perm(perm, obj=obj):
50			if raise_exception:
51			raise PermissionDenied
52			else:
53			return redirect_to_login(request, login_url)
54			return view_func(self, request, args, *kwargs)
55			return inner
56			cls.dispatch = view_wrapper(cls.dispatch)
57			return cls
58			return wrapper
59
60
61			def get_object_from_classbased_instance(
62			instance, queryset, request, args, *kwargs):
63			"""
64			Get object from an instance of classbased generic view
65
66			Parameters
67			----------
68			instance : instance
69			An instance of classbased generic view
70			queryset : instance
71			A queryset instance
72			request : instance
73			A instance of HttpRequest
74
75			Returns
76			-------
77			instance
78			An instance of model object or None
79			"""
80			from django.views.generic.edit import BaseCreateView
81			# initialize request, args, kwargs of classbased_instance
82			# most of methods of classbased view assumed these attributes
83			# but these attributes is initialized in ``dispatch`` method.
84			instance.request = request
85			instance.args = args
86			instance.kwargs = kwargs
87
88			# get queryset from class if ``queryset_or_model`` is not specified
89			if hasattr(instance, 'get_queryset') and not queryset:
90			queryset = instance.get_queryset()
91			elif hasattr(instance, 'queryset') and not queryset:
92			queryset = instance.queryset
93			elif hasattr(instance, 'model') and not queryset:
94			queryset = instance.model._default_manager.all()
95
96			# get object
97			if hasattr(instance, 'get_object'):
98			try:
99			obj = instance.get_object(queryset)
100			except AttributeError as e:
101			# CreateView has ``get_object`` method but CreateView
102			# should not have any object before thus simply set
103			# None
104			if isinstance(instance, BaseCreateView):
105			obj = None
106			else:
107			raise e
108			elif hasattr(instance, 'object'):
109			obj = instance.object
110			else:
111			obj = None
112			return obj
113
114

lambdalisue / django-permission

GitHub Access Token became invalid

get_object_from_classbased_instance() F last analyzed 2017-03-28 05:50 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like

get_object_from_classbased_instance() F
last analyzed 2017-03-28 05:50 UTC