Search and filter doing nothing in custom ViewSet

Hi,

I have a django rest application with multiple viewsets that are working correctly with datatables and this package. However, I have recently made a custom viewset which overrides the list() method of the viewset. Therefore, the ?format=datatables is not working correctly (the list function is overridden and only that functionality happens). Sorting, paging, and filtering are not working correctly. How can I also get the datatables formatted endpoint on server side processing to correctly paginate, filter, and search even though I have overridden the list() method of my viewset.

I tried the following which is pretty much the same as the docs:

Are my annotations breaking things?

class ValidationSummaryViewSet(viewsets.ViewSet):
    queryset = TargetConfirmation.objects.values('target_prediction__id').annotate(
        sample_id=F('target_prediction__id'), num_selected=Count('selected'), num_validated=Count('validated'),
        num_has_standard=Count('has_standard'))
    serializer_class = ValidationSummarySerializer

    def list(self, request):
        serializer = self.serializer_class(self.queryset, many=True)
        return Response(serializer.data)

Thanks!

[neighlyd]

Hey @Rubyj ,

From what I can see here, you aren’t running your serializer through either a paginator or a filter when you override list().

If you look at the code for list(), you’ll see that it runs the queryset through both self.filter_queryset() and self.paginate_queryset(). The first method checks your queryset filter backend and iterates through it, applying the filters that you have listed. The second method does something similar, in that it checks your object for a paginator and runs its pagination method.

However, since your list() method doesn’t call either of these methods, the resulting serializer has no way of being either filtered or paginated, whether through DRF Datatables or any other filtering and pagination package.

I would recommend looking at the source-code for the list() method mixin to refactor your own implementation so that you can implement these features.

[neighlyd]

Hopefully it works!

If you aren’t familiar, there are two really fantastic websites that break down Django’s views and Django Rest Framework’s views and serializers into their component methods and mixins. They are really amazing resources. I highly recommend bookmarking them and having a look whenever you get stuck or want to modify existing behaviors.

Here is the Django Class-Based Views Website Here is the DRF Class Website

PS: I’m @neighlyd , not @izimobil. Not that it matters too much, so long as your issue gets resolved.