Базовые представления на основе классов

Основные примеры

Django предоставляет базовые классы представлений, которые подойдут для широкого спектра приложений. Все представления наследуются от класса View, который обрабатывает связывание представления с URL-адресами, распределение по HTTP-методам и другие общие функции. RedirectView предоставляет перенаправление HTTP, а TemplateView расширяет базовый класс, чтобы он также отображал шаблон.

Использование в вашем URLconf

Самый прямой способ использования универсальных представлений — создание их непосредственно в вашем URLconf. Если вы только изменяете несколько атрибутов представления на основе класса, вы можете передать их в вызов метода as_view():

from django.urls import path
from django.views.generic import TemplateView

urlpatterns = [
    path("about/", TemplateView.as_view(template_name="about.html")),
]

Любые аргументы, переданные методу as_view(), переопределят атрибуты, установленные в классе. В этом примере мы установили template_name для TemplateView. Аналогичный шаблон переопределения можно использовать для атрибута url в RedirectView.

Наследование от универсальных представлений

Второй, более мощный способ использования универсальных представлений — это наследование от существующего представления и переопределение атрибутов (например, template_name) или методов (например, get_context_data) в вашем подклассе, чтобы предоставить новые значения или методы. Например, рассмотрите представление, которое просто отображает один шаблон, about.html. Django имеет универсальное представление для этого — TemplateView — поэтому мы можем унаследовать от него и переопределить имя шаблона:

# some_app/views.py
from django.views.generic import TemplateView


class AboutView(TemplateView):
    template_name = "about.html"

Затем нам нужно добавить это новое представление в наш URLconf. TemplateView — это класс, а не функция, поэтому мы указываем URL-адрес на метод класса as_view(), который предоставляет функциональный интерфейс для представлений на основе классов:

# urls.py
from django.urls import path
from some_app.views import AboutView

urlpatterns = [
    path("about/", AboutView.as_view()),
]

Для получения более подробной информации о том, как использовать встроенные универсальные представления, обратитесь к следующей теме о универсальных представлениях на основе классов.

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

urlpatterns = [
    path("books/", BookListView.as_view()),
]

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


class BookListView(ListView):
    model = Book

    def head(self, *args, **kwargs):
        last_book = self.get_queryset().latest("publication_date")
        response = HttpResponse(
            # RFC 1123 date format.
            headers={
                "Last-Modified": last_book.publication_date.strftime(
                    "%a, %d %b %Y %H:%M:%S GMT"
                )
            },
        )
        return response

Асинхронные представления на основе классов

Помимо уже показанных синхронных (def) обработчиков методов, View подклассы могут определять асинхронные (async def) обработчики методов, чтобы использовать асинхронный код с помощью await:

import asyncio
from django.http import HttpResponse
from django.views import View


class AsyncView(View):
    async def get(self, request, *args, **kwargs):
        # Perform io-blocking view logic using await, sleep for example.
        await asyncio.sleep(1)
        return HttpResponse("Hello async world!")

В пределах одного класса представления все пользовательские обработчики методов должны быть либо синхронными, используя def, либо все асинхронными, используя async def. Исключение ImproperlyConfigured будет поднято в as_view(), если def и async def объявления смешаны.

Django автоматически обнаружит асинхронные представления и запустит их в асинхронном контексте. Вы можете узнать больше об асинхронной поддержке Django и о том, как лучше использовать асинхронные представления, в Асинхронной поддержке.