aboutsummaryrefslogtreecommitdiffstats
path: root/rest_framework/generics.py
diff options
context:
space:
mode:
authorBen Konrath2012-10-08 22:00:55 +0200
committerBen Konrath2012-10-11 12:01:07 +0200
commit1e9ece0f9353515265da9b6266dc4b39775a0257 (patch)
treeab71c69bc46d7e48e256a2cb31128b241e0b2e0f /rest_framework/generics.py
parent83f39b3dce4028ff6b2ebe0be55c2a00d67ede00 (diff)
downloaddjango-rest-framework-1e9ece0f9353515265da9b6266dc4b39775a0257.tar.bz2
First attempt at adding filter support.
The filter support uses django-filter to work its magic.
Diffstat (limited to 'rest_framework/generics.py')
-rw-r--r--rest_framework/generics.py35
1 files changed, 33 insertions, 2 deletions
diff --git a/rest_framework/generics.py b/rest_framework/generics.py
index 59739d01..3b2bea3b 100644
--- a/rest_framework/generics.py
+++ b/rest_framework/generics.py
@@ -1,12 +1,12 @@
"""
-Generic views that provide commmonly needed behaviour.
+Generic views that provide commonly needed behaviour.
"""
from rest_framework import views, mixins
from rest_framework.settings import api_settings
from django.views.generic.detail import SingleObjectMixin
from django.views.generic.list import MultipleObjectMixin
-
+import django_filters
### Base classes for the generic views ###
@@ -58,6 +58,37 @@ class MultipleObjectBaseView(MultipleObjectMixin, BaseView):
pagination_serializer_class = api_settings.PAGINATION_SERIALIZER
paginate_by = api_settings.PAGINATE_BY
+ filter_class = None
+ filter_fields = None
+
+ def get_filter_class(self):
+ """
+ Return the django-filters `FilterSet` used to filter the queryset.
+ """
+ if self.filter_class:
+ return self.filter_class
+
+ if self.filter_fields:
+ class AutoFilterSet(django_filters.FilterSet):
+ class Meta:
+ model = self.model
+ fields = self.filter_fields
+ return AutoFilterSet
+
+ return None
+
+ def filter_queryset(self, queryset):
+ filter_class = self.get_filter_class()
+
+ if filter_class:
+ assert issubclass(filter_class.Meta.model, self.model), \
+ "%s is not a subclass of %s" % (filter_class.Meta.model, self.model)
+ return filter_class(self.request.GET, queryset=queryset)
+
+ return queryset
+
+ def get_filtered_queryset(self):
+ return self.filter_queryset(self.get_queryset())
def get_pagination_serializer_class(self):
"""