Skip to content

Commit

Permalink
[2.2.x] Fixed #28469 -- Doc'd how to create a custom HttpResponse sub…
Browse files Browse the repository at this point in the history
…class.

Backport of 9f1ec9e from master
  • Loading branch information
bmispelon authored and felixxm committed Nov 25, 2019
1 parent 8a8ea93 commit ad56858
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/ref/request-response.txt
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,8 @@ Methods
:setting:`DEFAULT_CHARSET` settings, by default: "`text/html; charset=utf-8`".

``status`` is the :rfc:`HTTP status code <7231#section-6>` for the response.
You can use Python's :py:class:`http.HTTPStatus` for meaningful aliases,
such as ``HTTPStatus.NO_CONTENT``.

``reason`` is the HTTP response phrase. If not provided, a default phrase
will be used.
Expand Down Expand Up @@ -958,6 +960,18 @@ types of HTTP responses. Like ``HttpResponse``, these subclasses live in
:class:`~django.template.response.SimpleTemplateResponse`, and the
``render`` method must itself return a valid response object.

Custom response classes
~~~~~~~~~~~~~~~~~~~~~~~

If you find yourself needing a response class that Django doesn't provide, you
can create it with the help of :py:class:`http.HTTPStatus`. For example::

from http import HTTPStatus
from django.http import HttpResponse

class HttpResponseNoContent(HttpResponse):
status_code = HTTPStatus.NO_CONTENT

``JsonResponse`` objects
========================

Expand Down

0 comments on commit ad56858

Please sign in to comment.