DictModeViewSet.py

from rest_framework import viewsets


class DictModeViewSet(viewsets.ModelViewSet):
    """
    ViewSet that renders data as dict with keys corresponding to the model
    primary key. Instead of list.
    """

    BYPASS_DICT_MODE = False
    LIST_SHOULD_BE_DETAIL = False

    def list(self, request, *args, **kwargs):
        response = super(viewsets.ModelViewSet, self).list(  # pylint: disable=E1003
            request, *args, **kwargs
        )  # call the original 'list'

        if self.LIST_SHOULD_BE_DETAIL:
            if len(response.data) == 0:
                response.data = dict()
            elif len(response.data) == 1:
                response.data = response.data[0]
            else:
                raise Exception(
                    "There should be no more than one element here check your queryset !"
                )

        elif not self.BYPASS_DICT_MODE:
            pk_attr_name = self.serializer_class.Meta.model._meta.pk.name
            response.data = {d[pk_attr_name]: d for d in response.data}

        return response