Merge pull request #86 from rpkilby/ff-reusability

Fix compatibility with backend filter_fields use

Author: Ryan P Kilby

rest_framework_filters/backends.py

@@ -1,4 +1,6 @@
 
+from copy import copy
+
 from django.template import loader
 from rest_framework import compat
 import rest_framework.filters
@@ -9,6 +11,14 @@
 class DjangoFilterBackend(rest_framework.filters.DjangoFilterBackend):
     default_filter_set = FilterSet
 
+    def get_filter_class(self, view, queryset=None):
+        # if creating an AutoFilterSet, copy the filter_fields as they may be
+        # destructively modified. See issue #81.
+        if hasattr(view, 'filter_fields'):
+            view.filter_fields = copy(view.filter_fields)
+
+        return super(DjangoFilterBackend, self).get_filter_class(view, queryset)
+
     def filter_queryset(self, request, queryset, view):
         filter_class = self.get_filter_class(view, queryset)
 

tests/test_backends.py

@@ -16,3 +16,14 @@ def test_django_filter_compatibility(self):
 
         self.assertEqual(len(response.data), 1)
         self.assertEqual(response.data[0]['username'], 'user1')
+
+    def test_filter_fields_reusability(self):
+        # Ensure auto-generated FilterSet is reusable w/ filter_fields. See:
+        # https://github.com/philipn/django-rest-framework-filters/issues/81
+        response = self.client.get('/ff-users/', {'username': 'user1'}, content_type='json')
+        self.assertEqual(len(response.data), 1)
+        self.assertEqual(response.data[0]['username'], 'user1')
+
+        response = self.client.get('/ff-users/', {'username': 'user1'}, content_type='json')
+        self.assertEqual(len(response.data), 1)
+        self.assertEqual(response.data[0]['username'], 'user1')

tests/testapp/urls.py

@@ -7,6 +7,7 @@
 
 router = routers.DefaultRouter()
 router.register(r'df-users', views.DFUserViewSet, base_name='df-users')
+router.register(r'ff-users', views.FilterFieldsUserViewSet, base_name='ff-users')
 router.register(r'users', views.UserViewSet,)
 router.register(r'notes', views.NoteViewSet,)
 

tests/testapp/views.py

@@ -16,6 +16,15 @@ class DFUserViewSet(viewsets.ModelViewSet):
     filter_class = DFUserFilter
 
 
+class FilterFieldsUserViewSet(viewsets.ModelViewSet):
+    queryset = User.objects.all()
+    serializer_class = UserSerializer
+    filter_backends = (backends.DjangoFilterBackend, )
+    filter_fields = {
+        'username': '__all__',
+    }
+
+
 class UserViewSet(viewsets.ModelViewSet):
     queryset = User.objects.all()
     serializer_class = UserSerializer