Функции-костыли 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. Передав некоторый объект; для определения 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)

get_object_or_404()

get_object_or_404(klass, *args, **kwargs)

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

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

klass

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

**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, из которого получить список.

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