From: Zygmunt Krynicki Date: Mon, 13 Jun 2011 12:12:31 +0000 (+0200) Subject: Merge branch 'master' of git://github.com/spanasik/django-pagination X-Git-Tag: release-2.0~33 X-Git-Url: https://git.mdrn.pl/django-pagination.git/commitdiff_plain/c6d9f1ade306811fbda6016aa902749caced9b7c?ds=inline;hp=--cc Merge branch 'master' of git://github.com/spanasik/django-pagination Conflicts: linaro_django_pagination/templates/pagination/pagination.html linaro_django_pagination/templatetags/pagination_tags.py --- c6d9f1ade306811fbda6016aa902749caced9b7c diff --cc linaro_django_pagination/locale/ru/LC_MESSAGES/django.po index 0000000,0000000..e47973e new file mode 100644 --- /dev/null +++ b/linaro_django_pagination/locale/ru/LC_MESSAGES/django.po @@@ -1,0 -1,0 +1,28 @@@ ++# SOME DESCRIPTIVE TITLE. ++# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER ++# This file is distributed under the same license as the PACKAGE package. ++# FIRST AUTHOR , YEAR. ++# ++#, fuzzy ++msgid "" ++msgstr "" ++"Project-Id-Version: PACKAGE VERSION\n" ++"Report-Msgid-Bugs-To: \n" ++"POT-Creation-Date: 2010-07-11 16:14+0600\n" ++"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" ++"Last-Translator: FULL NAME \n" ++"Language-Team: LANGUAGE \n" ++"MIME-Version: 1.0\n" ++"Content-Type: text/plain; charset=UTF-8\n" ++"Content-Transfer-Encoding: 8bit\n" ++"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n" ++ ++#: templates/pagination/pagination.html:5 ++#: templates/pagination/pagination.html:7 ++msgid "previous" ++msgstr "Предыдущая" ++ ++#: templates/pagination/pagination.html:21 ++#: templates/pagination/pagination.html:23 ++msgid "next" ++msgstr "Следующая" diff --cc linaro_django_pagination/middleware.py index f8a2a6f,0000000..676f909 mode 100644,000000..100644 --- a/linaro_django_pagination/middleware.py +++ b/linaro_django_pagination/middleware.py @@@ -1,17 -1,0 +1,17 @@@ - def get_page(self): ++def get_page(self, suffix): + """ + A function which will be monkeypatched onto the request to get the current + integer representing the current page. + """ + try: - return int(self.REQUEST['page']) ++ return int(self.REQUEST['page%s' % suffix]) + except (KeyError, ValueError, TypeError): + return 1 + +class PaginationMiddleware(object): + """ + Inserts a variable representing the current page onto the request object if + it exists in either **GET** or **POST** portions of the request. + """ + def process_request(self, request): - request.__class__.page = property(get_page) ++ request.__class__.page = get_page diff --cc linaro_django_pagination/templates/pagination/pagination.html index 037f6d3,0000000..c2fb72d mode 100644,000000..100644 --- a/linaro_django_pagination/templates/pagination/pagination.html +++ b/linaro_django_pagination/templates/pagination/pagination.html @@@ -1,26 -1,0 +1,26 @@@ +{% if is_paginated %} +{% load i18n %} + +{% endif %} diff --cc linaro_django_pagination/templatetags/pagination_tags.py index aec6405,0000000..75cbcf3 mode 100644,000000..100644 --- a/linaro_django_pagination/templatetags/pagination_tags.py +++ b/linaro_django_pagination/templatetags/pagination_tags.py @@@ -1,248 -1,0 +1,260 @@@ +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_ORPHANS = getattr(settings, 'PAGINATION_DEFAULT_ORPHANS', 0) +INVALID_PAGE_RAISES_404 = getattr(settings, + 'PAGINATION_INVALID_PAGE_RAISES_404', False) + +def do_autopaginate(parser, token): + """ + Splits the arguments to the autopaginate tag and formats them correctly. + + Syntax is: + + autopaginate SOMETHING [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, paginate_by, orphans, context_var) ++ 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, paginate_by=None, - orphans=None, context_var=None): ++ 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_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'' + ++ +def paginate(context, window=DEFAULT_WINDOW): + """ + 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. + """ + try: + paginator = context['paginator'] + page_obj = context['page_obj'] ++ page_suffix = context.get('page_suffix', '') + page_range = paginator.page_range - # 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 + # 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) + else: + 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: + pages.append(None) + pages.extend(second_list) + else: + differenced = list(last.difference(current)) + differenced.sort() + pages.extend(differenced) + to_return = { - 'MEDIA_URL': settings.MEDIA_URL, + 'pages': pages, - 'records': records, + 'page_obj': page_obj, + 'paginator': paginator, + 'is_paginated': paginator.count > paginator.per_page, ++ 'page_suffix': page_suffix, + } + if 'request' in context: + getvars = context['request'].GET.copy() - if 'page' in getvars: - del getvars['page'] ++ 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.inclusion_tag( ++ 'pagination/pagination.html', takes_context=True)(paginate) ++ +register.tag('autopaginate', do_autopaginate) diff --cc linaro_django_pagination/tests.py index 343d82f,0000000..267b77d mode 100644,000000..100644 --- a/linaro_django_pagination/tests.py +++ b/linaro_django_pagination/tests.py @@@ -1,158 -1,0 +1,138 @@@ +""" +>>> 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) - >>> 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'] ++>>> paginate({'paginator': p, 'page_obj': p.page(1)})['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(19), 2) +>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages'] +[1, 2, 3, 4, None, 7, 8, 9, 10] + +>>> 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] + +>>> p = Paginator(range(21), 2, 1) - >>> pg = paginate({'paginator': p, 'page_obj': p.page(1)}) - >>> pg['pages'] ++>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages'] +[1, 2, 3, 4, None, 7, 8, 9, 10] - >>> pg['records']['first'] - 1 - >>> pg['records']['last'] - 2 + +>>> p = Paginator(range(21), 2, 1) - >>> pg = paginate({'paginator': p, 'page_obj': p.page(10)}) - >>> pg['pages'] - [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] - >>> pg['records']['first'] - 19 - >>> pg['records']['last'] - 21 ++>>> paginate({'paginator': p, 'page_obj': p.page(1)})['pages'] ++[1, 2, 3, 4, None, 7, 8, 9, 10] + +>>> t = Template("{% load pagination_tags %}{% autopaginate var 2 %}{% paginate %}") + +>>> from django.http import HttpRequest as DjangoHttpRequest +>>> class HttpRequest(DjangoHttpRequest): - ... page = 1 ++... page = lambda self, suffix: 1 + +>>> t.render(Context({'var': range(21), 'request': HttpRequest()})) +u'\\n\\n