diff options
Diffstat (limited to 'docs/topics')
| -rw-r--r-- | docs/topics/async.txt | 5 | ||||
| -rw-r--r-- | docs/topics/class-based-views/index.txt | 30 |
2 files changed, 33 insertions, 2 deletions
diff --git a/docs/topics/async.txt b/docs/topics/async.txt index 90a31b994b..ab2ccd3c98 100644 --- a/docs/topics/async.txt +++ b/docs/topics/async.txt @@ -22,8 +22,9 @@ Async views Any view can be declared async by making the callable part of it return a coroutine - commonly, this is done using ``async def``. For a function-based view, this means declaring the whole view using ``async def``. For a -class-based view, this means making its ``__call__()`` method an ``async def`` -(not its ``__init__()`` or ``as_view()``). +class-based view, this means declaring the HTTP method handlers, such as +``get()`` and ``post()`` as ``async def`` (not its ``__init__()``, or +``as_view()``). .. note:: diff --git a/docs/topics/class-based-views/index.txt b/docs/topics/class-based-views/index.txt index 01f9c35460..1a6368cc08 100644 --- a/docs/topics/class-based-views/index.txt +++ b/docs/topics/class-based-views/index.txt @@ -128,3 +128,33 @@ the response (using the ``book_list.html`` template). But if the client issues a ``HEAD`` request, the response has an empty body and the ``Last-Modified`` header indicates when the most recent book was published. Based on this information, the client may or may not download the full object list. + +.. _async-class-based-views: + +Asynchronous class-based views +============================== + +.. versionadded:: 4.1 + +As well as the synchronous (``def``) method handlers already shown, ``View`` +subclasses may define asynchronous (``async def``) method handlers to leverage +asynchronous code using ``await``:: + + import asyncio + from django.http import HttpResponse + from django.views import View + + class AsyncView(View): + async def get(self, request, *args, **kwargs): + # Perform io-blocking view logic using await, sleep for example. + await asyncio.sleep(1) + return HttpResponse("Hello async world!") + +Within a single view-class, all user-defined method handlers must be either +synchronous, using ``def``, or all asynchronous, using ``async def``. An +``ImproperlyConfigured`` exception will be raised in ``as_view()`` if ``def`` +and ``async def`` declarations are mixed. + +Django will automatically detect asynchronous views and run them in an +asynchronous context. You can read more about Django's asynchronous support, +and how to best use async views, in :doc:`/topics/async`. |