Django ViewClass 2-6) Pagination, Template filter

📌Pagination

• 데이터를 페이지를 구분해서 조회하는 로직이나 모듈

  • Django에서는 Paginator를 제공
  • Paginator(QuerySet, 한 페이지당 보여질 데이터의 개수) 형태로 초기화
  • get_page(페이지번호) 메소드를 활용
  • ListView에서는 paginate_by 필드로 페이지네이션을 구현

• Django는 페이지가 매겨진 데이터, 즉 "이전/다음" 링크를 사용하여 여러 페이지에 걸쳐 분할된 데이터를 관리하는데 도움이 되는 상위 수준 및 하위 수준 방법을 제공한다.

• Page Class를 사용해서 페이지네이션을 구현할 수 있다.

참고문서 - Django Pagination

📌Paginating a 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

{% 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>

• ListView를 통해서 페이지네이션을 구현하는 경우 리턴할 때 변수명을 지정하면 템플릿에서 그 변수명을 사용해야하지만 만약 지정하지 않으면 page_obj라는 이름으로 이터레이션을 수행해야 정상적으로 페이지네이션이 구현이 된다.

---

📌Using Paginator in a view function

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})

---

📌적용

• page-range를 적용하게 된다면 데이터의 개수가 기하급수적으로 늘어날 경우 모든 페이지가 표시되는 문제가 발생한다. 페이지 단위로 리턴하는 메소드를 만들어 템플릿에서 호출할 수 있다.

from django.http import HttpRequest, HttpResponse
from django.shortcuts import render, HttpResponseRedirect, redirect
from django.views.generic import TemplateView, CreateView, UpdateView, DeleteView, ListView, DetailView, FormView
from .models import Task, ChecklistItem
from django.utils import timezone
from django.core.paginator import Paginator
from django.urls import reverse_lazy

class TaskListView(TemplateView):
    template_name = 'pages/task_list.html'
    
    def get_context_data(self, **kwargs):
        # tasks → QuerySet(리스트 형태X)
        tasks = Task.objects.filter(due__gte=timezone.now()).order_by('-due').all()
        paginator = Paginator(tasks, 4)
        page_number = self.request.GET.get('page', 1)
        paging = paginator.get_page(page_number)
        return {
            'paging' : paging,
        }

<div class="row mt-4">
    <nav class="col-12">
        <ul class="pagination justify-content-center">
            {% if paging.has_previous %}
            <li class="page-item">
                <a class="page-link" href="?page={{paging.previous_page_number}}">이전</a>
            </li>
            {% endif %}
			
          	<!-- Paginator.page_range A 1-based range iterator of page numbers, e.g. yielding [1, 2, 3, 4].-->
            {% for page in paging|slice_visible_pages %}
            {% if paging.number == page %}
                <li class="page-item active">
                {% else %}
                <li class="page-item"></li> 
                {% endif %}
                <a class="page-link" href="?page={{page}}">{{page}}</a>
                </li>
            {% endfor %}

            {% if paging.has_next %}
            <li class="page-item">
                <a class="page-link" href="?page={{paging.next_page_number}}">다음</a>
            </li>
            {% endif %}
        </ul>
    </nav>
</div>

📌page_range의 단점을 해결하기 위한 템플릿 필터 적용

①. templatetags 폴더 생성(이 때, 일반 폴더가 아니라 Python Packages로 생성)
②. templatetags 하위에 pagination_tags.py 파일 생성

from django import template
from django.core.paginator import Page

register = template.Library()

@register.filter(name="slice_visible_pages")
def slice_visible_pages(paging: Page):
    min_page = int((paging.number - 1) / 10) * 10 + 1
    
    # 음수가 나올 수 있으므로 페이지의 시작값을 무조건 1로 설정하기 위함
    min_page = max(min_page, 1)
    max_page = min(min_page + 9, paging.paginator.num_pages)
    return range(min_page, max_page+1)

참고 자료 - Django Custom Template tags and filters

Registering custom filters

from django import template
from django.template.defaultfilters import stringfilter

register = template.Library()

@register.filter(name="cut")
def cut(value, arg):
    return value.replace(arg, "")

• custom template tags and filters를 사용할 경우 데코레이터 형식으로 이름을 지정한다.
• 이름을 지정 후 사용할 템플릿으로 이동 후 {% load %} 문을 이용해서 로드한 후 or을 이용해서 아래와 같이 작성해야 사용이 가능하다.

{% load pagination_tags %}

...

{% for page in paging|slice_visible_pages %}