Class Paginator

Declaration

Methods

• ▷ def __init__(self, object_list, per_page, orphans=0, allow_empty_first_page=True)

  source link
• ▷ def __iter__(self)

  source link
• ▷ def count(self) @cached_property

  Return the total number of objects, across all pages.

  @cached_property
  def count(self)

  source link
• ▶ def get_elided_page_range(self, number=1, *, on_each_side=3, on_ends=2)

  Return a 1-based range of pages with some values elided.

  source link

  If the page range is larger than a given size, the whole range is not
  provided and a compact form is returned instead, e.g. for a paginator
  with 50 pages, if page 43 were the current page, the output, with the
  default arguments, would be:
  
      1, 2, …, 40, 41, 42, 43, 44, 45, 46, …, 49, 50.

• ▷ def get_page(self, number)

  Return a valid page, even if the page argument isn't a number or isn't in range.

  source link
• ▷ def num_pages(self) @cached_property

  Return the total number of pages.

  @cached_property
  def num_pages(self)

  source link
• ▷ def page(self, number)

  Return a Page object for the given 1-based page number.

  source link
• ▷ def page_range(self) @property

  Return a 1-based range of pages for iterating through within a template for loop.

  @property
  def page_range(self)

  source link
• ▷ def validate_number(self, number)

  Validate the given 1-based page number.

  source link

Reexports

• Imported in django.contrib.admin.options.
• Imported in django.views.generic.list.

Generated by nedoc v0.9 at 2020-12-29 14:04