diff options
| author | Baptiste Mispelon <bmispelon@gmail.com> | 2019-11-22 21:50:11 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-11-25 08:12:50 +0100 |
| commit | 9f1ec9efc35bbb375c9cebb3e0d8c1b7be838338 (patch) | |
| tree | 4709b84ef06c072439051a24f75840ed93a98f42 /docs/ref | |
| parent | a5855c8f0fe17b7e888bd8137874ef78012a7294 (diff) | |
Fixed #28469 -- Doc'd how to create a custom HttpResponse subclass.
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/request-response.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index e7b285b086..a7e73ba1f5 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -766,6 +766,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. @@ -969,6 +971,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 ======================== |
