Generics

class djangochannelsrestframework.generics.GenericAsyncAPIConsumer(*args, **kwargs)

Base class for all other generic views.

queryset

will be accesed when the method get_queryset is called.

serializer_class

it should correspond with the queryset model, it will be useded for the return response.

lookup_field

field used in the get_object method. Optional.

lookup_url_kwarg

url parameter used it for the lookup.

filter_queryset(queryset: django.db.models.query.QuerySet, **kwargs) → django.db.models.query.QuerySet

Given a queryset, filter it with whichever filter backend is in use.

You are unlikely to want to override this method, although you may need to call it either from a list view, or from a custom get_object method if you want to apply the configured filtering backend to the default queryset.

Parameters

• queryset – cached queryset to filter.

• kwargs – keyworded dictionary arguments.

Returns

Filtered queryset.

Todos:

Implement

get_object(**kwargs) → django.db.models.base.Model

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

Parameters

kwargs – keyworded dictionary, it can be use it for filtering the queryset.

Returns

Model object class.

Examples

>>> filtered_queryset = self.get_object(**{"field__gte": value})  # this way you could filter from the frontend.

get_queryset(**kwargs) → django.db.models.query.QuerySet

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

Parameters

kwargs – keyworded dictionary.

Returns

Queryset attribute.

get_serializer(action_kwargs: Optional[Dict] = None, *args, **kwargs) → rest_framework.serializers.Serializer

Return the serializer instance that should be used for validating and deserializing input, and for serializing output.

Parameters

• action_kwargs – keyworded dictionary from the action.

• args – listed arguments.

• kwargs – keyworded dictionary arguments.

Returns

Model serializer.

get_serializer_class(**kwargs) → Type[rest_framework.serializers.Serializer]

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

Parameters

kwargs – keyworded dictionary arguments.

Returns

Model serializer class.

get_serializer_context(**kwargs) → Dict[str, Any]

Extra context provided to the serializer class.

Parameters

kwargs – keyworded dictionary arguments.

Returns

Context dictionary, containing the scope and the consumer instance.