Django のショートカット関数Link to this heading#

必須の引数Link to this heading#

request

このレスポンスを生成するのに使用されるリクエスト オブジェクト。

template_name

使用するテンプレートの完全な名前、または、テンプレート名のシーケンス。シーケンスが指定された場合、最初に存在するテンプレートが使用されます。テンプレートの検索方法については、テンプレートの読み込みドキュメント を参照してください。

オプションの引数Link to this heading#

context

テンプレートコンテキストに追加する値の辞書です。デフォルトでは空の辞書です。辞書内の値が呼び出し可能な場合、ビューはテンプレートをレンダリングする直前にそれを呼び出します。

content_type

結果のドキュメントに適用するMIMEタイプ。デフォルトは 'text/html' です。

status

レスポンスのステータスコード。デフォルトは 200 です。

using

テンプレートを読み込むために使用するテンプレートエンジンの NAME を指定します。

カスタマイズ例Link to this heading#

次の例では、テンプレート myapp/index.html をMIMEタイプ application/xhtml+xml でレンダリングしてみます。

from django.shortcuts import render


def my_view(request):
    # View code here...
    return render(
        request,
        "myapp/index.html",
        {
            "foo": "bar",
        },
        content_type="application/xhtml+xml",
    )

この例は次のコードと等価です。

from django.http import HttpResponse
from django.template import loader


def my_view(request):
    # View code here...
    t = loader.get_template("myapp/index.html")
    c = {"foo": "bar"}
    return HttpResponse(t.render(c, request), content_type="application/xhtml+xml")

例Link to this heading#

redirect() 関数の使い方はいくつかあります。

1. オブジェクトを渡すことで、そのオブジェクトの get_absolute_url() メソッドが呼び出され、リダイレクト URL を返します:

   Code

   from django.shortcuts import redirect
   
   
   def my_view(request):
       ...
       obj = MyModel.objects.get(...)
       return redirect(obj)
   

2. ビューの名前と、オプションで位置引数またはキーワード引数を渡すことで、 reverse() メソッドを使って URL を逆引きできます:

   Code

   def my_view(request):
       ...
       return redirect("some-view-name", foo="bar")
   

3. リダイレクト先としてハードコーディングされたURLを渡せます:

   Code

   def my_view(request):
       ...
       return redirect("/some/url/")
   

   これは完全なURLでも機能します:

   Code

   def my_view(request):
       ...
       return redirect("https://example.com/")
   

デフォルトでは redirect() は一時的なリダイレクトを返します。上記のすべての形式で permanent 引数が使えます。 True に設定された場合、恒久的なリダイレクトを返します:

def my_view(request):
    ...
    obj = MyModel.objects.get(...)
    return redirect(obj, permanent=True)

さらに、 preserve_request 引数を使えば、元の HTTP メソッドを保持できます：

def my_view(request):
    # ...
    obj = MyModel.objects.get(...)
    if request.method in ("POST", "PUT"):
        # Redirection preserves the original request method.
        return redirect(obj, preserve_request=True)
    # ...

例Link to this heading#

1. Resolving a URL for a model that defines get_absolute_url():

   Python

   from django.db import models
   from django.urls import reverse
   
   
   class Article(models.Model):
       title = models.CharField(max_length=100)
   
       def get_absolute_url(self):
           return reverse("article-detail", args=[self.pk])
   

   Python

   from django.http import JsonResponse
   from django.shortcuts import get_object_or_404, resolve_url
   from .models import Article
   
   
   def article_api_view(request, pk):
       """Return metadata about an article, including its canonical URL."""
       article = get_object_or_404(Article, pk=pk)
       return JsonResponse(
           {
               "id": article.pk,
               "title": article.title,
               "url": resolve_url(article),
           }
       )
   

2. Resolving a target URL for use outside of a redirect, such as in an HTTP response header:

   Code

   from django.conf import settings
   from django.http import HttpResponse
   from django.shortcuts import resolve_url
   
   
   def login_success(request):
       response = HttpResponse("Login successful")
       response["X-Next-URL"] = resolve_url(settings.LOGIN_REDIRECT_URL)
       return response
   

引数Link to this heading#

klass

オブジェクトを取得するための Model クラス、 Manager または QuerySet インスタンスです。

*args

Q() オブジェクト.

**kwargs

ルックアップパラメータ。 get() および filter() が受入可能なフォーマットにします。

カスタマイズ例Link to this heading#

以下の例では MyModel から主キーが 1 のオブジェクトを取得しています:

from django.shortcuts import get_object_or_404


def my_view(request):
    obj = get_object_or_404(MyModel, pk=1)

この例は次のコードと等価です。

from django.http import Http404


def my_view(request):
    try:
        obj = MyModel.objects.get(pk=1)
    except MyModel.DoesNotExist:
        raise Http404("No MyModel matches the given query.")

最もよくある使用例は、上記のように Model を渡すものです。しかし、 QuerySet インスタンスを渡すこともできます:

queryset = Book.objects.filter(title__startswith="M")
get_object_or_404(queryset, pk=1)

上の例は下記と等価なので、少し不自然ではあります:

get_object_or_404(Book, title__startswith="M", pk=1)

しかし、他の場所から QuerySet 変数を渡された場合には便利です。

最後に、 Manager を使うこともできます。これは例えば カスタムマネージャ がある場合に便利です:

get_object_or_404(Book.dahl_objects, title="Matilda")

関係マネージャ を使うこともできます:

author = Author.objects.get(name="Roald Dahl")
get_object_or_404(author.book_set, title="Matilda")

注意: get() と同様に、複数のオブジェクトが見つかった場合は MultipleObjectsReturned 例外が発生します。

引数Link to this heading#

klass

リストを取得するための Model, Manager または QuerySet インスタンスです。

*args

Q() オブジェクト.

**kwargs

ルックアップパラメータ。 get() および filter() が受入可能なフォーマットにします。

カスタマイズ例Link to this heading#

以下の例では MyModel から全ての公開されたオブジェクトを取得しています:

from django.shortcuts import get_list_or_404


def my_view(request):
    my_objects = get_list_or_404(MyModel, published=True)

この例は次のコードと等価です。

from django.http import Http404


def my_view(request):
    my_objects = list(MyModel.objects.filter(published=True))
    if not my_objects:
        raise Http404("No MyModel matches the given query.")