分頁

Django 提供了高階和低階的方法來協助您管理分頁資料——也就是，將資料分割到多個頁面，並帶有「上一頁/下一頁」連結。

Paginator 類別

在底層，所有分頁方法都使用 Paginator 類別。它負責將 QuerySet 實際分割成 Page 物件的繁重工作。

範例

給 Paginator 一個物件列表，以及您希望每頁顯示的項目數量，它會提供您存取每個頁面項目的方法

>>> from django.core.paginator import Paginator
>>> objects = ["john", "paul", "george", "ringo"]
>>> p = Paginator(objects, 2)

>>> p.count
4
>>> p.num_pages
2
>>> type(p.page_range)
<class 'range_iterator'>
>>> p.page_range
range(1, 3)

>>> page1 = p.page(1)
>>> page1
<Page 1 of 2>
>>> page1.object_list
['john', 'paul']

>>> page2 = p.page(2)
>>> page2.object_list
['george', 'ringo']
>>> page2.has_next()
False
>>> page2.has_previous()
True
>>> page2.has_other_pages()
True
>>> page2.next_page_number()
Traceback (most recent call last):
...
EmptyPage: That page contains no results
>>> page2.previous_page_number()
1
>>> page2.start_index()  # The 1-based index of the first item on this page
3
>>> page2.end_index()  # The 1-based index of the last item on this page
4

>>> p.page(0)
Traceback (most recent call last):
...
EmptyPage: That page number is less than 1
>>> p.page(3)
Traceback (most recent call last):
...
EmptyPage: That page contains no results

注意

請注意，您可以給 Paginator 一個列表/元組、Django QuerySet 或任何其他具有 count() 或 __len__() 方法的物件。在判斷傳入物件中包含的物件數量時，Paginator 將首先嘗試呼叫 count()，然後在傳入的物件沒有 count() 方法時，回退使用 len()。這允許像是 Django 的 QuerySet 等物件在可用時使用更有效率的 count() 方法。

將 ListView 分頁

django.views.generic.list.ListView 提供了一種內建的方式來對顯示的列表進行分頁。您可以透過將 paginate_by 屬性新增到您的視圖類別中來完成此操作，例如

from django.views.generic import ListView

from myapp.models import Contact


class ContactListView(ListView):
    paginate_by = 2
    model = Contact

這會限制每頁的物件數量，並將 paginator 和 page_obj 新增到 context 中。為了讓使用者可以在頁面之間導覽，請在您的樣板中新增連結到上一頁和下一頁，如下所示

{% for contact in page_obj %}
    {# Each "contact" is a Contact model object. #}
    {{ contact.full_name|upper }}<br>
    ...
{% endfor %}

<div class="pagination">
    <span class="step-links">
        {% if page_obj.has_previous %}
            <a href="?page=1">&laquo; first</a>
            <a href="?page={{ page_obj.previous_page_number }}">previous</a>
        {% endif %}

        <span class="current">
            Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}.
        </span>

        {% if page_obj.has_next %}
            <a href="?page={{ page_obj.next_page_number }}">next</a>
            <a href="?page={{ page_obj.paginator.num_pages }}">last &raquo;</a>
        {% endif %}
    </span>
</div>

在視圖函式中使用 Paginator

這是一個在視圖函式中使用 Paginator 來分頁查詢集的範例

from django.core.paginator import Paginator
from django.shortcuts import render

from myapp.models import Contact


def listing(request):
    contact_list = Contact.objects.all()
    paginator = Paginator(contact_list, 25)  # Show 25 contacts per page.

    page_number = request.GET.get("page")
    page_obj = paginator.get_page(page_number)
    return render(request, "list.html", {"page_obj": page_obj})

在樣板 list.html 中，您可以包含在頁面之間導覽的方式，與上方 ListView 的樣板相同。

記錄
Django 中的安全性
回到頂部