Короткодействующие функции Django

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

render()

render(request, template_name, context=None, context_instance=_context_instance_undefined, content_type=None, status=None, current_app=_current_app_undefined, dirs=_dirs_undefined, using=None) [source]

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

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

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

request

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

template_name

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

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

context

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

Аргумент context раньше назывался dictionary. Это имя устарело в Django 1.8 и будет удалено в Django 1.10.

context_instance

Экземпляр контекста для рендеринга шаблона. По умолчанию шаблон будет рендериться с экземпляром RequestContext (заполненным значениями из request и context).

Устарело начиная с версии 1.8: Аргумент context_instance устарел. Используйте просто context.

content_type

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

status

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

current_app

Подсказка, указывающая, какая приложение содержит текущее представление. Дополнительная информация содержится в стратегии разрешения именных URL.

Устарело начиная с версии 1.8: Аргумент current_app устарел. Вместо этого необходимо установить request.current_app.

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, context_instance=_context_instance_undefined, content_type=None, status=None, dirs=_dirs_undefined, using=None) [source]

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

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

template_name

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

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

context

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

Аргумент context раньше назывался dictionary. Это имя устарело в Django 1.8 и будет удалено в Django 1.10.

context_instance

Экземпляр контекста для рендеринга шаблона. По умолчанию шаблон будет рендериться с экземпляром Context (заполненным значениями из context). Если нужно использовать обработчики контекста, рендерите шаблон с экземпляром RequestContext вместо него. Ваш код может выглядеть примерно так:

return render_to_response('my_template.html',
                          my_context,
                          context_instance=RequestContext(request))

Устарело начиная с версии 1.8: Аргумент context_instance устарел. Используйте функцию render(), которая всегда делает RequestContext доступным.

content_type

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

status

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

using

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

redirect()

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

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

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

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

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

Примеры

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

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