Функции-короткоходы 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

Имя движка шаблонов для загрузки шаблона. 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')

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, *args, permanent=False, **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):
       ...
       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) [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):
    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) [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.")