Django shortcut functions

Django shortcut functions

The package django.shortcuts collects helper functions and classes that “span” multiple levels of MVC. In other words, these functions/classes introduce controlled coupling for convenience’s sake.

`render()`

render(request , template_name , context=None , content_type=None , status=None , using=None)[source]

Combines a given template with a given context dictionary and returns an HttpResponse object with that rendered text.

Django does not provide a shortcut function which returns a TemplateResponse because the constructor of TemplateResponse offers the same level of convenience as render().

Required arguments

request

The request object used to generate this response.

template_name

The full name of a template to use or sequence of template names. If a sequence is given, the first template that exists will be used. See the template loading documentation for more information on how templates are found.

Optional arguments

context

A dictionary of values to add to the template context. By default, this is an empty dictionary. If a value in the dictionary is callable, the view will call it just before rendering the template.

content_type

The MIME type to use for the resulting document. Defaults to 'text/html'.

status

The status code for the response. Defaults to 200.

using

The NAME of a template engine to use for loading the template.

Example

The following example renders the template myapp/index.html with the MIME type 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",
    )

This example is equivalent to:

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")

`redirect()`

redirect(to , args_ , permanent=False , _*kwargs)[source]

Returns an HttpResponseRedirect to the appropriate URL for the arguments passed.

The arguments could be:

A model: the model’s get_absolute_url() function will be called.
A view name, possibly with arguments: reverse() will be used to reverse-resolve the name.
An absolute or relative URL, which will be used as-is for the redirect location.

By default issues a temporary redirect; pass permanent=True to issue a permanent redirect.

Examples

You can use the redirect() function in a number of ways.

By passing some object; that object’s get_absolute_url() method will be called to figure out the redirect URL:

``` from django.shortcuts import redirect

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

  1. By passing the name of a view and optionally some positional or keyword arguments; the URL will be reverse resolved using the [reverse()](&lt;/read/django-5.1-en/cc3e7d0de86d8ebf.md#django.urls.reverse> "django.urls.reverse") method:

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

  2. By passing a hardcoded URL to redirect to:

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


This also works with full URLs:

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


By default, redirect() returns a temporary redirect. All of the above forms accept a `permanent` argument; if set to `True` a permanent redirect will be returned:

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


## `get_object_or_404()`

`get_object_or_404`(_klass_ , _*args_ , _**kwargs_)[[source]](&lt;https://github.com/django/django/blob/stable/5.1.x/django/shortcuts.py#L65>)

`aget_object_or_404`(_klass_ , _*args_ , _**kwargs_)

_Asynchronous version_ : `aget_object_or_404()`

Calls [get()](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.query.QuerySet.get> "django.db.models.query.QuerySet.get") on a given model manager, but it raises [Http404](&lt;/read/django-5.1-en/eadebef62307f22f.md#django.http.Http404> "django.http.Http404") instead of the model’s [DoesNotExist](&lt;/read/django-5.1-en/f80b1e33472b9cad.md#django.db.models.Model.DoesNotExist> "django.db.models.Model.DoesNotExist") exception.

### Arguments

`klass`

A [Model](&lt;/read/django-5.1-en/0dbcf57b70d3d305.md#django.db.models.Model> "django.db.models.Model") class, a [Manager](&lt;/read/django-5.1-en/a721a5fa75d2bc9c.md#django.db.models.Manager> "django.db.models.Manager"), or a [QuerySet](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.query.QuerySet> "django.db.models.query.QuerySet") instance from which to get the object.

`*args`

[Q objects](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.Q> "django.db.models.Q").

`**kwargs`

Lookup parameters, which should be in the format accepted by `get()` and `filter()`.

### Example

The following example gets the object with the primary key of 1 from `MyModel`:

from django.shortcuts import get_object_or_404

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


This example is equivalent to:

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.")


The most common use case is to pass a [Model](&lt;/read/django-5.1-en/0dbcf57b70d3d305.md#django.db.models.Model> "django.db.models.Model"), as shown above. However, you can also pass a [QuerySet](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.query.QuerySet> "django.db.models.query.QuerySet") instance:

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


The above example is a bit contrived since it’s equivalent to doing:

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


but it can be useful if you are passed the `queryset` variable from somewhere else.

Finally, you can also use a [Manager](&lt;/read/django-5.1-en/a721a5fa75d2bc9c.md#django.db.models.Manager> "django.db.models.Manager"). This is useful for example if you have a [custom manager](/read/django-5.1-en/d022.md#custom-managers):

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


You can also use [related managers](&lt;/read/django-5.1-en/46e6f316ae065130.md#django.db.models.fields.related.RelatedManager> "django.db.models.fields.related.RelatedManager"):

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


Note: As with `get()`, a [MultipleObjectsReturned](&lt;/read/django-5.1-en/59e0bddaf362255a.md#django.core.exceptions.MultipleObjectsReturned> "django.core.exceptions.MultipleObjectsReturned") exception will be raised if more than one object is found.

Changed in Django 5.0:

`aget_object_or_404()` function was added.

## `get_list_or_404()`

`get_list_or_404`(_klass_ , _*args_ , _**kwargs_)[[source]](&lt;https://github.com/django/django/blob/stable/5.1.x/django/shortcuts.py#L110>)

`aget_list_or_404`(_klass_ , _*args_ , _**kwargs_)

_Asynchronous version_ : `aget_list_or_404()`

Returns the result of [filter()](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.query.QuerySet.filter> "django.db.models.query.QuerySet.filter") on a given model manager cast to a list, raising [Http404](&lt;/read/django-5.1-en/eadebef62307f22f.md#django.http.Http404> "django.http.Http404") if the resulting list is empty.

### Arguments

`klass`

A [Model](&lt;/read/django-5.1-en/0dbcf57b70d3d305.md#django.db.models.Model> "django.db.models.Model"), [Manager](&lt;/read/django-5.1-en/a721a5fa75d2bc9c.md#django.db.models.Manager> "django.db.models.Manager") or [QuerySet](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.query.QuerySet> "django.db.models.query.QuerySet") instance from which to get the list.

`*args`

[Q objects](&lt;/read/django-5.1-en/0acd4a01f39171a7.md#django.db.models.Q> "django.db.models.Q").

`**kwargs`

Lookup parameters, which should be in the format accepted by `get()` and `filter()`.

### Example

The following example gets all published objects from `MyModel`:

from django.shortcuts import get_list_or_404

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


This example is equivalent to:

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.") ```

Changed in Django 5.0:

aget_list_or_404() function was added.