以下の3つのクラスは、Django のビューの作成に必要な多くの機能を提供します。これらは Django ビューの 親の ビューと見なすことができ、それ自体で使うことも継承して使うこともできます。プロジェクトに必要な全ての機能を提供するわけではありませんが、その場合は Mixins と汎用クラスベースビューが使えます。
\n多くの Django のビルトインのクラスベースビューは、ほかのクラスベースビューや多種の mixin を継承しています。この継承チェーンは非常に重要なため、原型のクラスは 継承元 (MRO) セクションにドキュメントがあります。MRO は メソッド解決順序 (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.
メソッドのフローチャート
\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]\n属性
\nこのビューが受け入れる HTTP メソッドの名称のリストです。
\nデフォルト値:
\n["get", "post", "put", "patch", "delete", "head", "options", "trace"]\nメソッド
\nリクエストを受け取ってレスポンスを返す、呼び出し可能なビューを返します:
\nresponse = MyView.as_view()(request)\n返されたビューは、view_class と view_initkwargs 属性を持っています。
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.
デフォルトの処理は、HTTP メソッドを調べて、その HTTP メソッドと一致するメソッドに処理を委ねるよう試みます; 例えば、GET は get() に、POST は post() に委ねられます。
デフォルトでは、HEAD リクエストは get() に委ねられます。HEAD リクエストを GET とは違う方法で操作する必要がある場合は、head() メソッドをオーバーライドすることができます。例えば その他の HTTP メソッドをサポートする をご覧ください。
If the view was called with an HTTP method it doesn't support, this\nmethod is called instead.
\nプレーンテキストで、有効なメソッドのリストともに、HttpResponseNotAllowed を返すデフォルトの処理です。
OPTIONS HTTP 動詞のためのリクエストへのレスポンスを操作します。ビューの有効な HTTP メソッド名のリストを含む Allow ヘッダーとともにレスポンスを返します。
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#URL 内でキャプチャされたパラメータを含むコンテキストとともに、与えられたテンプレートをレンダリングします。
\n継承元 (MRO)
\nこのメソッドは、以下のビューからメソッドと属性を継承しています:
\nメソッドのフローチャート
\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]\nコンテキスト
\n(ContextMixin を通じて) ビューに対応した URL パターンからキャプチャされたキーワード引数とともに入力されます。
You can also add context using the\nextra_context keyword\nargument for as_view().
RedirectViewLink to this heading#与えられた URL にリダイレクトします。
\n与えられた URL は、辞書形式の文字列フォーマットを含むかもしれず、URL 内でキャプチャされたパラメータに対して追加されます。キーワード追加は (たとえ引数が渡されなくとも) 常に 行われるため、Python がアウトプット上でパーセント文字に変換できるように、URL 内のすべての "%" 文字は "%%" と書かれなければなりません。
与えられた URL が None の場合、Djangoは HttpResponseGone (410) を返します。
継承元 (MRO)
\nこのビューは、以下のビューからメソッドと属性を継承します:
\n\nメソッドのフローチャート
\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]\n属性
\nリダイレクト先の URL です。もしくは、410 (Gone) HTTP エラーを投げる None です。
リダイレクト先の URL パターンの名前です。このビューのために渡されてきたものと同じ args と kwargs を使ってリバースされます。
\nリダイレクトがパーマネントかどうかを指定します。ここでの違いは、返される HTTP ステータスコードだけです。True の場合、リダイレクトはステータスコード 301 を使います。False の場合は、ステータスコード 302 を使います。デフォルトでは、permanent は False です。
GET クエリ文字列を新しい場所に渡すかどうかを指定します。True の場合、クエリ文字列は URL に追加されます。False の場合、クエリ文字列は破棄されます。 デフォルトでは、query_string は False です。
メソッド
\nリダイレクトのために、対象の URL を組み立てます。
\nThe args and kwargs arguments are positional and/or keyword\narguments captured from the URL pattern, respectively.
デフォルトの処理は、url を最初の文字列として使い、URLでキャプチャされた名前付きグループを使用したその文字列内の名前付き % パラメータの展開を実行します。
url がセットされていない場合、get_redirect_url() が URLでキャプチャされたものを使って pattern_name をリバースしようとします (名前あり・名前なしグループの両方が使われます)。
query_string によってリクエストされた場合、生成された URL にクエリ文字列を追加します。サブクラスは、メソッドがリダイレクト準備ができた URL 文字列を返す限り、これらが望むとおりの処理をします。