[Django]-Get unpaginated results from Django REST Framework

I used a similer appraoch to accepted answer

class Unpaginatable(PageNumberPagination):
    def paginate_queryset(self, queryset, request, view=None):
        if request.query_params.get('get_all', False) == 'true':
            return None

        return super(BuildListPagination, self).paginate_queryset(queryset, request, view=view)

now if you pass ?get_all=true while making the request, you will get unpaginated response.

If you are using page number pagination style, the below solution may be better.

    def paginate_queryset(self, queryset, request, view=None):
    if 'page' not in request.query_params:
        return None

    return super().paginate_queryset(queryset, request, view)

So you simply send a request without the page query_param.

thnaks to this answer,
Else, if you use limit/offset you can use this in Generic List API View class:

def paginate_queryset(self, queryset):
    if 'limit' not in self.request.query_params:
        return None
    return super().paginate_queryset(queryset)

It worked with python 3.9/ Django 4.0, In my case, this method had no argument named request and view, so I fixed it.

this will also won’t render paginator json, when the response is not paginated.

You can approximate this with a request limit set to an unfeasibly large number, but you need to configure Django first:

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination'
}

Then make a ridiculously high limit request:

GET https://api.example.org/accounts/?limit=999999999999

LimitOffsetPagination
– django-rest-framework.org

Actually DRF docs for this is very unclear, and there is no clear answer address this issue. After reading the source code, the followling code works for me.

from rest_framework.pagination import LimitOffsetPagination


class Unpaginated(LimitOffsetPagination):
    def paginate_queryset(self, queryset, request, view=None):
        self.count = self.get_count(queryset)
        self.limit = self.get_limit(request)
        self.offset = self.get_offset(request)
        self.request = request
        self.display_page_controls = False

        return list(queryset)


class SomeViewSet(viewsets.ModelViewSet):

    queryset = SomeModel.objects.all().order_by("-id")
    pagination_class = Unpaginated

The key here is to override the paginate_queryset function in base class and return the whole queryset.

However, overriding this function is not documented at all in the docs or I just missed it.

1. https://www.django-rest-framework.org/api-guide/pagination/
2. https://github.com/encode/django-rest-framework/blob/master/rest_framework/pagination.py

I solve this problem in the following way:

• make your own pagination class and inherit it from PageNumberPagination
• redefine or add your code (with super()) in get_page_size function.

For me works this case:

def get_page_size(self, request):
super().get_page_size(request)
…….
self.page_size = self.max_page_size
return self.page_size