Общие представления на основе классов, предоставляемые Django ¶

Построение «умных» шаблонных контекстов ¶

Возможно, вы заметили, что в нашем образце шаблона списка издателей все издатели хранятся в именованной переменной 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 - это не единственный способ определить тип объекта представления, также можно определить список объектов с помощью параметра 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 отфильтрованному параметру мы также указываем имя настраиваемого шаблона. Без этого в общем представлении использовался бы тот же шаблон, что и в «стандартном» списке объектов, что не соответствовало бы намеченному назначению.

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

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

Другая частая необходимость - фильтровать объекты списка по критерию URL. Выше мы зафиксировали имя издателя в конфигурации URL, но что, если бы мы хотели написать представление, показывающее все книги свободно выбранного издателя?

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

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

Здесь у нас есть настройка URL с одной захваченной группой:

# 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 класс ничего не знает об этом поле, но мы снова можем написать собственное представление, чтобы это поле обновлялось.

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

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