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

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

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

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

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

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

class PublisherList(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 PublisherDetail(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 PublisherDetail(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 BookList(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 AcmeBookList(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 PublisherBookList

urlpatterns = [
    path('books/<publisher>/', PublisherBookList.as_view()),
]

Далее мы напишем сам вид PublisherBookList:

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

class PublisherBookList(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