Define pagination page_size per-view in Django Rest Framework

Question

Since version 3.3 it's not longer possible to define page_size on the view, as it's moved to the paginator class. related deprecations

Our API has different page_sizes defined for different views and it feels ambiguous to add new paginator subclasses just to overwrite the page_size attribute. I cannot instantiate the paginator class in the view definition and use the __init__ method as it's instantiated here. I could overwrite this and make it a method what returns an instance instantiated with the right parameters, but as its name is not get_pagination_class, probably it's not a good idea.

My question is what would be the cleanest way to dynamically create a paginator class with the proper page_size attribute set?

I've seen this question, and I'd like to avoid both of its solutions.

Answer 1

You can achieve something relatively clean:

---

• Assuming you are setting the pagination per class with the pagination_class attribute.
• Assuming that you keep the page_size attribute in your class.

---

1. In your settings.py add a global pagination setting:

   'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
   'PAGE_SIZE': default_page_size,
   

   You can handle with this all the views that have the same page size.

2. For any other view/viewset:

   class ACustomViewSet(mixins.ListModelMixin, 
                        mixins.DestroyModelMixin, 
                        viewsets.GenericViewSet):
   
       pagination_class = PageNumberPagination
       page_size = N
       pagination_class.page_size = self.page_size
   

   Or you can do this inside a method:

   def list(self, request, *args, **kwargs):
       self.pagination_class.page_size = self.page_size 
       ...