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

Удобный контекст шаблона

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

Если вы работаете с объектом модели, это уже сделано за вас. При работе с объектом или queryset 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 для добавления логики при выборе 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

Выполнение дополнительных действий

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

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

# 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