Вспомогательные функции Django

Обязательные аргументы

request

Объект запроса, используемый для формирования этого ответа.

template_name

Полное имя используемого шаблона или последовательность имён шаблонов. Если указана последовательность, будет использован первый существующий шаблон. Подробнее о том, как находятся шаблоны, см. в документации по загрузке шаблонов.

Необязательные аргументы

context

Словарь значений, добавляемых в контекст шаблона. По умолчанию это пустой словарь. Если значение в словаре является вызываемым объектом, представление вызовет его непосредственно перед рендерингом шаблона.

content_type

Тип MIME для результирующего документа. По умолчанию — 'text/html'.

status

Код состояния ответа. По умолчанию — 200.

using

NAME используемого движка шаблонов для загрузки шаблона.

Пример

В следующем примере шаблон 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")

Примеры

Функцию redirect() можно использовать несколькими способами.

1. Передать объект; для определения URL перенаправления будет вызван метод объекта get_absolute_url():

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

2. Передать имя представления и, при необходимости, позиционные или именованные аргументы; URL будет разрешён обратным поиском с помощью метода reverse():

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

3. Передать жёстко заданный URL для перенаправления:

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

   Это также работает с полными URL:

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

Аргументы

klass

Класс Model, Manager или экземпляр QuerySet, из которого нужно получить объект.

*args

Q objects.

**kwargs

Параметры поиска, формат которых должен соответствовать формату, принимаемому get() и filter().

Пример

В следующем примере из 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")

Можно также использовать related managers:

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

Примечание: как и в случае с get(), если найдено более одного объекта, будет вызвано исключение MultipleObjectsReturned.

Аргументы

klass

Экземпляр Model, Manager или QuerySet, из которого нужно получить список.

*args

Q objects.

**kwargs

Параметры поиска, формат которых должен соответствовать формату, принимаемому get() и filter().

Пример

В следующем примере из 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.")