paginate module

paginate: helps split up large collections into individual pages

What is pagination?

This module helps split large lists of items into pages. The user is shown one page at a time and can navigate to other pages. Imagine you are offering a company phonebook and let the user search the entries. The entire search result may contains 23 entries but you want to display no more than 10 entries at once. The first page contains entries 1-10, the second 11-20 and the third 21-23. Each “Page” instance represents the items of one of these three pages. See the documentation of the “Page” class for more information. How do I use it? —————— A page of items is represented by the Page object. A Page gets initialized with these arguments: - The collection of items to pick a range from. Usually just a list. - The page number you want to display. Default is 1: the first page. Now we can make up a collection and create a Page instance of it:

# Create a sample collection of 1000 items
>> my_collection = range(1000)
# Create a Page object for the 3rd page (20 items per page is the default)
>> my_page = Page(my_collection, page=3)
# The page object can be printed as a string to get its details
>> str(my_page)
Page:
Collection type:  <type 'range'>
Current page:     3
First item:       41
Last item:        60
First page:       1
Last page:        50
Previous page:    2
Next page:        4
Items per page:   20
Number of items:  1000
Number of pages:  50
# Print a list of items on the current page
>> my_page.items
[40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59]
# The *Page* object can be used as an iterator:
>> for my_item in my_page: print(my_item)
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
# The .pager() method returns an HTML fragment with links to surrounding pages.
>> my_page.pager(url="http://example.org/foo/page=$page")
<a href="http://example.org/foo/page=1">1</a>
<a href="http://example.org/foo/page=2">2</a>
3
<a href="http://example.org/foo/page=4">4</a>
<a href="http://example.org/foo/page=5">5</a>
..
<a href="http://example.org/foo/page=50">50</a>'
# Without the HTML it would just look like:
# 1 2 [3] 4 5 .. 50
# The pager can be customized:
>> my_page.pager('$link_previous ~3~ $link_next (Page $page of $page_count)',
                 url="http://example.org/foo/page=$page")
<a href="http://example.org/foo/page=2">&lt;</a>
<a href="http://example.org/foo/page=1">1</a>
<a href="http://example.org/foo/page=2">2</a>
3
<a href="http://example.org/foo/page=4">4</a>
<a href="http://example.org/foo/page=5">5</a>
<a href="http://example.org/foo/page=6">6</a>
..
<a href="http://example.org/foo/page=50">50</a>
<a href="http://example.org/foo/page=4">&gt;</a>
(Page 3 of 50)
# Without the HTML it would just look like:
# 1 2 [3] 4 5 6 .. 50 > (Page 3 of 50)
# The url argument to the pager method can be omitted when an url_maker is
# given during instantiation:
>> my_page = Page(my_collection, page=3,
                  url_maker=lambda p: "http://example.org/%s" % p)
>> page.pager()

There are some interesting parameters that customize the Page’s behavior. See the documentation on Page and Page.pager(). Notes ——- Page numbers and item numbers start at 1. This concept has been used because users expect that the first page has number 1 and the first item on a page also has number 1. So if you want to use the page’s items by their index number please note that you have to subtract 1.

class paginate.Page(collection, page=1, items_per_page=20, item_count=None, wrapper_class=None, url_maker=None, **kwargs)

Bases: list

A list/iterator representing the items on one page of a larger collection. An instance of the “Page” class is created from a _collection_ which is any list-like object that allows random access to its elements. The instance works as an iterator running from the first item to the last item on the given page. The Page.pager() method creates a link list allowing the user to go to other pages. A “Page” does not only carry the items on a certain page. It gives you additional information about the page in these “Page” object attributes: item_count

Number of items in the collection WARNING: Unless you pass in an item_count, a count will be performed on the collection every time a Page instance is created.
page
Number of the current page
items_per_page
Maximal number of items displayed on a page
first_page
Number of the first page - usually 1 :)
last_page
Number of the last page
previous_page
Number of the previous page. If this is the first page it returns None.
next_page
Number of the next page. If this is the last page it returns None.
page_count
Number of pages
items
Sequence/iterator of items on the current page
first_item
Index of first item on the current page - starts with 1
last_item
Index of last item on the current page

Create an A-HREF tag that points to another page.

Return map with links to other pages if default pager() function is not suitable solution. format:

