Функции-короткого пути Django

Пакет django.shortcuts собирает вспомогательные функции и классы, которые «охватывают» несколько уровней MVC. Другими словами, эти функции/классы вводят контролируемую связность для удобства.

render()

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

Объединяет заданный шаблон с заданным словарем контекста и возвращает объект HttpResponse с этим отрендеренным текстом.

Django не предоставляет функцию-короткого пути, которая возвращает TemplateResponse, потому что конструктор TemplateResponse предлагает такой же уровень удобства, как и render().

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

request

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

template_name

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

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

context

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

content_type

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

status

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

using

Идентификатор движка шаблонов для загрузки шаблона.

Пример

Следующий пример рендерит шаблон 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()

redirect(to, *args, permanent=False, **kwargs)

Возвращает HttpResponseRedirect на соответствующий URL для переданных аргументов.

Аргументы могут быть:

• Модель: будет вызвано свойство get_absolute_url() модели.
• Имя представления, возможно с аргументами: будет использовано reverse() для обратного преобразования имени.
• Абсолютный или относительный URL, который будет использован как есть для места перенаправления.

По умолчанию выполняется временное перенаправление; передайте permanent=True для выполнения постоянного перенаправления.

Примеры

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

1. Передав некоторый объект; будет вызван метод get_absolute_url() этого объекта для определения 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)

get_object_or_404()

get_object_or_404(klass, *args, **kwargs)

Вызывает get() для заданного менеджера модели, но вместо исключения DoesNotExist модели поднимает Http404.

Аргументы

klass

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

*args

Q objects.

**kwargs

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

Пример

Следующий пример получает объект с первичным ключом 1 из MyModel:

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 будет поднято, если найдено более одного объекта.

get_list_or_404()

get_list_or_404(klass, *args, **kwargs)

Возвращает результат filter() для заданного менеджера модели, преобразованного в список, поднимая Http404, если результирующий список пуст.

Аргументы

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