Django fournit quelques classes qui aident à effectuer de la pagination de données, c’est-à-dire des données qui sont partagées en plusieurs pages, avec des liens « Précédent/Suivant ». Ces classes se trouvent dans django/core/paginator.py.
En donnant à Paginator une liste d’objets ainsi que le nombre d’éléments souhaités sur chaque page, cette classe vous offre des méthodes pour accéder aux éléments des différentes pages :
>>> from django.core.paginator import Paginator\n>>> objects = ['john', 'paul', 'george', 'ringo']\n>>> p = Paginator(objects, 2)\n\n>>> p.count\n4\n>>> p.num_pages\n2\n>>> type(p.page_range) # `<type 'rangeiterator'>` in Python 2.\n<class 'range_iterator'>\n>>> p.page_range\nrange(1, 3)\n\n>>> page1 = p.page(1)\n>>> page1\n<Page 1 of 2>\n>>> page1.object_list\n['john', 'paul']\n\n>>> page2 = p.page(2)\n>>> page2.object_list\n['george', 'ringo']\n>>> page2.has_next()\nFalse\n>>> page2.has_previous()\nTrue\n>>> page2.has_other_pages()\nTrue\n>>> page2.next_page_number()\nTraceback (most recent call last):\n...\nEmptyPage: That page contains no results\n>>> page2.previous_page_number()\n1\n>>> page2.start_index() # The 1-based index of the first item on this page\n3\n>>> page2.end_index() # The 1-based index of the last item on this page\n4\n\n>>> p.page(0)\nTraceback (most recent call last):\n...\nEmptyPage: That page number is less than 1\n>>> p.page(3)\nTraceback (most recent call last):\n...\nEmptyPage: That page contains no results\nPaginator dans une vueLien vers cette rubrique#Voici un exemple un peu plus complexe qui utilise Paginator dans une vue pour paginer un résultat de requête. Nous présentons à la fois la vue et le gabarit correspondant pour vous montrer comment afficher les résultats. Cet exemple part du principe qu’il existe un modèle Contacts qui a déjà été importé.
La fonction de vue ressemble à ceci :
\nfrom django.core.paginator import Paginator, EmptyPage, PageNotAnInteger\nfrom django.shortcuts import render\n\ndef listing(request):\n contact_list = Contacts.objects.all()\n paginator = Paginator(contact_list, 25) # Show 25 contacts per page\n\n page = request.GET.get('page')\n try:\n contacts = paginator.page(page)\n except PageNotAnInteger:\n # If page is not an integer, deliver first page.\n contacts = paginator.page(1)\n except EmptyPage:\n # If page is out of range (e.g. 9999), deliver last page of results.\n contacts = paginator.page(paginator.num_pages)\n\n return render(request, 'list.html', {'contacts': contacts})\nDans le gabarit list.html, il est nécessaire d’inclure des éléments de navigation pour passer d’une page à l’autre, ainsi que des informations utiles sur les objets eux-mêmes :
{% for contact in contacts %}\n {# Each "contact" is a Contact model object. #}\n {{ contact.full_name|upper }}<br />\n ...\n{% endfor %}\n\n<div class="pagination">\n <span class="step-links">\n {% if contacts.has_previous %}\n <a href="?page={{ contacts.previous_page_number }}">previous</a>\n {% endif %}\n\n <span class="current">\n Page {{ contacts.number }} of {{ contacts.paginator.num_pages }}.\n </span>\n\n {% if contacts.has_next %}\n <a href="?page={{ contacts.next_page_number }}">next</a>\n {% endif %}\n </span>\n</div>\nPaginatorLien vers cette rubrique#Voici le constructeur de la classe Paginator :
object_listUne 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.
per_pageLe nombre maximum d’éléments à inclure dans une page, sans tenir compte des orphelins (voir le paramètre facultatif orphans ci-dessous).
orphansUtilisez 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.
allow_empty_first_pageIndique si la première page peut être vide. Avec la valeur False et une liste object_list vide, une erreur EmptyPage sera produite.
Renvoie un objet Page correspondant à l’index number (commençant à 1). Si le numéro de page indiqué n’existe pas, une exception InvalidPage est levée.
Le nombre total d’objets sur toutes les pages.
\n\nLe nombre total de pages.
\nUne itération d’intervalle de numéros de pages commençant à 1, par ex. produisant [1, 2, 3, 4].
InvalidPageLien vers cette rubrique#Une classe de base pour les exceptions levées lorsqu’un paginateur reçoit un numéro de page non valable.
\nLa méthode Paginator.page() lève une exception quand la page demandée n’est pas valable (par ex. ce n’est 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 :
Levée lorsque page() reçoit une valeur qui n’est pas un nombre entier.
Levé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 par une simple ligne except InvalidPage.
PageLien vers cette rubrique#Les objets Page ne sont normalement pas construits manuellement, mais plutôt obtenus en appelant Paginator.page().
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.
Renvoie True s’il existe une page suivante.
Renvoie True s’il existe une page précédente.
Renvoie True s’il existe une page suivante ou une page précédente.
Renvoie le prochain numéro de page. Génère InvalidPage s’il n’y a pas de page suivante.
Renvoie le numéro de page précédent. Génère InvalidPage s’il n’y a pas de page précédente.
Renvoie l’index (commençant par 1) du premier objet de la page, relatif à tous les autres objets de la liste du paginateur. Par exemple, lors de la pagination d’une liste de 5 objets par groupes de 2, la méthode start_index() de la deuxième page renverrait 3.
Renvoie l’index (commençant par 1) du dernier objet de la page, relatif à tous les autres objets de la liste du paginateur. Par exemple, lors de la pagination d’une liste de 5 objets par groupes de 2, la méthode end_index() de la deuxième page renverrait 4.
La liste des objets de cette page.
\nLe numéro de page (commençant par 1) de cette page.
\nL’objet Paginator associé.