Format string that defines how the pager would be normally rendered rendered. Uses same arguments as pager() method, but returns a simple dictionary in form of: {‘current_page’: {‘attrs’: {},

‘href’: ‘http://example.org/foo/page=1’, ‘value’: 1},
‘first_page’: {‘attrs’: {},
‘href’: ‘http://example.org/foo/page=1’, ‘type’: ‘first_page’, ‘value’: 1},
‘last_page’: {‘attrs’: {},
‘href’: ‘http://example.org/foo/page=8’, ‘type’: ‘last_page’, ‘value’: 8},

‘next_page’: {‘attrs’: {}, ‘href’: ‘HREF’, ‘type’: ‘next_page’, ‘value’: 2}, ‘previous_page’: None, ‘range_pages’: [{‘attrs’: {},

‘href’: ‘http://example.org/foo/page=1’, ‘type’: ‘current_page’, ‘value’: 1}, ….

{‘attrs’: {}, ‘href’: ‘’, ‘type’: ‘span’, ‘value’: ‘..’}]}

The string can contain the following $-tokens that are substituted by the string.Template module: - $first_page: number of first reachable page - $last_page: number of last reachable page - $page: number of currently selected page - $page_count: number of reachable pages - $items_per_page: maximal number of items per page - $first_item: index of first item on the current page - $last_item: index of last item on the current page - $item_count: total number of items - $link_first: link to first page (unless this is first page) - $link_last: link to last page (unless this is last page) - $link_previous: link to previous page (unless this is first page) - $link_next: link to next page (unless this is last page) To render a range of pages the token ‘~3~’ can be used. The number sets the radius of pages around the current page. Example for a range with radius 3: ‘1 .. 5 6 7 [8] 9 10 11 .. 50’ Default: ‘~2~’

url
The URL that page links will point to. Make sure it contains the string $page which will be replaced by the actual page number. Must be given unless a url_maker is specified to __init__, in which case this parameter is ignored.
symbol_first
String to be displayed as the text for the $link_first link above. Default: ‘&lt;&lt;’ (<<)
symbol_last
String to be displayed as the text for the $link_last link above. Default: ‘&gt;&gt;’ (>>)
symbol_previous
String to be displayed as the text for the $link_previous link above. Default: ‘&lt;’ (<)
symbol_next
String to be displayed as the text for the $link_next link above. Default: ‘&gt;’ (>)
separator:
String that is used to separate page links/numbers in the above range of pages. Default: ‘ ‘
show_if_single_page:
if True the navigator will be shown even if there is only one page. Default: False
link_attr (optional)
A dictionary of attributes that get added to A-HREF links pointing to other pages. Can be used to define a CSS style or class to customize the look of links. Example: { ‘style’:’border: 1px solid green’ } Example: { ‘class’:’pager_link’ }
curpage_attr (optional)
A dictionary of attributes that get added to the current page number in the pager (which is obviously not a link). If this dictionary is not empty then the elements will be wrapped in a SPAN tag with the given attributes. Example: { ‘style’:’border: 3px solid blue’ } Example: { ‘class’:’pager_curpage’ }
dotdot_attr (optional)
A dictionary of attributes that get added to the ‘..’ string in the pager (which is obviously not a link). If this dictionary is not empty then the elements will be wrapped in a SPAN tag with the given attributes. Example: { ‘style’:’color: #808080’ } Example: { ‘class’:’pager_dotdot’ }
pager(format='~2~', url=None, show_if_single_page=False, separator=' ', symbol_first='&lt;&lt;', symbol_last='&gt;&gt;', symbol_previous='&lt;', symbol_next='&gt;', link_attr={}, curpage_attr={}, dotdot_attr={}, link_tag=None)

Return string with links to other pages (e.g. ‘1 .. 5 6 7 [8] 9 10 11 .. 50’). format:

Format string that defines how the pager is rendered. The string can contain the following $-tokens that are substituted by the string.Template module: - $first_page: number of first reachable page - $last_page: number of last reachable page - $page: number of currently selected page - $page_count: number of reachable pages - $items_per_page: maximal number of items per page - $first_item: index of first item on the current page - $last_item: index of last item on the current page - $item_count: total number of items - $link_first: link to first page (unless this is first page) - $link_last: link to last page (unless this is last page) - $link_previous: link to previous page (unless this is first page) - $link_next: link to next page (unless this is last page) To render a range of pages the token ‘~3~’ can be used. The number sets the radius of pages around the current page. Example for a range with radius 3: ‘1 .. 5 6 7 [8] 9 10 11 .. 50’ Default: ‘~2~’
url
The URL that page links will point to. Make sure it contains the string $page which will be replaced by the actual page number. Must be given unless a url_maker is specified to __init__, in which case this parameter is ignored.
symbol_first
String to be displayed as the text for the $link_first link above. Default: ‘&lt;&lt;’ (<<)
symbol_last
String to be displayed as the text for the $link_last link above. Default: ‘&gt;&gt;’ (>>)
symbol_previous
String to be displayed as the text for the $link_previous link above. Default: ‘&lt;’ (<)
symbol_next
String to be displayed as the text for the $link_next link above. Default: ‘&gt;’ (>)
separator:
String that is used to separate page links/numbers in the above range of pages. Default: ‘ ‘
show_if_single_page:
if True the navigator will be shown even if there is only one page. Default: False
link_attr (optional)
A dictionary of attributes that get added to A-HREF links pointing to other pages. Can be used to define a CSS style or class to customize the look of links. Example: { ‘style’:’border: 1px solid green’ } Example: { ‘class’:’pager_link’ }
curpage_attr (optional)
A dictionary of attributes that get added to the current page number in the pager (which is obviously not a link). If this dictionary is not empty then the elements will be wrapped in a SPAN tag with the given attributes. Example: { ‘style’:’border: 3px solid blue’ } Example: { ‘class’:’pager_curpage’ }
dotdot_attr (optional)
A dictionary of attributes that get added to the ‘..’ string in the pager (which is obviously not a link). If this dictionary is not empty then the elements will be wrapped in a SPAN tag with the given attributes. Example: { ‘style’:’color: #808080’ } Example: { ‘class’:’pager_dotdot’ }
link_tag (optional)
A callable that accepts single argument page (page link information) and generates string with html that represents the link for specific page. Page objects are supplied from link_map() so the keys are the same.
paginate.make_html_tag(tag, text=None, **params)

Create an HTML tag string. tag

The HTML tag to use (e.g. ‘a’, ‘span’ or ‘div’)
text
The text to enclose between opening and closing tag. If no text is specified then only the opening tag is returned.
Example::
make_html_tag(‘a’, text=”Hello”, href=”/another/page”) -> <a href=”/another/page”>Hello</a>

To use reserved Python keywords like “class” as a parameter prepend it with an underscore. Instead of “class=’green’” use “_class=’green’”. Warning: Quotes and apostrophes are not escaped.