I’m creating a django app. Users login and are shown a static web page that is managed by the flatpages app.
Here are typical status messages from the dev server:
[15/Aug/2013 18:43:16] "GET / HTTP/1.1" 200 1263
[15/Aug/2013 18:43:23] "POST / HTTP/1.1" 302 0
[15/Aug/2013 18:43:23] "GET /home HTTP/1.1" 301 0
[15/Aug/2013 18:43:23] "GET /home/ HTTP/1.1" 200 4529
- The first line is for the login page at /. This is served successfully, code 200.
- The second line is the form input. The server response code is 302, which means the page is moved temporarily.
- The third line is is an attempt to retrieve a page (‘/home’) that doesn’t exist, because the underlying page is served by flatpages. The 301 server response code indicates that the page has been moved permanently.
- The fourth line is a successful delivery of content (‘/home’) from flatpages.
Why does the server respond with 302 for a put request?
What is causing the third line? Why is this message sent out at all? Shouldn’t this be something that is caught by the flatpages middleware? Is my web client sending the request underling the fourth line? How does it know to do this?
I guess the most important question is: Am I doing something wrong?
Thanks for the help!
urls.py
urlpatterns = patterns('',
url(r'^admin/', include(admin.site.urls)),
url(r'^$', 'django.contrib.auth.views.login'),
url(r'^logout$', 'guide.views.logout_view'),
# other patterns
(r'', include('django.contrib.flatpages.urls')),
)
views.py
def home(request):
if request.user.is_authenticated() == False:
return HttpResponseRedirect('/')
return HttpResponseRedirect('/home/')
Excerpt from settings.py
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',
'guide.middleware.LogActivity'
)
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'django.contrib.flatpages',
'django.contrib.admin',
'guide',
)
I’m creating a django app. Users login and are shown a static web page that is managed by the flatpages app.
Here are typical status messages from the dev server:
[15/Aug/2013 18:43:16] "GET / HTTP/1.1" 200 1263
[15/Aug/2013 18:43:23] "POST / HTTP/1.1" 302 0
[15/Aug/2013 18:43:23] "GET /home HTTP/1.1" 301 0
[15/Aug/2013 18:43:23] "GET /home/ HTTP/1.1" 200 4529
- The first line is for the login page at /. This is served successfully, code 200.
- The second line is the form input. The server response code is 302, which means the page is moved temporarily.
- The third line is is an attempt to retrieve a page (‘/home’) that doesn’t exist, because the underlying page is served by flatpages. The 301 server response code indicates that the page has been moved permanently.
- The fourth line is a successful delivery of content (‘/home’) from flatpages.
Why does the server respond with 302 for a put request?
What is causing the third line? Why is this message sent out at all? Shouldn’t this be something that is caught by the flatpages middleware? Is my web client sending the request underling the fourth line? How does it know to do this?
I guess the most important question is: Am I doing something wrong?
Thanks for the help!
urls.py
urlpatterns = patterns('',
url(r'^admin/', include(admin.site.urls)),
url(r'^$', 'django.contrib.auth.views.login'),
url(r'^logout$', 'guide.views.logout_view'),
# other patterns
(r'', include('django.contrib.flatpages.urls')),
)
views.py
def home(request):
if request.user.is_authenticated() == False:
return HttpResponseRedirect('/')
return HttpResponseRedirect('/home/')
Excerpt from settings.py
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',
'guide.middleware.LogActivity'
)
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'django.contrib.flatpages',
'django.contrib.admin',
'guide',
)
I’m creating a django app. Users login and are shown a static web page that is managed by the flatpages app.
Here are typical status messages from the dev server:
[15/Aug/2013 18:43:16] "GET / HTTP/1.1" 200 1263
[15/Aug/2013 18:43:23] "POST / HTTP/1.1" 302 0
[15/Aug/2013 18:43:23] "GET /home HTTP/1.1" 301 0
[15/Aug/2013 18:43:23] "GET /home/ HTTP/1.1" 200 4529
- The first line is for the login page at /. This is served successfully, code 200.
- The second line is the form input. The server response code is 302, which means the page is moved temporarily.
- The third line is is an attempt to retrieve a page (‘/home’) that doesn’t exist, because the underlying page is served by flatpages. The 301 server response code indicates that the page has been moved permanently.
- The fourth line is a successful delivery of content (‘/home’) from flatpages.
Why does the server respond with 302 for a put request?
What is causing the third line? Why is this message sent out at all? Shouldn’t this be something that is caught by the flatpages middleware? Is my web client sending the request underling the fourth line? How does it know to do this?
I guess the most important question is: Am I doing something wrong?
Thanks for the help!
urls.py
urlpatterns = patterns('',
url(r'^admin/', include(admin.site.urls)),
url(r'^$', 'django.contrib.auth.views.login'),
url(r'^logout$', 'guide.views.logout_view'),
# other patterns
(r'', include('django.contrib.flatpages.urls')),
)
views.py
def home(request):
if request.user.is_authenticated() == False:
return HttpResponseRedirect('/')
return HttpResponseRedirect('/home/')
Excerpt from settings.py
MIDDLEWARE_CLASSES = (
'django.middleware.common.CommonMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',
'guide.middleware.LogActivity'
)
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.messages',
'django.contrib.staticfiles',
'django.contrib.flatpages',
'django.contrib.admin',
'guide',
)
status.py
418 I’m a teapot — Any attempt to brew coffee with a teapot should result in the error code «418 I’m a teapot». The resulting entity body MAY be short and stout.
— RFC 2324, Hyper Text Coffee Pot Control Protocol
Using bare status codes in your responses isn’t recommended. REST framework includes a set of named constants that you can use to make your code more obvious and readable.
from rest_framework import status
from rest_framework.response import Response
def empty_view(self):
content = {'please move along': 'nothing to see here'}
return Response(content, status=status.HTTP_404_NOT_FOUND)
The full set of HTTP status codes included in the status
module is listed below.
The module also includes a set of helper functions for testing if a status code is in a given range.
from rest_framework import status
from rest_framework.test import APITestCase
class ExampleTestCase(APITestCase):
def test_url_root(self):
url = reverse('index')
response = self.client.get(url)
self.assertTrue(status.is_success(response.status_code))
For more information on proper usage of HTTP status codes see RFC 2616
and RFC 6585.
Informational — 1xx
This class of status code indicates a provisional response. There are no 1xx status codes used in REST framework by default.
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
Successful — 2xx
This class of status code indicates that the client’s request was successfully received, understood, and accepted.
HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS
HTTP_208_ALREADY_REPORTED
HTTP_226_IM_USED
Redirection — 3xx
This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.
HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT
HTTP_308_PERMANENT_REDIRECT
Client Error — 4xx
The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.
HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_426_UPGRADE_REQUIRED
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
Server Error — 5xx
Response status codes beginning with the digit «5» indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.
HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_506_VARIANT_ALSO_NEGOTIATES
HTTP_507_INSUFFICIENT_STORAGE
HTTP_508_LOOP_DETECTED
HTTP_509_BANDWIDTH_LIMIT_EXCEEDED
HTTP_510_NOT_EXTENDED
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
Helper functions
The following helper functions are available for identifying the category of the response code.
is_informational() # 1xx
is_success() # 2xx
is_redirect() # 3xx
is_client_error() # 4xx
is_server_error() # 5xx
Переадресация и отправка статусных кодов
Последнее обновление: 14.08.2022
Переадресация
При перемещении документа с одного адреса на другой мы можем воспользоваться механизмом переадресации, чтобы указать пользователям и поисковику, что
документу теперь доступен по новому адресу.
Переадресация бывает временная и постоянная. При временной переадресации мы указываем, что документ временно перемещен на новый адрес. В этом случае
в ответ отправляется статусный код 302. При постоянной переадресации мы уведомляем, что документ теперь постоянно будет достуен по новому адресу
Для создания временной переадресации применяется класс HttpResponseRedirect, а для постоянной — класс
HttpResponsePermanentRedirect, которые расположены в пакете django.http.
Так, определим в файле views.py следующий код:
from django.http import HttpResponse, HttpResponseRedirect, HttpResponsePermanentRedirect def index(request): return HttpResponse("Index") def about(request): return HttpResponse("About") def contact(request): return HttpResponseRedirect("/about") def details(request): return HttpResponsePermanentRedirect("/")
При обращении к функции contact
она будет перенаправлять по пути «about», который будет обрабатываться функцией about
.
А функция details
будет использовать постоянную переадресацию и перенаправлять на корень веб-приложения.
И также в файле urls.py для тестирования определим следующие маршруты:
from django.urls import path from hello import views urlpatterns = [ path("", views.index), path("about/", views.about), path("contact/", views.contact), path("details/", views.details), ]
Отправка статусных кодов
Также в пакете django.http есть ряд классов, которые позволяют отправлять определенный статусный код:
Статусный код |
Класс |
304 (Not Modified) |
HttpResponseNotModified |
400 (Bad Request) |
HttpResponseBadRequest |
403 (Forbidden) |
HttpResponseForbidden |
404 (Not Found) |
HttpResponseNotFound |
405 (Method Not Allowed) |
HttpResponseNotAllowed |
410 (Gone) |
HttpResponseGone |
500 (Internal Server Error) |
HttpResponseServerError |
В функцию конструктора этих классов можно передать некоторые данные, например, сообщение об ошибке, которое увидит пользователь:
HttpResponseNotModified() HttpResponseBadRequest("Bad Request") HttpResponseForbidden("Forbidden") HttpResponseNotFound("Not Found") HttpResponseNotAllowed("Method is not allowed") HttpResponseGone("Content is no longer here") HttpResponseServerError("Server Error")
Например, определим следующий файл views.py:
from django.http import HttpResponse, HttpResponseNotFound, HttpResponseForbidden, HttpResponseBadRequest def index(request, id): people = ["Tom", "Bob", "Sam"] # если пользователь найден, возвращаем его if id in range(0, len(people)): return HttpResponse(people[id]) # если нет, то возвращаем ошибку 404 else: return HttpResponseNotFound("Not Found") def access(request, age): # если возраст НЕ входит в диапазон 1-110, посылаем ошибку 400 if age not in range(1, 111): return HttpResponseBadRequest("Некорректные данные") # если возраст больше 17, то доступ разрешен if(age > 17): return HttpResponse("Доступ разрешен") # если нет, то возвращаем ошибку 403 else: return HttpResponseForbidden("Доступ заблокирован: недостаточно лет")
Функция index принимает параметр id. Это будет индекс элемента в списке people. Однако пользователь может передать и
недействительный индекс, например, 100, хотя в примере в списке только 3 элемента. Поэтому, если передан действительный индекс,
то возвращаем элемент по этому индексу. Если же индекс нейдествителен, то с помощью класса HttpResponseNotFound возвращаем
ошибку 404 и сообщение об ошибке.
Аналогично функция access принимает параметр age, который представляет условный возвраст пользователя. Если возраст
выходит за некоторые разумные пределы (1-110), то с помощью класса HttpResponseBadRequest возвращаем ошибку 400.
Если возраст укладывается в эти рамки, но он меньше 18, то с помощью класса HttpResponseForbidden возвращаем ошибку 403 о том, что доступ запрещен.
Для теста в файле urls.py определим следующие маршруты:
from django.urls import path from hello import views urlpatterns = [ path("index/<int:id>", views.index), path("access/<int:age>", views.access), ]
Обратися к функции index, передав для параметра id корректные и некорректные значения. И в зависимости от значения параметра
мы увидим либо данные из списка people, либо ошибку 404:
Аналогично при обращении по адресу «/access» в зависимости от значения параметра age мы увидим либо
сообщения об ошибке, либо обычное сообщение:
Стоит отметить, что статусные сообщения об ошибках также отображаются в консоль запущенного приложения:
Коды состояния¶
418 I’m a teapot — Любая попытка сварить кофе с помощью чайника должна привести к коду ошибки «418 I’m a teapot». Результирующее тело сущности МОЖЕТ быть коротким и крепким.
‒ :doc:`RFC 2324 <https://www.ietf.org/rfc/rfc2324.txt>`** , Hyper Text Coffee Pot Control Protocol
Не рекомендуется использовать в ответах пустые коды состояния. Фреймворк REST включает набор именованных констант, которые вы можете использовать, чтобы сделать ваш код более очевидным и читаемым.
from rest_framework import status from rest_framework.response import Response def empty_view(self): content = {'please move along': 'nothing to see here'} return Response(content, status=status.HTTP_404_NOT_FOUND)
Полный набор кодов состояния HTTP, включенных в модуль status
, приведен ниже.
Модуль также включает набор вспомогательных функций для проверки того, находится ли код состояния в заданном диапазоне.
from rest_framework import status from rest_framework.test import APITestCase class ExampleTestCase(APITestCase): def test_url_root(self): url = reverse('index') response = self.client.get(url) self.assertTrue(status.is_success(response.status_code))
Для получения дополнительной информации о правильном использовании кодов состояния HTTP смотрите RFC 2616 и RFC 6585.
Информационный — 1xx¶
Этот класс кода состояния указывает на предварительный ответ. По умолчанию в REST-фреймворке не используются коды состояния 1xx.
HTTP_100_CONTINUE HTTP_101_SWITCHING_PROTOCOLS
Успешно — 2xx¶
Этот класс кода состояния указывает на то, что запрос клиента был успешно получен, понят и принят.
HTTP_200_OK HTTP_201_CREATED HTTP_202_ACCEPTED HTTP_203_NON_AUTHORITATIVE_INFORMATION HTTP_204_NO_CONTENT HTTP_205_RESET_CONTENT HTTP_206_PARTIAL_CONTENT HTTP_207_MULTI_STATUS HTTP_208_ALREADY_REPORTED HTTP_226_IM_USED
Перенаправление — 3xx¶
Этот класс кода состояния указывает на то, что агенту пользователя необходимо предпринять дополнительные действия для выполнения запроса.
HTTP_300_MULTIPLE_CHOICES HTTP_301_MOVED_PERMANENTLY HTTP_302_FOUND HTTP_303_SEE_OTHER HTTP_304_NOT_MODIFIED HTTP_305_USE_PROXY HTTP_306_RESERVED HTTP_307_TEMPORARY_REDIRECT HTTP_308_PERMANENT_REDIRECT
Ошибка клиента — 4xx¶
Код состояния класса 4xx предназначен для случаев, когда клиент, похоже, ошибся. За исключением ответа на запрос HEAD, сервер ДОЛЖЕН включать объект, содержащий объяснение ситуации с ошибкой, а также то, является ли она временной или постоянной.
HTTP_400_BAD_REQUEST HTTP_401_UNAUTHORIZED HTTP_402_PAYMENT_REQUIRED HTTP_403_FORBIDDEN HTTP_404_NOT_FOUND HTTP_405_METHOD_NOT_ALLOWED HTTP_406_NOT_ACCEPTABLE HTTP_407_PROXY_AUTHENTICATION_REQUIRED HTTP_408_REQUEST_TIMEOUT HTTP_409_CONFLICT HTTP_410_GONE HTTP_411_LENGTH_REQUIRED HTTP_412_PRECONDITION_FAILED HTTP_413_REQUEST_ENTITY_TOO_LARGE HTTP_414_REQUEST_URI_TOO_LONG HTTP_415_UNSUPPORTED_MEDIA_TYPE HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE HTTP_417_EXPECTATION_FAILED HTTP_422_UNPROCESSABLE_ENTITY HTTP_423_LOCKED HTTP_424_FAILED_DEPENDENCY HTTP_426_UPGRADE_REQUIRED HTTP_428_PRECONDITION_REQUIRED HTTP_429_TOO_MANY_REQUESTS HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
Ошибка сервера — 5xx¶
Коды состояния ответа, начинающиеся с цифры «5», указывают на случаи, когда сервер знает, что он ошибся или не в состоянии выполнить запрос. За исключением ответа на запрос HEAD, сервер ДОЛЖЕН включать объект, содержащий объяснение ситуации с ошибкой, а также то, является ли она временной или постоянной.
HTTP_500_INTERNAL_SERVER_ERROR HTTP_501_NOT_IMPLEMENTED HTTP_502_BAD_GATEWAY HTTP_503_SERVICE_UNAVAILABLE HTTP_504_GATEWAY_TIMEOUT HTTP_505_HTTP_VERSION_NOT_SUPPORTED HTTP_506_VARIANT_ALSO_NEGOTIATES HTTP_507_INSUFFICIENT_STORAGE HTTP_508_LOOP_DETECTED HTTP_509_BANDWIDTH_LIMIT_EXCEEDED HTTP_510_NOT_EXTENDED HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
Вспомогательные функции¶
Для определения категории кода ответа доступны следующие вспомогательные функции.
is_informational() # 1xx is_success() # 2xx is_redirect() # 3xx is_client_error() # 4xx is_server_error() # 5xx