Skip to content

Commit 91d9e6e

Browse files
committed
documented the detail class based view
1 parent be308dd commit 91d9e6e

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## AsyncDetailView
2+
3+
`AsyncDetailView` generic view is provided
4+
5+
```python
6+
from django_async_extensions.aviews.generic import AsyncDetailView
7+
8+
class MyDetailView(AsyncDetailView):
9+
model = MyModel
10+
```
11+
12+
`AsyncDetailView` is similar to django's [DetailView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/generic-display/#detailview) but with a few differences:
13+
14+
1. `get_object()` method is async.
15+
2. `get_queryset()` method is async.
16+
3. `get()` method is async.
17+
4. `AsyncDetailView` inherits from [AsyncView](async-class-based-views.md#asyncview) so anything mentioned there also applies here.
18+
19+
20+
## Base classes
21+
some of the base classes for `DetailView` have been re-written as async:
22+
23+
#### AsyncSingleObjectMixin
24+
25+
like [SingleObjectMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-single-object/#django.views.generic.detail.SingleObjectMixin) but `get_object()` and `get_queryset()` are async.
26+
27+
#### AsyncBaseDetailView
28+
29+
like [BaseDetailView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/generic-display/#django.views.generic.detail.BaseDetailView) but `get()` is async.

0 commit comments

Comments
 (0)