PaginatorLink to this heading#

klassen PaginatorLink to this heading#

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)Link to this definition#

En paginator fungerar som en sekvens av Page när du använder len() eller itererar den direkt.

Paginator.object_listLink to this definition#

Krävs. En lista, tupel, QuerySet eller annat objekt som kan skäras med en count() eller __len__() metod. För konsekvent paginering bör QuerySet beställas, t.ex. med en order_by() klausul eller med en standard ordering på modellen.

Paginator.per_pageLink to this definition#

Obligatoriskt. Det maximala antalet objekt som ska inkluderas på en sida, exklusive föräldralösa barn (se det valfria argumentet orphans nedan).

Paginator.orphansLink to this definition#

Optional. Use this when you don’t want to have a last page with very few items. If the last page would normally have a number of items less than or equal to orphans, then those items will be added to the previous page (which becomes the last page) instead of leaving the items on a page by themselves. For example, with 23 items, per_page=10, and orphans=3, there will be two pages; the first page with 10 items and the second (and last) page with 13 items. orphans defaults to zero, which means pages are never combined and the last page may have one item. orphans should be less than the per_page value.

Paginator.allow_empty_first_pageLink to this definition#

Optional. Whether or not the first page is allowed to be empty. If False and object_list is empty, then an EmptyPage error will be raised.

Paginator.error_messagesLink to this definition#

Med argumentet error_messages kan du åsidosätta de standardmeddelanden som paginatorn kommer att ge. Skicka in en ordbok med nycklar som matchar de felmeddelanden som du vill åsidosätta. Tillgängliga nycklar för felmeddelanden är: invalid_page, min_page och no_results.

Här är till exempel standardfelmeddelandet:

Python console

>>> from django.core.paginator import Paginator
>>> paginator = Paginator([1, 2, 3], 2)
>>> paginator.page(5)
Traceback (most recent call last):
  ...
EmptyPage: That page contains no results

Och här är ett anpassat felmeddelande:

Python console

>>> paginator = Paginator(
...     [1, 2, 3],
...     2,
...     error_messages={"no_results": "Page does not exist"},
... )
>>> paginator.page(5)
Traceback (most recent call last):
  ...
EmptyPage: Page does not exist

AsyncPaginator classLink to this heading#

class AsyncPaginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)Link to this definition#

Asynchronous version of Paginator.

AsyncPaginator has the same attributes and signatures as Paginator, with the following exceptions:

• The attribute Paginator.count is supported as an asynchronous method AsyncPaginator.acount().

• The attribute Paginator.num_pages is supported as an asynchronous method AsyncPaginator.anum_pages().

• The attribute Paginator.page_range is supported as an asynchronous method AsyncPaginator.apage_range().

AsyncPaginator has asynchronous versions of the same methods as Paginator, using an a prefix - for example, use await async_paginator.aget_page(number) rather than paginator.get_page(number).

klass PageLink to this heading#

Du konstruerar vanligtvis inte Page-objekt för hand - du får dem genom att iterera Paginator, eller genom att använda Paginator.page().

class Page(object_list, number, paginator)Link to this definition#

En sida fungerar som en sekvens av Page.object_list när man använder len() eller itererar den direkt.

AsyncPage classLink to this heading#

class AsyncPage(object_list, number, paginator)Link to this definition#

Asynchronous version of Page.

AsyncPage has the same attributes and signatures as Page, as well as asynchronous versions of all the same methods, using an a prefix - for example, use await async_page.ahas_next() rather than page.has_next().

AsyncPage has the following additional method:

aget_object_list()Link to this definition#

Returns AsyncPage.object_list as a list. This method must be awaited before AsyncPage can be treated as a sequence of AsyncPage.object_list.

UndantagLink to this heading#

exception InvalidPageLink to this definition#

En basklass för undantag som uppstår när en paginator får ett ogiltigt sidnummer.

Metoden Paginator.page() ger upphov till ett undantag om den begärda sidan är ogiltig (dvs. inte ett heltal) eller inte innehåller några objekt. I allmänhet räcker det med att fånga undantaget InvalidPage, men om du vill ha mer detaljerad information kan du fånga något av följande undantag:

exception PageNotAnIntegerLink to this definition#

Uppstår när page() ges ett värde som inte är ett heltal.

exception EmptyPageLink to this definition#

Utlöses när page() ges ett giltigt värde men inga objekt finns på den sidan.

Båda undantagen är subklasser av InvalidPage, så du kan hantera dem båda med except InvalidPage.