Deprecate 'in' lookup filters & fields

Author: Ryan P Kilby

rest_framework_filters/fields.py

@@ -1,4 +1,7 @@
+
+import warnings
 from django import forms
+
 from django_filters.widgets import BooleanWidget
 
 
@@ -7,6 +10,14 @@ class BooleanField(forms.BooleanField):
 
 
 class ArrayDecimalField(forms.DecimalField):
+    def __init__(self, *args, **kwargs):
+        super(ArrayDecimalField, self).__init__(*args, **kwargs)
+        warnings.warn(
+            'ArrayDecimalField is deprecated and no longer necessary. See: '
+            'https://github.com/philipn/django-rest-framework-filters/issues/62',
+            DeprecationWarning, stacklevel=3
+        )
+
     def clean(self, value):
         if value is None:
             return None
@@ -18,6 +29,14 @@ def clean(self, value):
 
 
 class ArrayCharField(forms.CharField):
+    def __init__(self, *args, **kwargs):
+        super(ArrayCharField, self).__init__(*args, **kwargs)
+        warnings.warn(
+            'ArrayCharField is deprecated and no longer necessary. See: '
+            'https://github.com/philipn/django-rest-framework-filters/issues/62',
+            DeprecationWarning, stacklevel=3
+        )
+
     def clean(self, value):
         if value is None:
             return None

rest_framework_filters/filters.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 from __future__ import unicode_literals
 
+import warnings
 from django.utils import six
 
 from django_filters.filters import *
@@ -60,10 +61,26 @@ class BooleanFilter(BooleanFilter):
 class InSetNumberFilter(Filter):
     field_class = fields.ArrayDecimalField
 
+    def __init__(self, *args, **kwargs):
+        super(InSetNumberFilter, self).__init__(*args, **kwargs)
+        warnings.warn(
+            'InSetNumberFilter is deprecated and no longer necessary. See: '
+            'https://github.com/philipn/django-rest-framework-filters/issues/62',
+            DeprecationWarning, stacklevel=2
+        )
+
 
 class InSetCharFilter(Filter):
     field_class = fields.ArrayCharField
 
+    def __init__(self, *args, **kwargs):
+        super(InSetCharFilter, self).__init__(*args, **kwargs)
+        warnings.warn(
+            'InSetCharFilter is deprecated and no longer necessary. See: '
+            'https://github.com/philipn/django-rest-framework-filters/issues/62',
+            DeprecationWarning, stacklevel=2
+        )
+
 
 class MethodFilter(Filter):
     """

tests/test_deprecations.py

@@ -99,3 +99,38 @@ class Meta:
                     fields = ['last_login']
 
             self.assertEqual(len(w), 0)
+
+
+class InLookupDeprecationTests(TestCase):
+
+    def test_char_filter_deprecations(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+
+            class F(FilterSet):
+                username__in = filters.InSetCharFilter(name='username', lookup_expr='in')
+
+                class Meta:
+                    model = User
+
+            self.assertEqual(len(w), 1)
+
+            # Generate another warning for field
+            F({'username__in': 'a'}).qs
+            self.assertEqual(len(w), 2)
+
+    def test_number_filter_deprecations(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+
+            class F(FilterSet):
+                id__in = filters.InSetNumberFilter(name='id', lookup_expr='in')
+
+                class Meta:
+                    model = User
+
+            self.assertEqual(len(w), 1)
+
+            # Generate another warning for field
+            F({'id__in': '1'}).qs
+            self.assertEqual(len(w), 2)