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

Базовый класс представления. Все остальные представления на основе классов наследуются от этого базового класса. Это не строго обобщенное представление и, следовательно, также может быть импортировано из django.views.

Диаграмма потока методов

1. setup()
2. dispatch()
3. http_method_not_allowed()
4. options()

Пример views.py:

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


class MyView(View):
    def get(self, request, *args, **kwargs):
        return HttpResponse("Hello, World!")

Пример urls.py:

from django.urls import path

from myapp.views import MyView

urlpatterns = [
    path("mine/", MyView.as_view(), name="my-view"),
]

Атрибуты

http_method_names

Список имен HTTP-методов, которые будет принимать это представление.

По умолчанию:

["get", "post", "put", "patch", "delete", "head", "options", "trace"]

Методы

classmethod as_view(**initkwargs)

Возвращает вызываемое представление, которое принимает запрос и возвращает ответ:

response = MyView.as_view()(request)

Возвращаемое представление имеет view_class и view_initkwargs атрибуты.

При вызове представления во время цикла запрос/ответ метод setup() присваивает HttpRequest атрибуту представления request, а любые позиционные и/или ключевые аргументы полученные из шаблона URL соответственно атрибутам args и kwargs. Затем вызывается dispatch().

Если подкласс View определяет обработчики асинхронных (async def) методов, as_view() отметит возвращаемое вызываемое представление как функцию-генератор. Исключение ImproperlyConfigured будет поднято, если оба асинхронных (async def) и синхронных (def) обработчика определены в одном классе представления.

setup(request, *args, **kwargs)

Выполняет ключевую инициализацию представления перед вызовом dispatch().

Присваивает HttpRequest атрибуту представления request, а любые позиционные и/или ключевые аргументы полученные из шаблона URL соответственно атрибутам args и kwargs.

При переопределении этого метода необходимо вызвать super().

dispatch(request, *args, **kwargs)

Часть представления, связанная с обработкой запроса — метод, принимающий аргумент request плюс аргументы и возвращающий HTTP-ответ.

По умолчанию он проверяет HTTP-метод и пытается делегировать его методу, соответствующему этому методу; GET делегируется get(), POST — post() и т. д.

По умолчанию запрос HEAD будет делегирован get(). Если вам нужно обработать запросы HEAD другим способом, чем GET, вы можете переопределить метод head(). См. Поддержка других HTTP-методов для примера.

http_method_not_allowed(request, *args, **kwargs)

Если представление вызывалось с HTTP-методом, которого оно не поддерживает, вызывается этот метод вместо него.

По умолчанию он возвращает HttpResponseNotAllowed со списком разрешенных методов в виде простого текста.

options(request, *args, **kwargs)

Обрабатывает ответы на запросы с помощью HTTP-метода OPTIONS. Возвращает ответ с заголовком Allow, содержащим список разрешенных HTTP-методов представления.

Если обработчики других HTTP-методов в классе асинхронны (async def), то ответ будет обернут в функцию-генератор для использования с await.

Отображает заданный шаблон, при этом контекст содержит параметры, полученные из URL.

Предки (MRO)

Это представление наследует методы и атрибуты от следующих представлений:

• django.views.generic.base.TemplateResponseMixin
• django.views.generic.base.ContextMixin
• django.views.generic.base.View

Диаграмма потока методов

1. setup()
2. dispatch()
3. http_method_not_allowed()
4. get_context_data()

Пример views.py:

from django.views.generic.base import TemplateView

from articles.models import Article


class HomePageView(TemplateView):
    template_name = "home.html"

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context["latest_articles"] = Article.objects.all()[:5]
        return context

Пример urls.py:

from django.urls import path

from myapp.views import HomePageView

urlpatterns = [
    path("", HomePageView.as_view(), name="home"),
]

Контекст

• Заполняется (через ContextMixin) ключевыми аргументами, полученными из шаблона URL, который обслужил представление.
• Вы также можете добавить контекст, используя ключевой аргумент extra_context для as_view().

Перенаправляет на заданный URL.

Заданный URL может содержать строковую форматирование в стиле словаря, которое будет интерполировано относительно параметров, захваченных в URL. Поскольку интерполяция ключевых слов всегда выполняется (даже если аргументы не переданы), любые "%" символы в URL должны быть написаны как "%%", чтобы Python преобразовал их в один знак процента при выводе.

Если заданный URL является None, Django вернёт HttpResponseGone (410).

Предки (MRO)

Этот вид наследует методы и атрибуты от следующего вида:

• django.views.generic.base.View

Диаграмма потока методов

1. setup()
2. dispatch()
3. http_method_not_allowed()
4. get_redirect_url()

Пример views.py:

from django.shortcuts import get_object_or_404
from django.views.generic.base import RedirectView

from articles.models import Article


class ArticleCounterRedirectView(RedirectView):
    permanent = False
    query_string = True
    pattern_name = "article-detail"

    def get_redirect_url(self, *args, **kwargs):
        article = get_object_or_404(Article, pk=kwargs["pk"])
        article.update_counter()
        return super().get_redirect_url(*args, **kwargs)

Пример urls.py:

from django.urls import path
from django.views.generic.base import RedirectView

from article.views import ArticleCounterRedirectView, ArticleDetailView

urlpatterns = [
    path(
        "counter/<int:pk>/",
        ArticleCounterRedirectView.as_view(),
        name="article-counter",
    ),
    path("details/<int:pk>/", ArticleDetailView.as_view(), name="article-detail"),
    path(
        "go-to-django/",
        RedirectView.as_view(url="https://www.djangoproject.com/"),
        name="go-to-django",
    ),
]

Атрибуты

url

URL для перенаправления, как строка. Или None для поднятия HTTP ошибки 410 (Gone).

pattern_name

Имя URL шаблона для перенаправления. Обращение будет выполнено с использованием тех же аргументов и ключевых слов, что и для этого вида.

permanent

Является ли перенаправление постоянным. Единственное отличие здесь – код HTTP статуса, возвращаемый. Если True, то перенаправление будет использовать код статуса 301. Если False, то перенаправление будет использовать код статуса 302. По умолчанию permanent равен False.

query_string

Следует ли передавать GET строку запроса в новое местоположение. Если True, то строка запроса добавляется к URL. Если False, то строка запроса отбрасывается. По умолчанию query_string равен False.

Методы

get_redirect_url(*args, **kwargs)

Создаёт целевой URL для перенаправления.

Аргументы args и kwargs являются позиционными и/или ключевыми аргументами захваченными из URL шаблона, соответственно.

Стандартная реализация использует url в качестве начальной строки и выполняет расширение % именованных параметров в этой строке, используя именованные группы, захваченные в URL.

Если url не задан, get_redirect_url() пытается обработать pattern_name используя захваченные в URL данные (используются как именованные, так и неименованные группы).

Если запрошено query_string, оно также добавит строку запроса к сгенерированному URL. Подклассы могут реализовать любое поведение, которое они пожелают, при условии, что метод возвращает готовую к перенаправлению строку URL.