Создание представлений
Функция представления, или представление вкратце, — это функция 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, а также библиотеку Pythondatetime. -
Далее мы определяем функцию под названием
current_datetime. Это функция представления. Каждая функция представления принимает объектHttpRequestв качестве первого параметра, который обычно называетсяrequest.Обратите внимание, что имя функции представления не имеет значения; Django её распознает без особых требований к имени. Мы назвали её
current_datetimeздесь, потому что это имя чётко указывает на её назначение. - Представление возвращает объект
HttpResponse, содержащий сгенерированный ответ. Каждая функция представления отвечает за возвращение объектаHttpResponse. (Есть исключения, но мы рассмотрим их позже.)
Временная зона Django
Django включает в себя настройку TIME_ZONE, которая по умолчанию равна America/Chicago. Скорее всего, это не ваша временная зона, поэтому вы можете изменить её в файле настроек.
Сопоставление URL-адресов с представлениями
Итак, подытожим: эта функция представления возвращает HTML-страницу, содержащую текущую дату и время. Чтобы отобразить это представление по определённому URL-адресу, вам необходимо создать URLconf; см. Диспетчер URL-адресов для получения инструкций.
Возвращение ошибок
Django предоставляет инструменты для возвращения кодов ошибок HTTP. Существуют подклассы HttpResponse для ряда распространённых кодов статуса HTTP, отличных от 200 (что означает «OK»). Полный список доступных подклассов можно найти в документации запросы/ответы. Верните экземпляр одного из этих подклассов вместо обычного объекта 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)
Асинхронные представления
Помимо синхронных функций, представления также могут быть асинхронными («async») функциями, обычно определёнными с использованием синтаксиса Python async def. Django автоматически распознает их и запустит в асинхронном контексте. Однако для получения преимуществ в производительности вам потребуется использовать асинхронный сервер на основе ASGI.
Вот пример асинхронного представления:
import datetime
from django.http import HttpResponse
async def current_datetime(request):
now = datetime.datetime.now()
html = "<html><body>It is now %s.</body></html>" % now
return HttpResponse(html)
Дополнительную информацию об асинхронной поддержке Django и о том, как наилучшим образом использовать асинхронные представления, можно найти в Поддержка асинхронного режима.
© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/5.1/topics/http/views/
