Встроенные обобщенные представления на основе классов

Создание «дружественных» контекстов шаблонов

Вы могли заметить, что наш пример шаблона списка издательств хранит всех издателей в переменной под названием object_list. Хотя это работает, это не очень «дружелюбно» для авторов шаблонов: им нужно «просто знать», что они имеют дело с издательствами.

Ну, если вы работаете с объектом модели, это уже сделано за вас. При работе с объектом или набором запросов Django может заполнить контекст, используя нижний регистр имени класса модели. Это предоставляется в дополнение к стандартному элементу object_list, но содержит точно такие же данные, т.е. publisher_list.

Если этого всё ещё недостаточно, вы можете вручную задать имя переменной контекста. Атрибут context_object_name в общем представлении определяет используемую переменную контекста:

# views.py
from django.views.generic import ListView
from books.models import Publisher


class PublisherListView(ListView):
    model = Publisher
    context_object_name = "my_favorite_publishers"

Предоставление полезного context_object_name всегда хорошая идея. Ваши коллеги, которые разрабатывают шаблоны, поблагодарят вас.

Добавление дополнительного контекста

Часто вам нужно предоставить дополнительную информацию, помимо той, что предоставляется общим представлением. Например, представьте себе, что вы хотите отобразить список всех книг на каждой странице сведений об издательстве. Общее представление DetailView предоставляет издательство в контекст, но как получить дополнительную информацию в этом шаблоне?

Ответ заключается в наследовании от DetailView и предоставлении собственной реализации метода get_context_data. Стандартная реализация добавляет отображаемый объект в шаблон, но вы можете переопределить его, чтобы отправить больше:

from django.views.generic import DetailView
from books.models import Book, Publisher


class PublisherDetailView(DetailView):
    model = Publisher

    def get_context_data(self, **kwargs):
        # Call the base implementation first to get a context
        context = super().get_context_data(**kwargs)
        # Add in a QuerySet of all the books
        context["book_list"] = Book.objects.all()
        return context

Просмотр подмножеств объектов

Теперь давайте подробнее рассмотрим аргумент model, который мы использовали всё это время. Аргумент model, который определяет модель базы данных, с которой будет работать представление, доступен во всех общих представлениях, которые работают с одним объектом или набором объектов. Однако аргумент model – не единственный способ указать объекты, с которыми будет работать представление; вы также можете указать список объектов, используя аргумент queryset:

from django.views.generic import DetailView
from books.models import Publisher


class PublisherDetailView(DetailView):
    context_object_name = "publisher"
    queryset = Publisher.objects.all()

Указание model = Publisher – это сокращение для указания queryset = Publisher.objects.all(). Однако, используя queryset для определения отфильтрованного списка объектов, вы можете быть более конкретны относительно объектов, которые будут отображаться в представлении (см. Выполнение запросов для получения дополнительной информации об объектах QuerySet и см. Справочник по представлениям на основе классов для получения полной информации).

В качестве примера мы можем отсортировать список книг по дате публикации, начиная с самых новых:

from django.views.generic import ListView
from books.models import Book


class BookListView(ListView):
    queryset = Book.objects.order_by("-publication_date")
    context_object_name = "book_list"

Это довольно минимальный пример, но он хорошо иллюстрирует идею. Обычно вам нужно сделать больше, чем просто переупорядочить объекты. Если вы хотите отобразить список книг определённого издательства, вы можете использовать тот же метод:

from django.views.generic import ListView
from books.models import Book


class AcmeBookListView(ListView):
    context_object_name = "book_list"
    queryset = Book.objects.filter(publisher__name="ACME Publishing")
    template_name = "books/acme_list.html"

Обратите внимание, что вместе с отфильтрованным queryset мы также используем пользовательское имя шаблона. В противном случае общее представление использовало бы тот же шаблон, что и в случае со списком «стандартных» объектов, что может быть не тем, что нам нужно.

Также обратите внимание, что это не очень элегантный способ создания страниц книг по издательствам. Если мы хотим добавить ещё одну страницу издательства, нам потребуется несколько строк в URLconf, а для нескольких издательств это будет неразумно. Мы решим эту проблему в следующей секции.

Динамическая фильтрация

Ещё одна распространённая потребность – фильтровать объекты на странице списка по какому-либо ключу в URL. Ранее мы жёстко кодировали имя издательства в URLconf, но что, если мы хотим создать представление, отображающее все книги какого-то произвольного издательства?

Удобно, что в ListView есть метод get_queryset(), который мы можем переопределить. По умолчанию он возвращает значение атрибута queryset, но мы можем использовать его для добавления большего количества логики.

Ключевой момент заключается в том, что при вызове представлений на основе классов различные полезные вещи хранятся в self; а также запрос (self.request), это включает позиционные (self.args) и основанные на имени (self.kwargs) аргументы, захваченные в соответствии с URLconf.

Вот URLconf с одной захваченной группой:

# urls.py
from django.urls import path
from books.views import PublisherBookListView

urlpatterns = [
    path("books/<publisher>/", PublisherBookListView.as_view()),
]

Далее мы напишем само представление PublisherBookListView:

# views.py
from django.shortcuts import get_object_or_404
from django.views.generic import ListView
from books.models import Book, Publisher


class PublisherBookListView(ListView):
    template_name = "books/books_by_publisher.html"

    def get_queryset(self):
        self.publisher = get_object_or_404(Publisher, name=self.kwargs["publisher"])
        return Book.objects.filter(publisher=self.publisher)

Использование get_queryset для добавления логики к выбору набора запросов – это так же удобно, как и мощно. Например, если нам нужно, мы можем использовать self.request.user для фильтрации по текущему пользователю или другой более сложной логике.

Мы также можем добавить издательство в контекст в то же время, чтобы использовать его в шаблоне:

# ...


def get_context_data(self, **kwargs):
    # Call the base implementation first to get a context
    context = super().get_context_data(**kwargs)
    # Add in the publisher
    context["publisher"] = self.publisher
    return context

Выполнение дополнительных операций

Последний распространённый шаблон, который мы рассмотрим, связан с выполнением дополнительных операций до или после вызова общего представления.

Представьте, что у нас есть поле last_accessed в нашей модели Author, которое используется для отслеживания последнего времени, когда кто-то смотрел на этого автора:

# models.py
from django.db import models


class Author(models.Model):
    salutation = models.CharField(max_length=10)
    name = models.CharField(max_length=200)
    email = models.EmailField()
    headshot = models.ImageField(upload_to="author_headshots")
    last_accessed = models.DateTimeField()

Общий класс представлений DetailView ничего не знал бы об этом поле, но мы снова можем написать пользовательское представление для обновления этого поля.

Сначала нам нужно добавить раздел сведений об авторе в URLconf, который указывает на пользовательское представление:

from django.urls import path
from books.views import AuthorDetailView

urlpatterns = [
    # ...
    path("authors/<int:pk>/", AuthorDetailView.as_view(), name="author-detail"),
]

Затем мы напишем наше новое представление – get_object – это метод, который извлекает объект, – поэтому мы переопределяем его и обертываем вызов:

from django.utils import timezone
from django.views.generic import DetailView
from books.models import Author


class AuthorDetailView(DetailView):
    queryset = Author.objects.all()

    def get_object(self):
        obj = super().get_object()
        # Record the last accessed date
        obj.last_accessed = timezone.now()
        obj.save()
        return obj