Add additional lookups to RelatedFilter (#114)

Author: Ryan P Kilby

rest_framework_filters/filters.py

@@ -21,8 +21,9 @@ def _import_class(path):
 
 
 class RelatedFilter(ModelChoiceFilter):
-    def __init__(self, filterset, *args, **kwargs):
+    def __init__(self, filterset, lookups=None, *args, **kwargs):
         self.filterset = filterset
+        self.lookups = lookups
         return super(RelatedFilter, self).__init__(*args, **kwargs)
 
     def filterset():
@@ -45,7 +46,7 @@ def field(self):
 
 
 class AllLookupsFilter(Filter):
-    pass
+    lookups = '__all__'
 
 
 ###################################################

rest_framework_filters/filterset.py

@@ -54,10 +54,18 @@ def __new__(cls, name, bases, attrs):
         # Populate our FilterSet fields with all the possible
         # filters for the AllLookupsFilter field.
         for name, filter_ in six.iteritems(new_class.base_filters.copy()):
-            if isinstance(filter_, filters.AllLookupsFilter):
+            if isinstance(filter_, (filters.AllLookupsFilter, filters.RelatedFilter)):
                 field = filterset.get_model_field(opts.model, filter_.name)
 
-                for lookup_expr in utils.lookups_for_field(field):
+                lookups = filter_.lookups or []
+                if lookups == '__all__':
+                    lookups = utils.lookups_for_field(field)
+
+                for lookup_expr in lookups:
+                    if isinstance(filter_, filters.RelatedFilter) and lookup_expr == 'exact':
+                        # Don't replace the RelatedFilter
+                        continue
+
                     if isinstance(field, ForeignObjectRel):
                         f = new_class.filter_for_reverse_field(field, filter_.name)
                     else:

tests/test_filterset.py

@@ -189,6 +189,29 @@ class Meta:
         self.assertIsInstance(F.base_filters['author'], filters.RelatedFilter)
         self.assertIsInstance(F.base_filters['author__in'], BaseInFilter)
 
+    def test_relatedfilter_lookups(self):
+        # ensure that related filter is compatible with __all__ lookups.
+        class F(FilterSet):
+            author = filters.RelatedFilter(UserFilter, lookups='__all__')
+
+            class Meta:
+                model = Note
+
+        self.assertIsInstance(F.base_filters['author'], filters.RelatedFilter)
+        self.assertIsInstance(F.base_filters['author__in'], BaseInFilter)
+
+    def test_relatedfilter_lookups_list(self):
+        # ensure that related filter is compatible with __all__ lookups.
+        class F(FilterSet):
+            author = filters.RelatedFilter(UserFilter, lookups=['in'])
+
+            class Meta:
+                model = Note
+
+        self.assertEqual(len([f for f in F.base_filters if f.startswith('author')]), 2)
+        self.assertIsInstance(F.base_filters['author'], filters.RelatedFilter)
+        self.assertIsInstance(F.base_filters['author__in'], BaseInFilter)
+
     def test_filter_persistence_with__all__(self):
         # ensure that __all__ does not overwrite declared filters.
         class F(FilterSet):