django.shortcuts パッケージは、MVC の複数のレベルにまたがるヘルパー関数とクラスを集めたものです。言い換えれば、これらの関数やクラスは、便宜上、控えめな結合を取り入れます。
render()Link to this heading#与えられたテンプレートとコンテキスト辞書を組み合わせてレンダリングされたテキストを持つ、 HttpResponse オブジェクトを返します。
Django does not provide a shortcut function which returns a\nTemplateResponse because the constructor\nof TemplateResponse offers the same level\nof convenience as render().
requestこのレスポンスを生成するのに使用されるリクエスト オブジェクト。
\ntemplate_name使用するテンプレートの完全な名前、または、テンプレート名のシーケンス。シーケンスが指定された場合、最初に存在するテンプレートが使用されます。テンプレートの検索方法については、テンプレートの読み込みドキュメント を参照してください。
\ncontextテンプレートコンテキストに追加する値の辞書です。デフォルトでは空の辞書です。辞書内の値が呼び出し可能な場合、ビューはテンプレートをレンダリングする直前にそれを呼び出します。
\ncontent_type結果のドキュメントに適用するMIMEタイプ。デフォルトは 'text/html' です。
statusレスポンスのステータスコード。デフォルトは 200 です。
usingテンプレートを読み込むために使用するテンプレートエンジンの NAME を指定します。
次の例では、テンプレート myapp/index.html をMIMEタイプ application/xhtml+xml でレンダリングしてみます。
from django.shortcuts import render\n\n\ndef my_view(request):\n # View code here...\n return render(\n request,\n "myapp/index.html",\n {\n "foo": "bar",\n },\n content_type="application/xhtml+xml",\n )\nこの例は次のコードと等価です。
\nfrom django.http import HttpResponse\nfrom django.template import loader\n\n\ndef my_view(request):\n # View code here...\n t = loader.get_template("myapp/index.html")\n c = {"foo": "bar"}\n return HttpResponse(t.render(c, request), content_type="application/xhtml+xml")\nredirect()Link to this heading#渡された引数に対して、 適切な URLへの HttpResponseRedirect を返します。
引数には以下が含まれます:
\nA model: the model's get_absolute_url()\nfunction will be called.
ビュー名（引数を渡せます）: reverse() を使って名前を逆解決します。
絶対URLまたは相対URL。これはそのままリダイレクト先になります。
デフォルトではステータスコード 302 の一時リダイレクトが発行されます。 permanent=True を指定すると、ステータスコード 301 の恒久リダイレクトが発行されます。
preserve_request=True を指定すると、レスポンスはリダイレクト時に元のリクエストのメソッドやボディを保持するようユーザーエージェントに指示します。この場合、一時リダイレクトにはステータスコード 307 が、恒久リダイレクトにはステータスコード 308 が使用されます。次の表のほうがわかりやすいでしょう：
permanent | \npreserve_request | \nHTTP ステータスコード | \n
|---|---|---|
| \n
| \n301 | \n
| \n
| \n302 | \n
| \n
| \n307 | \n
| \n
| \n308 | \n
An optional max_length keyword argument can be provided to override\nthe maximum allowed length for the redirect URL. Set it to None to\ndisable the length check.
redirect() 関数の使い方はいくつかあります。
オブジェクトを渡すことで、そのオブジェクトの get_absolute_url() メソッドが呼び出され、リダイレクト URL を返します:
from django.shortcuts import redirect\n\n\ndef my_view(request):\n ...\n obj = MyModel.objects.get(...)\n return redirect(obj)\nビューの名前と、オプションで位置引数またはキーワード引数を渡すことで、 reverse() メソッドを使って URL を逆引きできます:
def my_view(request):\n ...\n return redirect("some-view-name", foo="bar")\nリダイレクト先としてハードコーディングされたURLを渡せます:
\ndef my_view(request):\n ...\n return redirect("/some/url/")\nこれは完全なURLでも機能します:
\ndef my_view(request):\n ...\n return redirect("https://example.com/")\nデフォルトでは redirect() は一時的なリダイレクトを返します。上記のすべての形式で permanent 引数が使えます。 True に設定された場合、恒久的なリダイレクトを返します:
def my_view(request):\n ...\n obj = MyModel.objects.get(...)\n return redirect(obj, permanent=True)\nさらに、 preserve_request 引数を使えば、元の HTTP メソッドを保持できます：
def my_view(request):\n # ...\n obj = MyModel.objects.get(...)\n if request.method in ("POST", "PUT"):\n # Redirection preserves the original request method.\n return redirect(obj, preserve_request=True)\n # ...\nresolve_url()Link to this heading#Returns a URL string by resolving and normalizing the given to argument\ninto a concrete URL. The parameter to may be:
An object implementing get_absolute_url(),\nin which case the method will be called and its result returned.
A view name, view function, or view class, possibly with arguments passed\nas *args and **kwargs, in which case reverse()\nwill be used to reverse-resolve the view.
A URL string, which will be returned unchanged.
This function is used internally by the redirect() shortcut to\ndetermine the target URL for the redirect location.
Resolving a URL for a model that defines\nget_absolute_url():
models.pyfrom django.db import models\nfrom django.urls import reverse\n\n\nclass Article(models.Model):\n title = models.CharField(max_length=100)\n\n def get_absolute_url(self):\n return reverse("article-detail", args=[self.pk])\nviews.pyfrom django.http import JsonResponse\nfrom django.shortcuts import get_object_or_404, resolve_url\nfrom .models import Article\n\n\ndef article_api_view(request, pk):\n """Return metadata about an article, including its canonical URL."""\n article = get_object_or_404(Article, pk=pk)\n return JsonResponse(\n {\n "id": article.pk,\n "title": article.title,\n "url": resolve_url(article),\n }\n )\nResolving a target URL for use outside of a redirect, such as in an HTTP\nresponse header:
\nfrom django.conf import settings\nfrom django.http import HttpResponse\nfrom django.shortcuts import resolve_url\n\n\ndef login_success(request):\n response = HttpResponse("Login successful")\n response["X-Next-URL"] = resolve_url(settings.LOGIN_REDIRECT_URL)\n return response\nget_object_or_404()Link to this heading#非同期バージョン: aget_object_or_404()
Calls get() on a given model\nmanager, but it raises Http404 instead of the model's\nDoesNotExist exception.
klass*args**kwargsルックアップパラメータ。 get() および filter() が受入可能なフォーマットにします。
以下の例では MyModel から主キーが 1 のオブジェクトを取得しています:
from django.shortcuts import get_object_or_404\n\n\ndef my_view(request):\n obj = get_object_or_404(MyModel, pk=1)\nこの例は次のコードと等価です。
\nfrom django.http import Http404\n\n\ndef my_view(request):\n try:\n obj = MyModel.objects.get(pk=1)\n except MyModel.DoesNotExist:\n raise Http404("No MyModel matches the given query.")\n最もよくある使用例は、上記のように Model を渡すものです。しかし、 QuerySet インスタンスを渡すこともできます:
queryset = Book.objects.filter(title__startswith="M")\nget_object_or_404(queryset, pk=1)\n上の例は下記と等価なので、少し不自然ではあります:
\nget_object_or_404(Book, title__startswith="M", pk=1)\nしかし、他の場所から QuerySet 変数を渡された場合には便利です。
最後に、 Manager を使うこともできます。これは例えば カスタムマネージャ がある場合に便利です:
get_object_or_404(Book.dahl_objects, title="Matilda")\n関係マネージャ を使うこともできます:
author = Author.objects.get(name="Roald Dahl")\nget_object_or_404(author.book_set, title="Matilda")\n注意: get() と同様に、複数のオブジェクトが見つかった場合は MultipleObjectsReturned 例外が発生します。
get_list_or_404()Link to this heading#非同期バージョン: aget_list_or_404()
Returns the result of filter() on\na given model manager cast to a list, raising Http404\nif the resulting list is empty.
klass*args**kwargsルックアップパラメータ。 get() および filter() が受入可能なフォーマットにします。
以下の例では MyModel から全ての公開されたオブジェクトを取得しています:
from django.shortcuts import get_list_or_404\n\n\ndef my_view(request):\n my_objects = get_list_or_404(MyModel, published=True)\nこの例は次のコードと等価です。
\nfrom django.http import Http404\n\n\ndef my_view(request):\n my_objects = list(MyModel.objects.filter(published=True))\n if not my_objects:\n raise Http404("No MyModel matches the given query.")\n