The package django.shortcuts collects helper functions and classes that\n„span” multiple levels of MVC. In other words, these functions/classes\nintroduce controlled coupling for convenience’s sake.
render()Link to this heading#Łączy podany szablon z podanym słownikiem kontekstu i zwraca obiekt HttpResponse z tym wyrenderowanym tekstem.
Django does not provide a shortcut function which returns a\nTemplateResponse because the constructor\nof TemplateResponse offers the same level\nof convenience as render().
requestObiekt żądania użyty do wygenerowania tej odpowiedzi
\ntemplate_nameThe full name of a template to use or sequence of template names. If a\nsequence is given, the first template that exists will be used. See the\ntemplate loading documentation for more\ninformation on how templates are found.
\ncontextA dictionary of values to add to the template context. By default, this\nis an empty dictionary. If a value in the dictionary is callable, the\nview will call it just before rendering the template.
\ncontent_typeThe MIME type to use for the resulting document. Defaults to\n'text/html'.
statusThe status code for the response. Defaults to 200.
usingThe NAME of a template engine to use for\nloading the template.
The following example renders the template myapp/index.html with the\nMIME type 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 )\nThis example is equivalent to:
\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#Returns an HttpResponseRedirect to the appropriate URL\nfor the arguments passed.
The arguments could be:
\nA model: the model’s get_absolute_url()\nfunction will be called.
A view name, possibly with arguments: reverse() will be\nused to reverse-resolve the name.
An absolute or relative URL, which will be used as-is for the redirect\nlocation.
By default, a temporary redirect is issued with a 302 status code. If\npermanent=True, a permanent redirect is issued with a 301 status code.
If preserve_request=True, the response instructs the user agent to\npreserve the method and body of the original request when issuing the\nredirect. In this case, temporary redirects use a 307 status code, and\npermanent redirects use a 308 status code. This is better illustrated in the\nfollowing table:
permanent | \npreserve_request | \nHTTP status code | \n
|---|---|---|
| \n
| \n301 | \n
| \n
| \n302 | \n
| \n
| \n307 | \n
| \n
| \n308 | \n
You can use the redirect() function in a number of ways.
By passing some object; that object’s\nget_absolute_url() method will be called\nto figure out the redirect URL:
from django.shortcuts import redirect\n\n\ndef my_view(request):\n ...\n obj = MyModel.objects.get(...)\n return redirect(obj)\nBy passing the name of a view and optionally some positional or\nkeyword arguments; the URL will be reverse resolved using the\nreverse() method:
def my_view(request):\n ...\n return redirect("some-view-name", foo="bar")\nBy passing a hardcoded URL to redirect to:
\ndef my_view(request):\n ...\n return redirect("/some/url/")\nThis also works with full URLs:
\ndef my_view(request):\n ...\n return redirect("https://example.com/")\nBy default, redirect() returns a temporary redirect. All of the above\nforms accept a permanent argument; if set to True a permanent redirect\nwill be returned:
def my_view(request):\n ...\n obj = MyModel.objects.get(...)\n return redirect(obj, permanent=True)\nAdditionally, the preserve_request argument can be used to preserve the\noriginal HTTP method:
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#Asynchronous version: aget_object_or_404()
Calls get() on a given model\nmanager, but it raises Http404 instead of the model’s\nDoesNotExist exception.
The following example gets the object with the primary key of 1 from\nMyModel:
from django.shortcuts import get_object_or_404\n\n\ndef my_view(request):\n obj = get_object_or_404(MyModel, pk=1)\nThis example is equivalent to:
\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.")\nThe most common use case is to pass a Model, as\nshown above. However, you can also pass a\nQuerySet instance:
queryset = Book.objects.filter(title__startswith="M")\nget_object_or_404(queryset, pk=1)\nThe above example is a bit contrived since it’s equivalent to doing:
\nget_object_or_404(Book, title__startswith="M", pk=1)\nbut it can be useful if you are passed the queryset variable from somewhere\nelse.
Finally, you can also use a Manager. This is useful\nfor example if you have a\ncustom manager:
get_object_or_404(Book.dahl_objects, title="Matilda")\nYou can also use\nrelated managers:
author = Author.objects.get(name="Roald Dahl")\nget_object_or_404(author.book_set, title="Matilda")\nNote: As with get(), a\nMultipleObjectsReturned exception\nwill be raised if more than one object is found.
get_list_or_404()Link to this heading#Asynchronous version: 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.
The following example gets all published objects from 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)\nThis example is equivalent to:
\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