Opened 3 years ago

Last modified 8 weeks ago

#25513 assigned New feature

Refactor the admin paginator customizations to make them reuseable

Reported by: Vlada Macek Owned by: Sasha Gaevsky
Component: Core (Other) Version: master
Severity: Normal Keywords: paginator
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no

Description

For large page counts I miss a standard way to display only interesting blocks of page links in the paginator. I guess Django should include one.

What do you think about integrating my implementation to django.core.paginator.Page drafted below?
Template example at the bottom.

from django.core.paginator import Paginator, Page

class EllipsisPaginator(Paginator):
    def __init__(self, *args, **kwargs):
        # number of page links to always display after the first page
        self.start_wing = kwargs.pop('start_wing', 1)
        # number of page links to always display around the current page
        self.island_wings = kwargs.pop('island_wings', 2)
        # number of page links to always display before the last page
        self.end_wing = kwargs.pop('end_wing', 1)

        super(EllipsisPaginator, self).__init__(*args, **kwargs)

    def _get_page(self, *args, **kwargs):
        return EllipsisPage(*args, **kwargs)


class EllipsisPage(Page):
    def pages_with_ellipsis(self):
        """
        Generates the list of page numbers for large page counts.
        Yields '...' where the range of links should be omitted.

        >>> pp = EllipsisPaginator(object_list=range(38), per_page=3)
        >>> list(pp.page(1).pages_with_ellipsis())
        [1, 2, 3, '...', 12, 13]
        >>> list(pp.page(2).pages_with_ellipsis())
        [1, 2, 3, 4, '...', 12, 13]
        >>> list(pp.page(3).pages_with_ellipsis())
        [1, 2, 3, 4, 5, '...', 12, 13]
        >>> list(pp.page(4).pages_with_ellipsis())
        [1, 2, 3, 4, 5, 6, '...', 12, 13]
        >>> list(pp.page(5).pages_with_ellipsis())
        [1, 2, 3, 4, 5, 6, 7, '...', 12, 13]
        >>> list(pp.page(6).pages_with_ellipsis())
        [1, 2, 3, 4, 5, 6, 7, 8, '...', 12, 13]
        >>> list(pp.page(7).pages_with_ellipsis())
        [1, 2, '...', 5, 6, 7, 8, 9, '...', 12, 13]
        >>> list(pp.page(8).pages_with_ellipsis())
        [1, 2, '...', 6, 7, 8, 9, 10, 11, 12, 13]
        >>> list(pp.page(9).pages_with_ellipsis())
        [1, 2, '...', 7, 8, 9, 10, 11, 12, 13]
        >>> list(pp.page(10).pages_with_ellipsis())
        [1, 2, '...', 8, 9, 10, 11, 12, 13]
        >>> list(pp.page(11).pages_with_ellipsis())
        [1, 2, '...', 9, 10, 11, 12, 13]
        >>> list(pp.page(12).pages_with_ellipsis())
        [1, 2, '...', 10, 11, 12, 13]
        >>> list(pp.page(13).pages_with_ellipsis())
        [1, 2, '...', 11, 12, 13]
        """
        num = 1

        end_of_start_wing = min(self.paginator.num_pages, self.paginator.start_wing+1)

        for num in xrange(1, end_of_start_wing+1):
            yield num

        island_start = self.number - self.paginator.island_wings

        if num < island_start-2:
            yield '...'
            num = island_start
        else:
            num += 1

        island_end = min(self.paginator.num_pages, self.number + self.paginator.island_wings)

        for num in xrange(num, island_end+1):
            yield num

        start_of_end_wing = self.paginator.num_pages - self.paginator.end_wing

        if num < start_of_end_wing-2:
            yield '...'
            num = start_of_end_wing
        else:
            num += 1

        for num in xrange(num, self.paginator.num_pages+1):
            yield num

Usage in the template:

<ul class="pagination">
    <li rel="prev">
        <a {% if page.has_previous %}href="?page={{ page.previous_page_number }}"{% endif %}>
            Previous
        </a>
    </li>

    {% for pg in page.pages_with_ellipsis %}

	{% if pg != '...' %}
	    <li {% if pg == page.number %}class="active"{% endif %}>
		<a {% if pg != page.number %}href="?page={{ pg }}"{% endif %}>
		    {{ pg }}
		</a>
	    </li>
	{% else %}
	    <li><span>&hellip;</span></li>
	{% endif %}

    {% endfor %}

    <li rel="next" {% if page.has_next %}class="highlight"{% endif %}>
	<a {% if page.has_next %}href="?page={{ page.next_page_number }}"{% endif %}>
	    Next
	</a>
    </li>
</ul>

Attachments (1)

shot-20151006-1543.png (2.9 KB) - added by Vlada Macek 3 years ago.
A screenshot of the paginator.

Download all attachments as: .zip

Change History (9)

Changed 3 years ago by Vlada Macek

Attachment: shot-20151006-1543.png added

A screenshot of the paginator.

comment:1 Changed 3 years ago by Vlada Macek

Attached is the screenshot of how it can look.

The method is a simple and effetcive Python generator jumping over iteresting blocks of pages.

comment:2 Changed 3 years ago by Tim Graham

The admin contains a similar paginator in the form of a template tag. Maybe it would be worth trying to refactoring that into django.core.paginator so it's more easily reuseable. I'm not sure how well the code will generalize.

comment:3 Changed 3 years ago by Tim Graham

Summary: Paginator support for large page countsRefactor the admin paginator customizations to make them reuseable
Triage Stage: UnreviewedAccepted
Version: 1.9a1master

comment:4 Changed 3 years ago by Sasha Gaevsky

Owner: changed from nobody to Sasha Gaevsky
Status: newassigned

comment:5 Changed 3 years ago by Sasha Gaevsky

Has patch: set
Last edited 3 years ago by Tim Graham (previous) (diff)

comment:6 Changed 3 years ago by Tim Graham

Needs documentation: set

Looks like it's on the right track, but the new class should be documented too.

comment:7 Changed 8 weeks ago by Tim Graham

Needs documentation: unset

comment:8 Changed 8 weeks ago by Tim Graham

Patch needs improvement: set
Note: See TracTickets for help on using tickets.
Back to Top