Implementing Pagination

Welcome back! You've secured your application with middleware and learned how to handle data validation and errors. Now, it’s time to make your To-Do list more user-friendly by implementing pagination. This feature is crucial for giving users a smooth experience when they have many tasks.

In this section, you’ll learn how to implement pagination in your Django application. Pagination divides your content into separate pages, making it easier for users to navigate through large sets of data.

1. Paginating Data: The goal is to retrieve a subset of To-Do tasks for each page. We’ll utilize Django’s ORM queries to handle this.

   For example, let’s begin by implementing a view in project/myapp/views.py that handles pagination:

   Python

   from django.http import JsonResponse
   from .models import Todo
   
   def get_todos(request):
       if request.method == 'GET':
           page = request.GET.get('page', 1)
           page = int(page) if page.isdigit() else 1
           page = 1 if page < 1 else page
   
           page_size = 3
           start_index = (page - 1) * page_size
           end_index = start_index + page_size
   
           todos = Todo.objects.filter(user=request.user)[start_index:end_index]
           return JsonResponse({'todos': list(todos.values())})

   Let’s break down the code:

   • We retrieve the page number from the query parameters and make sure it’s a positive integer.
   • We define the number of tasks to display per page (page_size).
   • We calculate the start and end indices to slice the tasks.
   • We filter the tasks based on the user and return the paginated tasks as JSON. Note that we use the values() method to serialize the tasks as dictionaries.

2. Building the Request: Finally, we’ll demonstrate how to make requests to the paginated endpoint and render the tasks in a user-friendly manner.

   For instance, checking how many pages of tasks we have would involve making requests in a loop:

   Python

   import requests
   URL = 'http://127.0.0.1:3000'
   page = 1
   headers = {'Authorization': 'Token abc123'}
   
   while True:
       response = requests.get(URL + f'/todos/?page={page}', headers=headers)
       data = response.json()
       todos = data.get('todos')
       if not todos:
           break
       print(f"Page {page}: {todos}")
       page += 1

   Here, we send the request to the /todos/ endpoint with the page number. We then print the tasks for each page until we receive an empty list.