Skip to content

standardised params for get_queryset_count_before / after #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions rest_framework_datatables/django_filters/backends.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ def filter_queryset(self, request, queryset, view):
if not self.check_renderer_format(request):
return queryset

count = self.get_queryset_count_before(view.get_queryset())
count = self.get_queryset_count_before(request, view.get_queryset(), view)
self.set_count_before(view, count)

# parsed datatables_query will be an attribute of the filterset
filterset = self.get_filterset(request, queryset, view)
if filterset is None:
count = self.get_queryset_count_after(queryset)
count = self.get_queryset_count_after(request, queryset, view)
self.set_count_after(view, count)
return queryset

Expand All @@ -39,7 +39,9 @@ def filter_queryset(self, request, queryset, view):
if global_q:
queryset = queryset.filter(global_q).distinct()

count = self.get_queryset_count_after(queryset)
count = self.get_queryset_count_after(
request, queryset, view
)
self.set_count_after(view, count)

# TODO Can we use OrderingFilter, maybe in DatatablesFilterSet, by
Expand Down Expand Up @@ -98,15 +100,15 @@ def get_ordering(self, request, view, filterset):
self.append_additional_ordering(ret, view)
return ret

def get_queryset_count_before(self, queryset):
def get_queryset_count_before(self, request, queryset, view):
"""
Provide an overrideable method to return a custom count.
This can be useful for very large tables, as calls to model.count()
can be very expensive.
"""
return queryset.count()

def get_queryset_count_after(self, queryset):
def get_queryset_count_after(self, request, queryset, view):
"""
See
:meth:`~rest_framework_datatables.django_filters.backends.DatatablesFilterBackend.get_queryset_count_before`.
Expand Down
4 changes: 2 additions & 2 deletions tests/test_django_filter_backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ class CustomDatatablesFilterBackend(DatatablesFilterBackend):
Override before and after counts to demonstrate performance fix.
"""

def get_queryset_count_before(self, queryset):
def get_queryset_count_before(self, request, queryset, view):
return 999

def get_queryset_count_after(self, queryset):
def get_queryset_count_after(self, request, queryset, view):
return 99


Expand Down