From: Zygmunt Krynicki <zygmunt.krynicki@linaro.org>
Date: Mon, 13 Jun 2011 12:41:40 +0000 (+0200)
Subject: Merge branch 'master' of git://github.com/leah/django-pagination
X-Git-Tag: release-2.0~31
X-Git-Url: https://git.mdrn.pl/django-pagination.git/commitdiff_plain/993daaba73aa6511449f2c2ccfa869692afa10d5?page=2

Merge branch 'master' of git://github.com/leah/django-pagination

Conflicts:
	pagination/tests.py
---

993daaba73aa6511449f2c2ccfa869692afa10d5
diff --cc linaro_django_pagination/__init__.py
index 8b13789,0000000..e69de29
mode 100644,000000..100644
--- a/linaro_django_pagination/__init__.py
+++ b/linaro_django_pagination/__init__.py
diff --cc linaro_django_pagination/paginator.py
index f67aa23,0000000..8109e5e
mode 100644,000000..100644
--- a/linaro_django_pagination/paginator.py
+++ b/linaro_django_pagination/paginator.py
@@@ -1,171 -1,0 +1,173 @@@
 +from django.core.paginator import Paginator, Page, PageNotAnInteger, EmptyPage
 +
++
 +class InfinitePaginator(Paginator):
 +    """
 +    Paginator designed for cases when it's not important to know how many total
 +    pages.  This is useful for any object_list that has no count() method or can
 +    be used to improve performance for MySQL by removing counts.
 +
 +    The orphans parameter has been removed for simplicity and there's a link
 +    template string for creating the links to the next and previous pages.
 +    """
 +
 +    def __init__(self, object_list, per_page, allow_empty_first_page=True,
 +        link_template='/page/%d/'):
 +        orphans = 0 # no orphans
 +        super(InfinitePaginator, self).__init__(object_list, per_page, orphans,
 +            allow_empty_first_page)
 +        # no count or num pages
 +        del self._num_pages, self._count
 +        # bonus links
 +        self.link_template = link_template
 +
 +    def validate_number(self, number):
 +        """
 +        Validates the given 1-based page number.
 +        """
 +        try:
 +            number = int(number)
 +        except ValueError:
 +            raise PageNotAnInteger('That page number is not an integer')
 +        if number < 1:
 +            raise EmptyPage('That page number is less than 1')
 +        return number
 +
 +    def page(self, number):
 +        """
 +        Returns a Page object for the given 1-based page number.
 +        """
 +        number = self.validate_number(number)
 +        bottom = (number - 1) * self.per_page
 +        top = bottom + self.per_page
 +        page_items = self.object_list[bottom:top]
 +        # check moved from validate_number
 +        if not page_items:
 +            if number == 1 and self.allow_empty_first_page:
 +                pass
 +            else:
 +                raise EmptyPage('That page contains no results')
 +        return InfinitePage(page_items, number, self)
 +
 +    def _get_count(self):
 +        """
 +        Returns the total number of objects, across all pages.
 +        """
 +        raise NotImplementedError
 +    count = property(_get_count)
 +
 +    def _get_num_pages(self):
 +        """
 +        Returns the total number of pages.
 +        """
 +        raise NotImplementedError
 +    num_pages = property(_get_num_pages)
 +
 +    def _get_page_range(self):
 +        """
 +        Returns a 1-based range of pages for iterating through within
 +        a template for loop.
 +        """
 +        raise NotImplementedError
 +    page_range = property(_get_page_range)
 +
 +
 +class InfinitePage(Page):
 +
 +    def __repr__(self):
 +        return '<Page %s>' % self.number
 +
 +    def has_next(self):
 +        """
 +        Checks for one more item than last on this page.
 +        """
 +        try:
-             next_item = self.paginator.object_list[
-                 self.number * self.paginator.per_page]
++            self.paginator.object_list[self.number * self.paginator.per_page]
 +        except IndexError:
 +            return False
 +        return True
 +
 +    def end_index(self):
 +        """
 +        Returns the 1-based index of the last object on this page,
 +        relative to total objects found (hits).
 +        """
 +        return ((self.number - 1) * self.paginator.per_page +
 +            len(self.object_list))
 +
 +    #Bonus methods for creating links
 +
 +    def next_link(self):
 +        if self.has_next():
 +            return self.paginator.link_template % (self.number + 1)
 +        return None
 +
 +    def previous_link(self):
 +        if self.has_previous():
 +            return self.paginator.link_template % (self.number - 1)
 +        return None
 +
