We can have a separate Mixin for that or just add the logic to exiting one.

class SelectForIncludesMixin(object):

    def get_queryset(self):
        """
        This viewset provides a helper attribute to select related models
        based on the include specified in the URL.

        __all__ can be used to specify a select which should be done regardless of the include

        .. code:: python

            # When MyViewSet is called with ?include=author it will prefetch author and authorbio
            class MyViewSet(viewsets.ModelViewSet):
                queryset = Book.objects.all()
                select_for_includes = {
                    '__all__': [],
                    'author': ['author', 'author__authorbio'],
                    'category.section': ['category']
                }
        """
        qs = super(SelectForIncludesMixin, self).get_queryset()
        if not hasattr(self, 'select_for_includes'):
            return qs

        includes = self.request.GET.get('include', '').split(',')
        for inc in includes + ['__all__']:
            selects = self.select_for_includes.get(inc)
            if selects:
                qs = qs.select_related(*selects)

        return qs

Do select_related for ?include #591

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Do `select_related` for ?include #591