Context Navigation

Ticket #14773: listview-custom-paginator.diff

File listview-custom-paginator.diff, 4.0 KB (added by Benjamin Wohlwend, 15 years ago)

diff --git a/django/views/generic/list.py b/django/views/generic/list.py
index ef90d75..eaa06a8 100644

                class MultipleObjectMixin(object):
     model = None
     paginate_by = None
     context_object_name = None
+    paginator_class = Paginator
     def get_queryset(self):
         """
-…
+               class MultipleObjectMixin(object):
         Paginate the queryset, if needed.
         """
         if queryset.count() > page_size:
             paginator = Paginator(queryset, page_size, allow_empty_first_page=self.get_allow_empty())
+            paginator = self.paginator_class(queryset, page_size, allow_empty_first_page=self.get_allow_empty())
             page = self.kwargs.get('page', None) or self.request.GET.get('page', 1)
             try:
                 page_number = int(page)

diff --git a/docs/ref/class-based-views.txt b/docs/ref/class-based-views.txt
index ada25a6..9609b76 100644

                MultipleObjectMixin
         expect either a ``page`` query string parameter (via ``GET``) or a
         ``page`` variable specified in the URLconf.
+    .. attribute:: paginator_class
+       The paginator class to be used for pagination. By default,
+       :class:`django.core.paginator.Paginator` is used. Custom paginator classes have to conform to
+       the interface defined by that class.
     .. attribute:: context_object_name
         Designates the name of the variable to use in the context.

diff --git a/tests/regressiontests/generic_views/list.py b/tests/regressiontests/generic_views/list.py
index 8f6af74..622fc06 100644

                from django.core.exceptions import ImproperlyConfigured
 from django.test import TestCase
 from regressiontests.generic_views.models import Author
+from regressiontests.generic_views.views import CustomPaginator
 class ListViewTests(TestCase):
     fixtures = ['generic-views-test-data.json']
-…
+               class ListViewTests(TestCase):
         self._make_authors(100)
         res = self.client.get('/list/authors/paginated/?page=frog')
         self.assertEqual(res.status_code, 404)
+    def test_paginated_custom_paginator(self):
+        self._make_authors(10)
+        res = self.client.get('/list/authors/paginated/custom/')
+        self.assertIs(res.context['paginator'].__class__, CustomPaginator)
     def test_allow_empty_false(self):
         res = self.client.get('/list/authors/notempty/')

diff --git a/tests/regressiontests/generic_views/urls.py b/tests/regressiontests/generic_views/urls.py
index 61f0387..8ed9776 100644

                urlpatterns = patterns('',
         views.AuthorList.as_view(context_object_name='object_list')),
     (r'^list/authors/invalid/$',
         views.AuthorList.as_view(queryset=None)),
+    (r'^list/authors/paginated/custom/$',
+        views.AuthorListCustomPaginator.as_view()),
     # YearArchiveView
     # Mixing keyword and possitional captures below is intentional; the views

diff --git a/tests/regressiontests/generic_views/views.py b/tests/regressiontests/generic_views/views.py
index eacfb71..6d63496 100644

-              a
 from django.contrib.auth.decorators import login_required
+from django.core.paginator import Paginator
 from django.core.urlresolvers import reverse
 from django.utils.decorators import method_decorator
 from django.views import generic
-…
+               class AuthorList(generic.ListView):
     queryset = Author.objects.all()
+class CustomPaginator(Paginator): pass
+class AuthorListCustomPaginator(AuthorList):
+    paginator_class = CustomPaginator
+    paginate_by = 5
 class ArtistCreate(generic.CreateView):
     model = Artist