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

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

Вы могли заметить, что в нашем образце шаблона списка издателей все издатели хранятся в переменной с именем 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 = Publisherqueryset = Publisher.objects.all()querysetQuerySet

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

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; а также request ( self.request) он включает аргументы positional ( self.args) и name-based ( 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