Correct way to use async class based views in Django

Question

I am trying to use the very new Django 3.1 Async view classes. Based on the limited documentation available, I have tried to create my own async def __call__() method. From the documents:

For a class-based view, this means making its __call__() method an async def (not its __init__() or as_view()).

Django 3.1 Development Documents

However, until now I have had no luck with writing an asynchronous class based view. I constantly get await exceptions, or asyncio.iscoroutinefunction returns False, which I assume should return true if the class is actually Asynchronous.

Since the documentation is lacking an example, could someone with more knowledge of async programming help me with an example of a class based asynchronous view?

Is there any example where I can see async __call__() method? — inthevortex
– inthevortex, Commented Jan 27, 2021 at 7:50

Hamidreza · Accepted Answer · 2022-05-13 18:48:12Z

7

Spend quite some time searching in the Django ticket system, blogposts (thx to Joren), etc. so you don't have to.

The best you can do is using the code from the blog:

class YourView(View):    
    @classonlymethod
    def as_view(cls, **initkwargs):
        view = super().as_view(**initkwargs)
        view._is_coroutine = asyncio.coroutines._is_coroutine
        return view

    async def get(self, *args, **kwargs):
        ...

But you also need to be aware there is no way you can use actual generics (no async ORM support, even TemplateView doesn't work) and build-in decorators for 3.1. You need to write your own stuff for things that Django normally does itself.

edited May 13, 2022 at 18:48

Hamidreza

7761 gold badge9 silver badges25 bronze badges

answered Oct 18, 2020 at 19:02

Kuizame

1781 silver badge7 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Saurav Kumar Over a year ago

When I called the API with a different method (say PUT/POST) instead of raising 405 Method Not Allowed, It responded with 500 - TypeError: object HttpResponseNotAllowed can't be used in 'await' expression I'm not sure how to fix this. Can you please help me with this? Thanks in advance.

AnonymousUser Over a year ago

I get You cannot call this from an async context - use a thread or sync_to_async.

str4hex · Accepted Answer · 2023-01-15 18:14:19Z

1

class Test(CreateView):
    template_name = 'index.html'
    form_class = TestForm
    view_is_async = True # on async

answered Jan 15, 2023 at 18:14

str4hex

515 bronze badges

1 Comment

unlockme Over a year ago

This answer is wrong. It may look like it is working but it can cause problems. view_is_async is a property that depends on many things.

Collectives™ on Stack Overflow

Correct way to use async class based views in Django

2 Answers 2

2 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related