The following three classes provide much of the functionality needed to create\nDjango views. You may think of them as parent views, which can be used by\nthemselves or inherited from. They may not provide all the capabilities\nrequired for projects, in which case there are Mixins and Generic class-based\nviews.
\nMany of Django’s built-in class-based views inherit from other class-based\nviews or various mixins. Because this inheritance chain is very important, the\nancestor classes are documented under the section title of Ancestors (MRO).\nMRO is an acronym for Method Resolution Order.
\nViewLink to this heading#The base view class. All other class-based views inherit from this base\nclass. It isn’t strictly a generic view and thus can also be imported from\ndjango.views.
Method Flowchart
\n\nExample views.py:
\nfrom django.http import HttpResponse\nfrom django.views import View\n\n\nclass MyView(View):\n def get(self, request, *args, **kwargs):\n return HttpResponse("Hello, World!")\nExample urls.py:
\nfrom django.urls import path\n\nfrom myapp.views import MyView\n\nurlpatterns = [\n path("mine/", MyView.as_view(), name="my-view"),\n]\nAttributes
\nThe list of HTTP method names that this view will accept.
\nDefault:
\n["get", "post", "put", "patch", "delete", "head", "options", "trace"]\nMethods
\nReturns a callable view that takes a request and returns a response:
\nresponse = MyView.as_view()(request)\nThe returned view has view_class and view_initkwargs\nattributes.
When the view is called during the request/response cycle, the\nsetup() method assigns the HttpRequest to\nthe view’s request attribute, and any positional and/or keyword\narguments captured from the URL pattern to the args and kwargs\nattributes, respectively. Then dispatch() is called.
If a View subclass defines asynchronous (async def) method\nhandlers, as_view() will mark the returned callable as a coroutine\nfunction. An ImproperlyConfigured exception will be raised if both\nasynchronous (async def) and synchronous (def) handlers are\ndefined on a single view-class.
Performs key view initialization prior to dispatch().
If overriding this method, you must call super().
The view part of the view – the method that accepts a request\nargument plus arguments, and returns an HTTP response.
The default implementation will inspect the HTTP method and attempt to\ndelegate to a method that matches the HTTP method; a GET will be\ndelegated to get(), a POST to post(), and so on.
By default, a HEAD request will be delegated to get().\nIf you need to handle HEAD requests in a different way than GET,\nyou can override the head() method. See\nSupporting other HTTP methods for an example.
If the view was called with an HTTP method it doesn’t support, this\nmethod is called instead.
\nThe default implementation returns HttpResponseNotAllowed with a\nlist of allowed methods in plain text.
Handles responding to requests for the OPTIONS HTTP verb. Returns a\nresponse with the Allow header containing a list of the view’s\nallowed HTTP method names.
If the other HTTP methods handlers on the class are asynchronous\n(async def) then the response will be wrapped in a coroutine\nfunction for use with await.
TemplateViewLink to this heading#Renders a given template, with the context containing parameters captured\nin the URL.
\nAncestors (MRO)
\nThis view inherits methods and attributes from the following views:
\nMethod Flowchart
\n\nExample views.py:
\nfrom django.views.generic.base import TemplateView\n\nfrom articles.models import Article\n\n\nclass HomePageView(TemplateView):\n template_name = "home.html"\n\n def get_context_data(self, **kwargs):\n context = super().get_context_data(**kwargs)\n context["latest_articles"] = Article.objects.all()[:5]\n return context\nExample urls.py:
\nfrom django.urls import path\n\nfrom myapp.views import HomePageView\n\nurlpatterns = [\n path("", HomePageView.as_view(), name="home"),\n]\nContext
\nPopulated (through ContextMixin) with\nthe keyword arguments captured from the URL pattern that served the view.
You can also add context using the\nextra_context keyword\nargument for as_view().
RedirectViewLink to this heading#Redirects to a given URL.
\nThe given URL may contain dictionary-style string formatting, which will be\ninterpolated against the parameters captured in the URL. Because keyword\ninterpolation is always done (even if no arguments are passed in), any\n"%" characters in the URL must be written as "%%" so that Python\nwill convert them to a single percent sign on output.
If the given URL is None, Django will return an HttpResponseGone\n(410).
Ancestors (MRO)
\nThis view inherits methods and attributes from the following view:
\n\nMethod Flowchart
\n\nExample views.py:
\nfrom django.shortcuts import get_object_or_404\nfrom django.views.generic.base import RedirectView\n\nfrom articles.models import Article\n\n\nclass ArticleCounterRedirectView(RedirectView):\n permanent = False\n query_string = True\n pattern_name = "article-detail"\n\n def get_redirect_url(self, *args, **kwargs):\n article = get_object_or_404(Article, pk=kwargs["pk"])\n article.update_counter()\n return super().get_redirect_url(*args, **kwargs)\nExample urls.py:
\nfrom django.urls import path\nfrom django.views.generic.base import RedirectView\n\nfrom article.views import ArticleCounterRedirectView, ArticleDetailView\n\nurlpatterns = [\n path(\n "counter/<int:pk>/",\n ArticleCounterRedirectView.as_view(),\n name="article-counter",\n ),\n path("details/<int:pk>/", ArticleDetailView.as_view(), name="article-detail"),\n path(\n "go-to-django/",\n RedirectView.as_view(url="https://www.djangoproject.com/"),\n name="go-to-django",\n ),\n]\nAttributes
\nThe URL to redirect to, as a string. Or None to raise a 410 (Gone)\nHTTP error.
The name of the URL pattern to redirect to. Reversing will be done\nusing the same args and kwargs as are passed in for this view.
\nWhether the redirect should be permanent. The only difference here is\nthe HTTP status code returned. If True, then the redirect will use\nstatus code 301. If False, then the redirect will use status code\n302. By default, permanent is False.
Whether to pass along the GET query string to the new location. If\nTrue, then the query string is appended to the URL. If False,\nthen the query string is discarded. By default, query_string is\nFalse.
Methods
\nConstructs the target URL for redirection.
\nThe args and kwargs arguments are positional and/or keyword\narguments captured from the URL pattern, respectively.
The default implementation uses url as a starting\nstring and performs expansion of % named parameters in that string\nusing the named groups captured in the URL.
If url is not set, get_redirect_url() tries to reverse the\npattern_name using what was captured in the URL (both named and\nunnamed groups are used).
If requested by query_string, it will also append the query\nstring to the generated URL.\nSubclasses may implement any behavior they wish, as long as the method\nreturns a redirect-ready URL string.