ʆh|SrSrSrS/rSrSrSrSrSrS S K r S S K J r S S K r \ RS S :r\(a\r"S S\5rSSjrg )a 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: 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") 1 2 3 4 5 .. 50' # 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") < 1 2 3 4 5 6 .. 50 > (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. zChristoph Haasz3Copyright 2007-2016 Christoph Haas and contributorszMike OrrMITz0.5.4zMarcin Lulek, Luke Crooksz#info@webreactor.eu, luke@pumalo.orgBetaN)Templatec\rSrSrSrS SjrSrSrSSjrSSjr S r S r \ S 5r S rg)Pagea"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 Nc UbUcXlOU"U5UlO/Ul[U5UlUbX`lOURUlXpl[ U5UlURS:aSUlX0l URS- U-nX-n [URX5Ul UbX@lO[!UR5UlURS:GaUSUlURS- UR-S-UlUR"UR$-S- UlURUR&:aUR&UlO+URUR":aUR"UlURS- U-S-Ul[+UR(U-S- UR5UlURUR":aURS- UlOSUlURUR&:aURS-UlO@SUlO8SUlSUlSUlSUlSUlSUlSUl/Ul [R3XR5 g![[4a SUlGNLf=f![[4a2n [SR[UR555eSn A ff=f)aCreate a "Page" instance. Parameters: collection Sequence representing the collection of items to page through. page The requested page number - starts with 1. Default: 1. items_per_page The maximal number of items to be displayed per page. Default: 20. item_count (optional) The total number of items in the collection - if known. If this parameter is not given then the paginator will count the number of elements in the collection every time a "Page" is created. Giving this parameter will speed up things. In a busy real-life application you may want to cache the number of items. url_maker (optional) Callback to generate the URL of other pages, given its numbers. Must accept one int parameter and return a URI string. Nz9Your collection of type {} cannot be handled by paginate.r) collectiontypecollection_type url_maker_default_url_makerkwargsintpage ValueError TypeErroritems_per_pagelistitemsKeyErrorformat item_countlen first_page page_count last_page first_itemmin last_item previous_page next_page__init__) selfr rrr wrapper_classrrfirstlastexcs I/opt/services/DDDS/venv/lib/python3.13/site-packages/paginate/__init__.pyr% Page.__init__sF  !$",#0 "; DO#J/  &N!44DN  D DI 99q=DI, YY]n4E)Ddooe9:DJ  !(O!$//2DO ??Q DO $! 38K8KKqPDO!__t>BDNyy4>>) NN T__, OO  $yy1}>BDO >!AA!EtWDNyy4??*%)YY]"%)"yy4>>)!%Q!%#DODO!DN"DO!DN!%D !DNDJ dJJ'YI& DI .)$ %vd4??&;<  s*J2J5J21J25K7-K22K7c$SRU5$)NaPage: Collection type: {0.collection_type} Current page: {0.page} First item: {0.first_item} Last item: {0.last_item} First page: {0.first_page} Last page: {0.last_page} Previous page: {0.previous_page} Next page: {0.next_page} Items per page: {0.items_per_page} Total number of items: {0.item_count} Number of pages: {0.page_count} )rr&s r+__str__ Page.__str__=s 7 &, cNSRURUR5$)Nz)rrrr.s r+__repr__ Page.__repr__Ms.55diiQQr1c U =(d 0n U =(d 0n U =(d 0n XlX@lXlXlX lU =(d UR UlURS:XdURS:XaU(dg[R"SU5n U (aU RS5nOSn[U5nXl URUUUUUUUUU U U S9 nURX5n[R"SUU5nUR UR":=(a UR US5=(d SnUR UR$:=(a UR US5=(d SnUR&=(a UR US 5=(d SnUR(=(a UR US 5=(d Sn[+U5R-UR"UR$UR URUR.UR0UR2UR4UUUUS . 5nU$) a 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: '<<' (<<) symbol_last String to be displayed as the text for the $link_last link above. Default: '>>' (>>) symbol_previous String to be displayed as the text for the $link_previous link above. Default: '<' (<) symbol_next String to be displayed as the text for the $link_next link above. Default: '>' (>) 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. rr ~(\d+)~) rurlshow_if_single_page separator symbol_first symbol_lastsymbol_previous symbol_next link_attr curpage_attr dotdot_attrrrr#r$) rrrrrr r"r link_first link_last link_previous link_next)rAr;r@rBr9default_link_taglink_tagrresearchgrouprradiuslink_map_rangesubrrrr#r$rsafe_substituterr r"r)r&rr9r:r;r<r=r>r?r@rArBrH regex_resrLrM links_markupresultrCrDrErFs r+pager Page.pagerPs \O #)r !'R (""& 9D$9$9  ??a DOOq$8ATIIj&1 __Q'FFV == 3%#+#%#!  {{84  L&9 II ' QDMM(<:P,Q WUW  II & O4==+9N+O USU     K4==/1J#K Qr NNKt}}Xk5J'KQr &!11"oo!^^ "oo"&"5"5"oo!^^"oo(&!.&  " r1c U =(d 0n U =(d 0n U =(d 0n XlX@lXlXlX l[ R "SU5n U (aU RS5n OSn [U 5n Xl UR(a#[URURU - 5OSnUR(a#[URURU -5OSnSSSSSUR/S.nUbUcU$S[U5URURUR!UR5S.US'XR- S:a$USR#S S URS SS .5 [%XS-5HnUUR:XaaUSR#S [U5UURUR!U5S.5 UURS UR!U5S.US 'MtUSR#S[U5UURUR!U5S.5 M URU- S:a$USR#S S URS SS .5 S[U5URUR!UR5URS .US'S[U5URUR&=(d URUR!UR&=(d UR5S.US'S[U5URUR(=(d URUR!UR(=(d UR5S.US'U$)a0Return 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: '<<' (<<) symbol_last String to be displayed as the text for the $link_last link above. Default: '>>' (>>) symbol_previous String to be displayed as the text for the $link_previous link above. Default: '<' (<) symbol_next String to be displayed as the text for the $link_next link above. Default: '>' (>) 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' } r7r r8N)rrr#r$ current_pagerL range_pagesr)r valueattrsnumberhrefrXspanz..r6)r rYrZr\r[rW)r rYr[rZr\)rYrZr r\rrr#r$)rAr;r@rBr9rIrJrKrrLrmaxrrr!unicoderappendranger#r$)r&rr9r:r;r<r=r>r?r@rArBrQrL leftmost_pagerightmost_page nav_itemsthispages r+rM Page.link_maps?tO #)r !'R (""&IIj&1 __Q'FFV ;?//C$))f"4 6t :>CV!3 5T  ! kk   N$: !\*^^ooNN4??3 # , ?? *Q . m $ + +"!!--"  ma-?@H499$-(// .!(!2"*!%!2!2 $x 8 &!..* NN84 - .)-(// &!(!2"*!% $x 8 +AB >>N *Q . m $ + +"!!--"   [)^^NN4>>2nn " +$_-^^((;DOONN4#5#5#HI & /" [)^^nn6NN4>>#CT^^D " +r1c[URURU- 5n[URURU-5n/nURUR:waTURU:aDUSR 5n[ US5US'URURU55 USH#nURURU55 M% URUR:waSX@R:aDUSR 5n[ US5US'URURU55 URRU5$)zC Return range of linked pages to substitute placeholder in pattern rr[rYrXr) r^rrr!rcopyr_r`rHr;join)r&rMrLrbrcrdritems r+rN Page._ranges& DOOdii&.@B T^^dii&.@B  99 'DOOm,KL)..0D#DN3DM   T]]40 1]+D   T]]40 1, 99 &>NN+JK(--/D#DN3DM   T]]40 1~~""9--r1cURc [S5eSUR;a [S5eURRS[U55$)NzGYou need to specify a 'url' parameter containing a '$page' placeholder.z$pagez7The 'url' parameter must contain a '$page' placeholder.)r9 Exceptionreplacer_)r& page_numbers r+rPage._default_url_maker!sR 88 Y  $(( "UV Vxx)=>>r1cUSnUSnUS(a USS;a US(a[S0USD6U-S-nU$[S XS.USD6$) z3 Create an A-HREF tag that points to another page. rYr\r )r]rWrZz)textr\)r])a) make_html_tag)rjrr target_urls r+rGPage.default_link_tag,sg G}&\ F|tF|/GGG}$=tG}=DyPKNtNW NNr1)r rrArBr rrrrrr"rr@rHr$rrr#rLr;r9r)r NNN) ~2~NF <<>><>NNNN) rxNFryrzr{r|r}NNN)__name__ __module__ __qualname____firstlineno____doc__r%r/r3rTrMrNr staticmethodrG__static_attributes__r1r+rrs.fG(R R  !qj !@D.8 ? O Or1rc Sn[UR55H*upEURS5nUSRXE5- nM, SRX5nU(aUSRX5- nU$)aCreate 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") -> Hello 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.r6_z {0}="{1}"z<{0}{1}>z {0})sortedrlstripr)tagrrparams params_stringkeyrY tag_strings r+rtrt<sx$MV\\^, jjo--c99 -##C7J l))$44 r1)N)r __author__ __copyright__ __credits__ __license__ __version____maintainer__ __email__ __status__rIstringrsys version_infoPY3strr_rrrtrr1r+rsxgR E l   , 1     qQGv O4v Or#r1