++
 +class FinitePaginator(InfinitePaginator):
 +    """
 +    Paginator for cases when the list of items is already finite.
 +
 +    A good example is a list generated from an API call. This is a subclass
 +    of InfinitePaginator because we have no idea how many items exist in the
 +    full collection.
 +
 +    To accurately determine if the next page exists, a FinitePaginator MUST be
 +    created with an object_list_plus that may contain more items than the
 +    per_page count.  Typically, you'll have an object_list_plus with one extra
 +    item (if there's a next page).  You'll also need to supply the offset from
 +    the full collection in order to get the page start_index.
 +
 +    This is a very silly class but useful if you love the Django pagination
 +    conventions.
 +    """
 +
 +    def __init__(self, object_list_plus, per_page, offset=None,
 +        allow_empty_first_page=True, link_template='/page/%d/'):
 +        super(FinitePaginator, self).__init__(object_list_plus, per_page,
 +            allow_empty_first_page, link_template)
 +        self.offset = offset
 +
 +    def validate_number(self, number):
 +        super(FinitePaginator, self).validate_number(number)
 +        # check for an empty list to see if the page exists
 +        if not self.object_list:
 +            if number == 1 and self.allow_empty_first_page:
 +                pass
 +            else:
 +                raise EmptyPage('That page contains no results')
 +        return number
 +
 +    def page(self, number):
 +        """
 +        Returns a Page object for the given 1-based page number.
 +        """
 +        number = self.validate_number(number)
 +        # remove the extra item(s) when creating the page
 +        page_items = self.object_list[:self.per_page]
 +        return FinitePage(page_items, number, self)
 +
++
 +class FinitePage(InfinitePage):
 +
 +    def has_next(self):
 +        """
 +        Checks for one more item than last on this page.
 +        """
 +        try:
-             next_item = self.paginator.object_list[self.paginator.per_page]
++            self.paginator.object_list[self.paginator.per_page]
 +        except IndexError:
 +            return False
 +        return True
 +
 +    def start_index(self):
 +        """
 +        Returns the 1-based index of the first object on this page,
 +        relative to total objects in the paginator.
 +        """
 +        ## TODO should this holler if you haven't defined the offset?
-         return self.paginator.offset
++        return self.paginator.offset
diff --cc linaro_django_pagination/templatetags/pagination_tags.py
index af1be0f,0000000..1e7d5da
mode 100755,000000..100755
--- a/linaro_django_pagination/templatetags/pagination_tags.py
+++ b/linaro_django_pagination/templatetags/pagination_tags.py
@@@ -1,282 -1,0 +1,282 @@@
 +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)
 +DISPLAY_PAGE_LINKS = getattr(settings, 'PAGINATION_DISPLAY_PAGE_LINKS', True)
 +PREVIOUS_LINK_DECORATOR = getattr(settings, 'PAGINATION_PREVIOUS_LINK_DECORATOR', "&lsaquo;&lsaquo; ")
 +NEXT_LINK_DECORATOR = getattr(settings, 'PAGINATION_NEXT_LINK_DECORATOR', " &rsaquo;&rsaquo;")
 +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:
 +
 +        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, 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''
 +
 +
 +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.
 +    
 +    ``pagination_template``
 +        A custom template to include in place of the default ``pagination.html`` 
 +        contents.
 +        
 +    """
 +    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
 +        # 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 = {
 +            '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,
 +            'display_disabled_next_link': DISPLAY_DISABLED_NEXT_LINK,
 +            'previous_link_decorator': PREVIOUS_LINK_DECORATOR,
 +            'next_link_decorator': NEXT_LINK_DECORATOR,
 +            'pagination_template': pagination_template,
 +        }
 +        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:
++    except (KeyError, AttributeError):
 +        return {}
 +
 +
 +register.inclusion_tag(
 +    'pagination/pagination.html', takes_context=True)(paginate)
 +
 +register.tag('autopaginate', do_autopaginate)