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

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

render()

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

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

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

Необходимые аргументы

request

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

template_name

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

Дополнительные аргументы

context

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

content_type

Тип MIME для используемого документа. По умолчанию принимает значение параметра DEFAULT_CONTENT_TYPE.

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

render_to_response()

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

Устарело начиная с версии 2.0.

Эта функция предшествовала введению render() и работает аналогично, за исключением того, что она не делает request доступным в ответе.

redirect()

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

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

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

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

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

Примеры

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

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

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

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):
    ...
    object = MyModel.objects.get(...)
    return redirect(object, permanent=True)

get_object_or_404()

get_object_or_404(klass, *args, **kwargs) [source]

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

Необходимые аргументы

klass

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

**kwargs

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

Пример

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

from django.shortcuts import get_object_or_404

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

Этот пример эквивалентен:

from django.http import Http404

def my_view(request):
    try:
        my_object = 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) [source]

Возвращает результат применения 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.")