Создание представлений

Функция представления, или представление вкратце, — это просто функция Python, которая принимает веб-запрос и возвращает веб-ответ. Этот ответ может быть HTML-содержимым веб-страницы, перенаправлением, ошибкой 404, XML-документом, изображением... или чем угодно. Само представление содержит необходимую произвольную логику для возврата этого ответа. Этот код может находиться в любом месте, если он находится на вашем пути Python. Других требований нет — нет никакой «магии», так сказать. Для того, чтобы поместить код куда-то, принято помещать представления в файл под названием views.py, размещенный в каталоге вашего проекта или приложения.

Простое представление

Вот представление, возвращающее текущую дату и время в виде HTML-документа:

from django.http import HttpResponse
import datetime

def current_datetime(request):
    now = datetime.datetime.now()
    html = "<html><body>It is now %s.</body></html>" % now
    return HttpResponse(html)

Давайте пройдемся по этому коду строка за строкой:

Во-первых, мы импортируем класс HttpResponse из модуля django.http, а также библиотеку Python datetime.
Далее, мы определяем функцию под названием current_datetime. Это функция представления. Каждая функция представления принимает объект HttpRequest в качестве своего первого параметра, который обычно называется request.

Обратите внимание, что имя функции представления не имеет значения; Django не требует определённого имени для её распознавания. Мы назвали её current_datetime здесь, потому что это имя ясно указывает на её назначение.
Представление возвращает объект HttpResponse, содержащий сгенерированный ответ. Каждая функция представления отвечает за возврат объекта HttpResponse. (Есть исключения, но мы рассмотрим их позже.)

Временная зона Django

Django включает настройку TIME_ZONE, которая по умолчанию равна America/Chicago. Вероятно, это не ваша часовая зона, поэтому вам, возможно, потребуется изменить её в файле настроек.

Сопоставление URL-адресов с представлениями

Итак, вкратце, эта функция представления возвращает HTML-страницу, включающую текущую дату и время. Для отображения этого представления по определённому URL-адресу вам потребуется создать URLconf; см. Диспетчер URL-адресов для получения инструкций.

Возврат ошибок

Возврат кодов ошибок HTTP в Django прост. Существуют подклассы HttpResponse для ряда распространенных кодов состояния HTTP, отличных от 200 (что означает «ОК»). Полный список доступных подклассов можно найти в документации запрос/ответ. Просто верните экземпляр одного из этих подклассов вместо обычного объекта HttpResponse, чтобы указать ошибку. Например:

from django.http import HttpResponse, HttpResponseNotFound

def my_view(request):
    # ...
    if foo:
        return HttpResponseNotFound('<h1>Page not found</h1>')
    else:
        return HttpResponse('<h1>Page was found</h1>')

Не существует специализированного подкласса для каждого возможного кода ответа HTTP, поскольку многие из них не будут столь распространены. Однако, как документировано в документации HttpResponse, вы также можете передать код состояния HTTP в конструктор HttpResponse, чтобы создать возвращаемый класс для любого кода состояния, который вам нужен. Например:

from django.http import HttpResponse

def my_view(request):
    # ...

    # Return a "created" (201) response code.
    return HttpResponse(status=201)

Поскольку ошибки 404 являются, пожалуй, самыми распространёнными ошибками HTTP, есть более простой способ их обработки.

Исключение `Http404`

class django.http.Http404

При возвращении ошибки, такой как HttpResponseNotFound, вы несете ответственность за определение HTML-содержимого результирующей страницы с ошибкой:

return HttpResponseNotFound('<h1>Page not found</h1>')

Для удобства и потому, что желательно иметь согласованную страницу ошибки 404 по всему сайту, Django предоставляет исключение Http404. Если вы поднимите исключение Http404 в любой точке функции представления, Django перехватит его и вернёт стандартную страницу ошибки для вашего приложения, а также код ошибки HTTP 404.

Пример использования:

from django.http import Http404
from django.shortcuts import render
from polls.models import Poll

def detail(request, poll_id):
    try:
        p = Poll.objects.get(pk=poll_id)
    except Poll.DoesNotExist:
        raise Http404("Poll does not exist")
    return render(request, 'polls/detail.html', {'poll': p})

Чтобы отобразить настраиваемый HTML, когда Django возвращает ошибку 404, вы можете создать HTML-шаблон с именем 404.html и поместить его в корневую папку дерева шаблонов. Этот шаблон будет затем отображаться, когда DEBUG установлено в значение False.

Когда DEBUG установлено в значение True, вы можете указать сообщение для Http404 и оно будет отображено в стандартном дебаг-шаблоне 404. Используйте эти сообщения для отладки; они, как правило, не подходят для использования в производственном шаблоне 404.

Настройка представлений ошибок

По умолчанию представления ошибок Django должны подойти для большинства веб-приложений, но их можно легко переопределить, если вам необходимо любое пользовательское поведение. Просто укажите обработчики, как показано ниже, в вашем URLconf (установка их где-либо ещё не повлияет).

Представление page_not_found() переопределяется handler404:

handler404 = 'mysite.views.my_custom_page_not_found_view'

Представление server_error() переопределяется handler500:

handler500 = 'mysite.views.my_custom_error_view'

Представление permission_denied() переопределяется handler403:

handler403 = 'mysite.views.my_custom_permission_denied_view'

Представление bad_request() переопределяется handler400:

handler400 = 'mysite.views.my_custom_bad_request_view'

См. также

Используйте настройку CSRF_FAILURE_VIEW для переопределения представления с ошибкой CSRF.

Тестирование настраиваемых представлений ошибок

Чтобы протестировать ответ пользовательского обработчика ошибок, вызовите соответствующее исключение в тестовом представлении. Например:

from django.core.exceptions import PermissionDenied
from django.http import HttpResponse
from django.test import SimpleTestCase, override_settings
from django.urls import path


def response_error_handler(request, exception=None):
    return HttpResponse('Error handler content', status=403)


def permission_denied_view(request):
    raise PermissionDenied


urlpatterns = [
    path('403/', permission_denied_view),
]

handler403 = response_error_handler


# ROOT_URLCONF must specify the module that contains handler403 = ...
@override_settings(ROOT_URLCONF=__name__)
class CustomErrorHandlerTests(SimpleTestCase):

    def test_handler_renders_template_response(self):
        response = self.client.get('/403/')
        # Make assertions on the response here. For example:
        self.assertContains(response, 'Error handler content', status_code=403)

© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/2.1/topics/http/views/

Создание представлений

Простое представление

Сопоставление URL-адресов с представлениями

Возврат ошибок

Исключение Http404

Настройка представлений ошибок

Тестирование настраиваемых представлений ошибок

Исключение `Http404`