summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorCarlton Gibson <carlton.gibson@noumenal.es>2022-04-07 07:05:59 +0200
committerGitHub <noreply@github.com>2022-04-07 07:05:59 +0200
commit9ffd4eae2ce7a7100c98f681e2b6ab818df384a4 (patch)
tree2cc678b6feff9f187517439bf2856a8702c1f356 /docs/ref
parent2ee4caf56b8e000cabbb73ad81ff05738d6d0a35 (diff)
Fixed #33611 -- Allowed View subclasses to define async method handlers.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/class-based-views/base.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/ref/class-based-views/base.txt b/docs/ref/class-based-views/base.txt
index 5c2eb712c1..f60950d1fa 100644
--- a/docs/ref/class-based-views/base.txt
+++ b/docs/ref/class-based-views/base.txt
@@ -77,6 +77,17 @@ MRO is an acronym for Method Resolution Order.
<how-django-processes-a-request>` to the ``args`` and ``kwargs``
attributes, respectively. Then :meth:`dispatch` is called.
+ If a ``View`` subclass defines asynchronous (``async def``) method
+ handlers, ``as_view()`` will mark the returned callable as a coroutine
+ function. An ``ImproperlyConfigured`` exception will be raised if both
+ asynchronous (``async def``) and synchronous (``def``) handlers are
+ defined on a single view-class.
+
+ .. versionchanged:: 4.1
+
+ Compatibility with asynchronous (``async def``) method handlers was
+ added.
+
.. method:: setup(request, *args, **kwargs)
Performs key view initialization prior to :meth:`dispatch`.
@@ -111,6 +122,14 @@ MRO is an acronym for Method Resolution Order.
response with the ``Allow`` header containing a list of the view's
allowed HTTP method names.
+ If the other HTTP methods handlers on the class are asynchronous
+ (``async def``) then the response will be wrapped in a coroutine
+ function for use with ``await``.
+
+ .. versionchanged:: 4.1
+
+ Compatibility with classes defining asynchronous (``async def``)
+ method handlers was added.
``TemplateView``
================