--- /dev/null
- autopaginate SOMETHING [PAGINATE_BY] [ORPHANS] [as NAME]
+try:
+ set
+except NameError:
+ from sets import Set as set
+
+from django import template
+from django.template import TOKEN_BLOCK
+from django.http import Http404
+from django.core.paginator import Paginator, InvalidPage
+from django.conf import settings
+
+register = template.Library()
+
+DEFAULT_PAGINATION = getattr(settings, 'PAGINATION_DEFAULT_PAGINATION', 20)
+DEFAULT_WINDOW = getattr(settings, 'PAGINATION_DEFAULT_WINDOW', 4)
++DEFAULT_MARGIN = getattr(settings, 'PAGINATION_DEFAULT_MARGIN', DEFAULT_WINDOW)
+DEFAULT_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0)
+INVALID_PAGE_RAISES_404 = getattr(settings,
+ 'PAGINATION_INVALID_PAGE_RAISES_404', False)
+DISPLAY_PAGE_LINKS = getattr(settings, 'PAGINATION_DISPLAY_PAGE_LINKS', True)
+PREVIOUS_LINK_DECORATOR = getattr(settings, 'PAGINATION_PREVIOUS_LINK_DECORATOR', "‹‹ ")
+NEXT_LINK_DECORATOR = getattr(settings, 'PAGINATION_NEXT_LINK_DECORATOR', " ››")
+DISPLAY_DISABLED_PREVIOUS_LINK = getattr(settings, 'PAGINATION_DISPLAY_DISABLED_PREVIOUS_LINK', False)
+DISPLAY_DISABLED_NEXT_LINK = getattr(settings, 'PAGINATION_DISPLAY_DISABLED_NEXT_LINK', False)
+
++
+def do_autopaginate(parser, token):
+ """
+ Splits the arguments to the autopaginate tag and formats them correctly.
+
+ Syntax is:
+
- def paginate(context, window=DEFAULT_WINDOW):
++ autopaginate QUERYSET [PAGINATE_BY] [ORPHANS] [as NAME]
+ """
+ # Check whether there are any other autopaginations are later in this template
+ expr = lambda obj: (obj.token_type == TOKEN_BLOCK and \
+ len(obj.split_contents()) > 0 and obj.split_contents()[0] == "autopaginate")
+ multiple_paginations = len(filter(expr, parser.tokens)) > 0
+
+ i = iter(token.split_contents())
+ paginate_by = None
+ queryset_var = None
+ context_var = None
+ orphans = None
+ word = None
+ try:
+ word = i.next()
+ assert word == "autopaginate"
+ queryset_var = i.next()
+ word = i.next()
+ if word != "as":
+ paginate_by = word
+ try:
+ paginate_by = int(paginate_by)
+ except ValueError:
+ pass
+ word = i.next()
+ if word != "as":
+ orphans = word
+ try:
+ orphans = int(orphans)
+ except ValueError:
+ pass
+ word = i.next()
+ assert word == "as"
+ context_var = i.next()
+ except StopIteration:
+ pass
+ if queryset_var is None:
+ raise template.TemplateSyntaxError(
+ "Invalid syntax. Proper usage of this tag is: "
+ "{%% autopaginate QUERYSET [PAGINATE_BY] [ORPHANS]"
+ " [as CONTEXT_VAR_NAME] %%}"
+ )
+ return AutoPaginateNode(queryset_var, multiple_paginations, paginate_by, orphans, context_var)
+
+
+class AutoPaginateNode(template.Node):
+ """
+ Emits the required objects to allow for Digg-style pagination.
+
+ First, it looks in the current context for the variable specified, and using
+ that object, it emits a simple ``Paginator`` and the current page object
+ into the context names ``paginator`` and ``page_obj``, respectively.
+
+ It will then replace the variable specified with only the objects for the
+ current page.
+
+ .. note::
+
+ It is recommended to use *{% paginate %}* after using the autopaginate
+ tag. If you choose not to use *{% paginate %}*, make sure to display the
+ list of available pages, or else the application may seem to be buggy.
+ """
+ def __init__(self, queryset_var, multiple_paginations, paginate_by=None,
+ orphans=None, context_var=None):
+ if paginate_by is None:
+ paginate_by = DEFAULT_PAGINATION
+ if orphans is None:
+ orphans = DEFAULT_ORPHANS
+ self.queryset_var = template.Variable(queryset_var)
+ if isinstance(paginate_by, int):
+ self.paginate_by = paginate_by
+ else:
+ self.paginate_by = template.Variable(paginate_by)
+ if isinstance(orphans, int):
+ self.orphans = orphans
+ else:
+ self.orphans = template.Variable(orphans)
+ self.context_var = context_var
+ self.multiple_paginations = multiple_paginations
+
+ def render(self, context):
+ if self.multiple_paginations or context.has_key('paginator'):
+ page_suffix = '_%s' % self.queryset_var
+ else:
+ page_suffix = ''
+
+ key = self.queryset_var.var
+ value = self.queryset_var.resolve(context)
+ if isinstance(self.paginate_by, int):
+ paginate_by = self.paginate_by
+ else:
+ paginate_by = self.paginate_by.resolve(context)
+ if isinstance(self.orphans, int):
+ orphans = self.orphans
+ else:
+ orphans = self.orphans.resolve(context)
+ paginator = Paginator(value, paginate_by, orphans)
+ try:
+ page_obj = paginator.page(context['request'].page(page_suffix))
+ except InvalidPage:
+ if INVALID_PAGE_RAISES_404:
+ raise Http404('Invalid page requested. If DEBUG were set to ' +
+ 'False, an HTTP 404 page would have been shown instead.')
+ context[key] = []
+ context['invalid_page'] = True
+ return u''
+ if self.context_var is not None:
+ context[self.context_var] = page_obj.object_list
+ else:
+ context[key] = page_obj.object_list
+ context['paginator'] = paginator
+ context['page_obj'] = page_obj
+ context['page_suffix'] = page_suffix
+ return u''
+
+
- A custom template to include in place of the default ``pagination.html``
++def paginate(context, window=DEFAULT_WINDOW, margin=DEFAULT_MARGIN):
+ """
+ Renders the ``pagination/pagination.html`` template, resulting in a
+ Digg-like display of the available pages, given the current page. If there
+ are too many pages to be displayed before and after the current page, then
+ elipses will be used to indicate the undisplayed gap between page numbers.
+
+ Requires one argument, ``context``, which should be a dictionary-like data
+ structure and must contain the following keys:
+
+ ``paginator``
+ A ``Paginator`` or ``QuerySetPaginator`` object.
+
+ ``page_obj``
+ This should be the result of calling the page method on the
+ aforementioned ``Paginator`` or ``QuerySetPaginator`` object, given
+ the current page.
+
+ This same ``context`` dictionary-like data structure may also include:
+
+ ``getvars``
+ A dictionary of all of the **GET** parameters in the current request.
+ This is useful to maintain certain types of state, even when requesting
+ a different page.
+
+ ``pagination_template``
- """
++ A custom template to include in place of the default ``pagination/default.html``
+ contents.
+
- # First and last are simply the first *n* pages and the last *n* pages,
- # where *n* is the current window size.
- first = set(page_range[:window])
- last = set(page_range[-window:])
- # Now we look around our current page, making sure that we don't wrap
- # around.
- current_start = page_obj.number-1-window
- if current_start < 0:
- current_start = 0
- current_end = page_obj.number-1+window
- if current_end < 0:
- current_end = 0
- current = set(page_range[current_start:current_end])
- pages = []
- # If there's no overlap between the first set of pages and the current
- # set of pages, then there's a possible need for elusion.
- if len(first.intersection(current)) == 0:
- first_list = list(first)
- first_list.sort()
- second_list = list(current)
- second_list.sort()
- pages.extend(first_list)
- diff = second_list[0] - first_list[-1]
- # If there is a gap of two, between the last page of the first
- # set and the first page of the current set, then we're missing a
- # page.
- if diff == 2:
- pages.append(second_list[0] - 1)
- # If the difference is just one, then there's nothing to be done,
- # as the pages need no elusion and are correct.
- elif diff == 1:
- pass
- # Otherwise, there's a bigger gap which needs to be signaled for
- # elusion, by pushing a None value to the page list.
- else:
- pages.append(None)
- pages.extend(second_list)
++ Argument ``window`` is number to pages before/after current page. If window
++ exceeds pagination border (1 and end), window is moved to left or right.
++
++ Argument ``margin``` is number of pages on start/end of pagination.
++ Example:
++ window=2, margin=1, current=6 1 ... 4 5 [6] 7 8 ... 11
++ window=2, margin=0, current=1 [1] 2 3 4 5 ...
++ window=2, margin=0, current=5 ... 3 4 [5] 6 7 ...
++ window=2, margin=0, current=11 ... 7 8 9 10 [11]
++ """
++
++ if window < 0:
++ raise ValueError('Parameter "window" cannot be less than zero')
++ if margin < 0:
++ raise ValueError('Parameter "margin" cannot be less than zero')
+ try:
+ paginator = context['paginator']
+ page_obj = context['page_obj']
+ page_suffix = context.get('page_suffix', '')
+ page_range = paginator.page_range
+ pagination_template = context.get('pagination_template', 'pagination/default.html')
+ # Calculate the record range in the current page for display.
+ records = {'first': 1 + (page_obj.number - 1) * paginator.per_page}
+ records['last'] = records['first'] + paginator.per_page - 1
+ if records['last'] + paginator.orphans >= paginator.count:
+ records['last'] = paginator.count
- unioned = list(first.union(current))
- unioned.sort()
- pages.extend(unioned)
- # If there's no overlap between the current set of pages and the last
- # set of pages, then there's a possible need for elusion.
- if len(current.intersection(last)) == 0:
- second_list = list(last)
- second_list.sort()
- diff = second_list[0] - pages[-1]
- # If there is a gap of two, between the last page of the current
- # set and the first page of the last set, then we're missing a
- # page.
- if diff == 2:
- pages.append(second_list[0] - 1)
- # If the difference is just one, then there's nothing to be done,
- # as the pages need no elusion and are correct.
- elif diff == 1:
- pass
- # Otherwise, there's a bigger gap which needs to be signaled for
- # elusion, by pushing a None value to the page list.
- else:
++
++ # figure window
++ window_start = page_obj.number - window - 1
++ window_end = page_obj.number + window
++
++ # solve if window exceeded page range
++ if window_start < 0:
++ window_end = window_end - window_start
++ window_start = 0
++ if window_end > paginator.num_pages:
++ window_start = window_start - (window_end - paginator.num_pages)
++ window_end = paginator.num_pages
++ pages = page_range[window_start:window_end]
++
++ # figure margin and add elipses
++ if margin > 0:
++ # figure margin
++ tmp_pages = set(pages)
++ tmp_pages = tmp_pages.union(page_range[:margin])
++ tmp_pages = tmp_pages.union(page_range[-margin:])
++ tmp_pages = list(tmp_pages)
++ tmp_pages.sort()
++ pages = []
++ pages.append(tmp_pages[0])
++ for i in range(1, len(tmp_pages)):
++ # figure gap size => add elipses or fill in gap
++ gap = tmp_pages[i] - tmp_pages[i - 1]
++ if gap >= 3:
++ pages.append(None)
++ elif gap == 2:
++ pages.append(tmp_pages[i] - 1)
++ pages.append(tmp_pages[i])
+ else:
- pages.extend(second_list)
- else:
- differenced = list(last.difference(current))
- differenced.sort()
- pages.extend(differenced)
++ if pages[0] != 1:
++ pages.insert(0, None)
++ if pages[-1] != paginator.num_pages:
+ pages.append(None)
- 'pages': pages,
- 'page_obj': page_obj,
- 'paginator': paginator,
- 'is_paginated': paginator.count > paginator.per_page,
- 'page_suffix': page_suffix,
- 'display_page_links': DISPLAY_PAGE_LINKS,
- 'display_disabled_previous_link': DISPLAY_DISABLED_PREVIOUS_LINK,
++
+ to_return = {
+ 'MEDIA_URL': settings.MEDIA_URL,
+ 'STATIC_URL': getattr(settings, "STATIC_URL", None),
- 'previous_link_decorator': PREVIOUS_LINK_DECORATOR,
+ 'display_disabled_next_link': DISPLAY_DISABLED_NEXT_LINK,
++ 'display_disabled_previous_link': DISPLAY_DISABLED_PREVIOUS_LINK,
++ 'display_page_links': DISPLAY_PAGE_LINKS,
++ 'is_paginated': paginator.count > paginator.per_page,
+ 'next_link_decorator': NEXT_LINK_DECORATOR,
++ 'page_obj': page_obj,
++ 'page_suffix': page_suffix,
++ 'pages': pages,
+ 'pagination_template': pagination_template,
++ 'paginator': paginator,
++ 'previous_link_decorator': PREVIOUS_LINK_DECORATOR,
++ 'records': records,
+ }
+ if 'request' in context:
+ getvars = context['request'].GET.copy()
+ if 'page%s' % page_suffix in getvars:
+ del getvars['page%s' % page_suffix]
+ if len(getvars.keys()) > 0:
+ to_return['getvars'] = "&%s" % getvars.urlencode()
+ else:
+ to_return['getvars'] = ''
+ return to_return
+ except (KeyError, AttributeError):
+ return {}
+
+
+register.inclusion_tag(
+ 'pagination/pagination.html', takes_context=True)(paginate)
+
+register.tag('autopaginate', do_autopaginate)
--- /dev/null
- >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
+"""
+>>> from django.core.paginator import Paginator
+>>> from linaro_django_pagination.templatetags.pagination_tags import paginate
+>>> from django.template import Template, Context
+
+>>> p = Paginator(range(15), 2)
- >>> p = Paginator(range(19), 2)
- >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
- [1, 2, 3, 4, None, 7, 8, 9, 10]
++>>> pg = paginate({'paginator': p, 'page_obj': p.page(1)})
++>>> pg['pages']
+[1, 2, 3, 4, 5, 6, 7, 8]
++>>> pg['records']['first']
++1
++>>> pg['records']['last']
++2
++
++>>> p = Paginator(range(15), 2)
++>>> pg = paginate({'paginator': p, 'page_obj': p.page(8)})
++>>> pg['pages']
++[1, 2, 3, 4, 5, 6, 7, 8]
++>>> pg['records']['first']
++15
++>>> pg['records']['last']
++15
+
+>>> p = Paginator(range(17), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
+[1, 2, 3, 4, 5, 6, 7, 8, 9]
+
- >>> p = Paginator(range(21), 2)
- >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
- [1, 2, 3, 4, None, 8, 9, 10, 11]
+
- # Testing orphans
- >>> p = Paginator(range(5), 2, 1)
- >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
- [1, 2]
++# on start
++# moving the window from 1 ... to end
++# window size = 2, margin = 2
++# [1] 2 3 4 5 ... 15, 16
++# 1 [2] 3 4 5 ... 15, 16
++# 1 2 [3] 4 5 ... 15, 16
++# 1 2 3 [4] 5 6 ... 15, 16
++# 1 2 3 4 [5] 6 7 ... 15, 16
++# 1 2 3 4 5 [6] 7 8 ... 15, 16
++# 1 2 ... 5 6 [7] 8 9 ... 15, 16
+
- >>> p = Paginator(range(21), 2, 1)
- >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
- [1, 2, 3, 4, None, 7, 8, 9, 10]
++# window = 2 -> show 5 pages
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(1)}, 2, 2)['pages']
++[1, 2, 3, 4, 5, None, 15, 16]
+
- >>> p = Paginator(range(21), 2, 1)
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(2)}, 2, 2)['pages']
++[1, 2, 3, 4, 5, None, 15, 16]
+
- [1, 2, 3, 4, None, 7, 8, 9, 10]
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(3)}, 2, 2)['pages']
++[1, 2, 3, 4, 5, None, 15, 16]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(4)}, 2, 2)['pages']
++[1, 2, 3, 4, 5, 6, None, 15, 16]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(5)}, 2, 2)['pages']
++[1, 2, 3, 4, 5, 6, 7, None, 15, 16]
++
++# in the middle
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(7)}, 2, 2)['pages']
++[1, 2, None, 5, 6, 7, 8, 9, None, 15, 16]
++
++# on end
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(16)}, 2, 2)['pages']
++[1, 2, None, 12, 13, 14, 15, 16]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(13)}, 2, 2)['pages']
++[1, 2, None, 11, 12, 13, 14, 15, 16]
++
++
++>>> p = Paginator(range(0), 2)
+>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
- >>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages']
++[1]
++
++
++
++# no margin
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(3)}, 2, 0)['pages']
++[1, 2, 3, 4, 5, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(5)}, 2, 0)['pages']
++[None, 3, 4, 5, 6, 7, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(16)}, 2, 0)['pages']
++[None, 12, 13, 14, 15, 16]
++
++
++# special
++# zero window, zero margin
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(1)}, 0, 0)['pages']
++[1, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(2)}, 0, 0)['pages']
++[None, 2, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(3)}, 0, 0)['pages']
++[None, 3, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(10)}, 0, 0)['pages']
++[None, 10, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(14)}, 0, 0)['pages']
++[None, 14, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(15)}, 0, 0)['pages']
++[None, 15, None]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(16)}, 0, 0)['pages']
++[None, 16]
++
++>>> p = Paginator(range(31), 2)
++>>> paginate({'paginator': p, 'page_obj': p.page(5)}, 0, 1)['pages']
++[1, None, 5, None, 16]
+
+>>> p = Paginator(range(21), 2, 1)
++>>> paginate({'paginator': p, 'page_obj': p.page(1)}, 0, 4)['pages']
+[1, 2, 3, 4, None, 7, 8, 9, 10]
+
++# Testing template rendering
++
+>>> t = Template("{% load pagination_tags %}{% autopaginate var 2 %}{% paginate %}")
+
+>>> from django.http import HttpRequest as DjangoHttpRequest
+>>> class HttpRequest(DjangoHttpRequest):
+... page = lambda self, suffix: 1
+
+>>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>>
+>>> t = Template("{% load pagination_tags %}{% autopaginate var %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>> t = Template("{% load pagination_tags %}{% autopaginate var 20 %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...
+>>> t = Template("{% load pagination_tags %}{% autopaginate var by %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'by': 20, 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...<a href="?page=2"...
+>>> t = Template("{% load pagination_tags %}{% autopaginate var by as foo %}{{ foo }}")
+>>> t.render(Context({'var': range(21), 'by': 20, 'request': HttpRequest()}))
+u'[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]'
+>>>
+>>> t = Template("{% load pagination_tags %}{% autopaginate var2 by as foo2 %}{% paginate %}{% autopaginate var by as foo %}{% paginate %}")
+>>> t.render(Context({'var': range(21), 'var2': range(50, 121), 'by': 20, 'request': HttpRequest()}))
+u'\\n\\n<div class="pagination">...<a href="?page_var2=2"...<a href="?page_var=2"...
+>>>
+
+# Testing InfinitePaginator
+
+>>> from paginator import InfinitePaginator
+
+>>> InfinitePaginator
+<class 'linaro_django_pagination.paginator.InfinitePaginator'>
+>>> p = InfinitePaginator(range(20), 2, link_template='/bacon/page/%d')
+>>> p.validate_number(2)
+2
+>>> p.orphans
+0
+>>> p3 = p.page(3)
+>>> p3
+<Page 3>
+>>> p3.end_index()
+6
+>>> p3.has_next()
+True
+>>> p3.has_previous()
+True
+>>> p.page(10).has_next()
+False
+>>> p.page(1).has_previous()
+False
+>>> p3.next_link()
+'/bacon/page/4'
+>>> p3.previous_link()
+'/bacon/page/2'
+
+# Testing FinitePaginator
+
+>>> from paginator import FinitePaginator
+
+>>> FinitePaginator
+<class 'linaro_django_pagination.paginator.FinitePaginator'>
+>>> p = FinitePaginator(range(20), 2, offset=10, link_template='/bacon/page/%d')
+>>> p.validate_number(2)
+2
+>>> p.orphans
+0
+>>> p3 = p.page(3)
+>>> p3
+<Page 3>
+>>> p3.start_index()
+10
+>>> p3.end_index()
+6
+>>> p3.has_next()
+True
+>>> p3.has_previous()
+True
+>>> p3.next_link()
+'/bacon/page/4'
+>>> p3.previous_link()
+'/bacon/page/2'
+
+>>> p = FinitePaginator(range(20), 20, offset=10, link_template='/bacon/page/%d')
+>>> p2 = p.page(2)
+>>> p2
+<Page 2>
+>>> p2.has_next()
+False
+>>> p3.has_previous()
+True
+>>> p2.next_link()
+
+>>> p2.previous_link()
+'/bacon/page/1'
+
+>>> from linaro_django_pagination.middleware import PaginationMiddleware
+>>> from django.core.handlers.wsgi import WSGIRequest
+>>> from StringIO import StringIO
+>>> middleware = PaginationMiddleware()
+>>> request = WSGIRequest({'REQUEST_METHOD': 'POST', 'CONTENT_TYPE': 'multipart', 'wsgi.input': StringIO()})
+>>> middleware.process_request(request)
+>>> request.upload_handlers.append('asdf')
+"""
fnp / django-pagination.git / commitdiff