PaginationLien vers cette rubrique#

Classe PaginatorLien vers cette rubrique#

class Paginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None)Lien vers cette définition#

Un paginateur se comporte comme une liste d’objets Page lorsqu’on lui applique len() ou qu’on itère directement sur lui.

Paginator.object_listLien vers cette définition#

Obligatoire. Une liste, un tuple, un QuerySet ou tout autre objet segmentable et doté d’une méthode count() ou __len__(). Pour une pagination cohérente, les QuerySet doivent être triés, par ex. avec une clause order_by() ou avec un tri par défaut ordering sur le modèle.

Paginator.per_pageLien vers cette définition#

Obligatoire. Le nombre maximum d’éléments à inclure dans une page, sans tenir compte des orphelins (voir le paramètre facultatif orphans ci-dessous).

Paginator.orphansLien vers cette définition#

Facultatif. Utilisez ce paramètre lorsque vous ne souhaitez pas de dernière page avec très peu d’éléments. Lorsque la dernière page ne contient que le nombre orphans d’éléments ou moins, ces éléments sont alors ajoutés à la page précédente (qui devient la dernière page) au lieu de les laisser seuls sur une page. Par exemple, avec 23 éléments, per_page=10 et orphans=3, il y aura deux pages ; la première avec 10 éléments et la seconde (et dernière) avec 13 éléments. orphans vaut zéro par défaut, ce qui signifie que les pages ne sont jamais jointes et que la dernière page peut ne posséder qu’un seul élément.

Paginator.allow_empty_first_pageLien vers cette définition#

Facultatif. Indique si la première page peut être vide. Avec la valeur False et une liste object_list vide, une erreur EmptyPage sera produite.

Paginator.error_messagesLien vers cette définition#

Le paramètre error_messages permet de redéfinir les messages par défaut que le paginateur génère. Passez un dictionnaire dont les clés correspondent aux messages d’erreur que vous voulez redéfinir. Les clés de messages d’erreur disponibles sont : invalid_page, min_page et no_results.

Par exemple, voici le message d’erreur par défaut :

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

Et voici un message d’erreur personnalisé :

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

Classe PageLien vers cette rubrique#

Les objets Page ne sont normalement pas construits manuellement, mais plutôt obtenus en itérant sur Paginator ou en appelant Paginator.page().

class Page(object_list, number, paginator)Lien vers cette définition#

Une page se comporte comme un liste de Page.object_list lorsqu’on lui applique len() ou qu’on effectue une itération sur elle.

ExceptionsLien vers cette rubrique#

exception InvalidPageLien vers cette définition#

Une classe de base pour les exceptions levées lorsqu’un paginateur reçoit un numéro de page non valable.

La méthode Paginator.page() lève une exception quand la page demandée n’est pas valable (par ex. pas un nombre entier) ou quand elle ne contient aucun objet. Il est généralement suffisant d’intercepter l’exception InvalidPage, mais si vous souhaitez plus de finesse, vous pouvez intercepter l’une des exceptions suivantes :

exception PageNotAnIntegerLien vers cette définition#

Générée lorsque page() reçoit une valeur qui n’est pas un nombre entier.

exception EmptyPageLien vers cette définition#

Générée lorsque page() reçoit une valeur valable, mais que la page en question ne contient pas d’objet.

Ces deux exceptions sont des sous-classes de InvalidPage, il est donc possible de les intercepter toutes deux par une ligne except InvalidPage.