PermissionRequiredMixin¶

Checks for permission to access a view. If a user is unauthorised, request is redirected to login page.

Usage:

from django.views.generic import ListView
from dj_extensions.views import PermissionsRequiredMixin

class SomeView(PermissionsRequiredMixin, ListView):
    model                = YourModel
    required_permissions = ('app.permission1')

You can check for more than one permission too

from django.views.generic import ListView
from dj_extensions.views import PermissionsRequiredMixin

class SomeView(PermissionsRequiredMixin, ListView):
    model                = YourModel
    required_permissions = (
                            'app.permission1',
                            'app.permission2',
                           )

The variable required_permissions is required.

AjaxOnlyMixin¶

This mixin allows only the ajax requests and returns HttpForbiddenError if the request is not ajax.

Usage:

from django.views.generic import TemplateView
from dj_extensions.views import AjaxOnlyMixin

class SomeView(AjaxOnlyMixin, TemplateView):
    # your custom code

PaginationMixin¶

Google style paginations for your django list views.

This mixin provides list of links to previous and next n_list number of pages, in addition to just previous and next links provided by default.

Usage:

from django.views.generic import ListView
from dj_extensions.views import PaginationMixin

class SomeView(PaginationMixin, ListView):
    model                = YourModel
    paginate_by          = 10
    n_list               = 5

Default values are

paginate_by = 5
n_list      = 4

In your template for this view, add the following lines:

<nav>
  <ul class="pagination">
    {% if page_obj.has_previous %}
      <li><a href="?page={{ page_obj.previous_page_number }}" aria-label="Previous"><span aria-hidden="true">&laquo;</span></a></li>
      {% for i in page_obj.paginator.page_range|slice:page_dict.prev %}
        <li><a href="?page={{ i }}">{{ i }}</a></li>
      {% endfor %}
    {% else %}
      <li><a href="javascript:;" aria-label="Previous"><span aria-hidden="true">&laquo;</span></a></li>
    {% endif %}
    <li class="active"><a href="javascript:;"> {{ page_obj.number }} <span class="sr-only">(current)</span></a></li>
    {% if page_obj.has_next %}
      {% for i in page_obj.paginator.page_range|slice:page_dict.next %}
        <li><a href="?page={{ i }}">{{ i }}</a></li>
      {% endfor %}
      <li><a href="?page={{ page_obj.next_page_number }}"><span aria-hidden="true">&raquo;</span></a></li>
    {% else %}
      <li><a href="javascript:;" aria-label="Next"><span aria-hidden="true">&raquo;</span></a></li>
    {% endif %}
  </ul>
</nav>

FilterMixin¶

This mixin is used filter your list view based on query strings from http requests

Usage:

from django.views.generic import ListView
from dj_extensions.views import FilterMixin

class SomeView(FilterMixin, ListView):
    model                = YourModel
    allowed_filters      = {
                            'name': 'emp_name__icontains',
                            'age' : 'age_exact',
                           }

The key of the allowed_filters dict is the query string and value is the django ORM filter opertation.

For example, the request http://localhost:8000/some_view?name=foo&age=21 will perform

YourModel.objects.filter(emp_name_icontains='foo').filter(age_exact=21)

Combine Multiple Mixins¶

You can combine multiple mixins if required.

For example, there may be a use-case where you want your list view to be paginated, check for permissions and support filtering as well. For this case your view class will be:

from dj_extensions.views import PermissionsRequiredMixin, FilterMixin, PaginationMixin

class SomeView(PermissionsRequiredMixin, FilterMixin, PaginationMixin, ListView):
    model                = YourModel
    paginate_by          = 10
    n_list               = 5
    required_permissions = (
                            'app.permission1',
                            'app.permission2',
                           )
    allowed_filters      = {
                            'name': 'emp_name__icontains',
                            'age' : 'age_exact',
                           }

v0.1.6¶

Initial release.

Started with four view mixins:

• PermissionsRequiredMixin
• AjaxOnlyMixin
• PaginationMixin
• FilterMixin

The initial release started from v0.1.6, not v0.1 or v0.1.1

meta-info¶

dj_extensions.__version__¶

To get installed version of dj_extensions

views¶

class dj_extensions.views.PermissionsRequiredMixin[source]¶

For django versions <1.9.

django >= 1.9 supports this by default.

Mixin checks for required permissions for the view to authenticate users.

class dj_extensions.views.AjaxOnlyMixin[source]¶

Mixin throws HttpResponseForbidden error if request is not ajax.

class dj_extensions.views.PaginationMixin[source]¶

Mixin for google style paginations.

class dj_extensions.views.FilterMixin[source]¶

Mixin for filtering List view based on http request query strings.