Merge branch 'master' into fix-filter-complexity

Conflicts:
	rest_framework_filters/filters.py
	rest_framework_filters/filterset.py
	rest_framework_filters/tests.py

Author: Ryan P Kilby

.travis.yml

@@ -12,7 +12,6 @@ env:
   - DJANGO="Django>=1.8,<1.9"
 install:
   - travis_retry pip install -q $DJANGO
-  - pip install py-dateutil
   - python setup.py install
 script: python manage.py test rest_framework_filters
 

rest_framework_filters/fields.py

@@ -1,5 +1,11 @@
 from django import forms
 
+
+# https://code.djangoproject.com/ticket/19917
+class Django14TimeField(forms.TimeField):
+    input_formats = ['%H:%M:%S', '%H:%M:%S.%f', '%H:%M']
+
+
 class ArrayDecimalField(forms.DecimalField):
     def clean(self, value):
         if value is None:
@@ -9,3 +15,14 @@ def clean(self, value):
         for val in value.split(','):
             out.append(super(ArrayDecimalField, self).clean(val))
         return out
+
+
+class ArrayCharField(forms.CharField):
+    def clean(self, value):
+        if value is None:
+            return None
+
+        out = []
+        for val in value.split(','):
+            out.append(super(ArrayCharField, self).clean(val))
+        return out

rest_framework_filters/filters.py

@@ -4,8 +4,7 @@
 from collections import OrderedDict
 from django.utils import six
 
-from rest_framework.settings import api_settings
-import django_filters
+import django
 from django_filters.filters import *
 
 from . import fields
@@ -17,35 +16,6 @@ def _import_class(path):
     return getattr(module, class_name)
 
 
-def subsitute_iso8601(date_type):
-    from rest_framework import ISO_8601
-
-    if date_type == 'datetime':
-        strptime_iso8601 = '%Y-%m-%dT%H:%M:%S.%f'
-        formats = api_settings.DATETIME_INPUT_FORMATS
-    elif date_type == 'date':
-        strptime_iso8601 = '%Y-%m-%d'
-        formats = api_settings.DATE_INPUT_FORMATS
-    elif date_type == 'time':
-        strptime_iso8601 = '%H:%M:%S.%f'
-        formats = api_settings.TIME_INPUT_FORMATS
-
-    new_formats = []
-    for f in formats:
-        if f == ISO_8601:
-            new_formats.append(strptime_iso8601)
-        else:
-            new_formats.append(f)
-    return new_formats
-
-
-# In order to support ISO-8601 -- which is the default output for
-# DRF -- we need to set up custom date/time input formats.
-TIME_INPUT_FORMATS = subsitute_iso8601('time')
-DATE_INPUT_FORMATS = subsitute_iso8601('date')
-DATETIME_INPUT_FORMATS = subsitute_iso8601('datetime')
-
-
 class RelatedFilter(ModelChoiceFilter):
     def __init__(self, filterset, *args, **kwargs):
         self.filterset = filterset
@@ -97,27 +67,12 @@ class AllLookupsFilter(Filter):
 # Fixed-up versions of some of the default filters
 ###################################################
 
-class DateFilter(django_filters.DateFilter):
-    def __init__(self, *args, **kwargs):
-        super(DateFilter, self).__init__(*args, **kwargs)
-        self.extra.update({'input_formats': DATE_INPUT_FORMATS})
-
-
-class DateTimeFilter(django_filters.DateTimeFilter):
-    def __init__(self, *args, **kwargs):
-        super(DateTimeFilter, self).__init__(*args, **kwargs)
-        self.extra.update({'input_formats': DATETIME_INPUT_FORMATS})
-
+class TimeFilter(TimeFilter):
+    if django.VERSION < (1, 6):
+        field_class = fields.Django14TimeField
 
-class TimeFilter(django_filters.DateTimeFilter):
-    def __init__(self, *args, **kwargs):
-        super(TimeFilter, self).__init__(*args, **kwargs)
-        self.extra.update({'input_formats': TIME_INPUT_FORMATS})
-
-
-class InSetNumberFilter(NumberFilter):
-    field_class = fields.ArrayDecimalField
 
+class InSetFilterBase(object):
     def filter(self, qs, value):
         if value in ([], (), {}, None, ''):
             return qs
@@ -126,3 +81,11 @@ def filter(self, qs, value):
         if self.distinct:
             qs = qs.distinct()
         return qs
+
+
+class InSetNumberFilter(InSetFilterBase, NumberFilter):
+    field_class = fields.ArrayDecimalField
+
+
+class InSetCharFilter(InSetFilterBase, NumberFilter):
+    field_class = fields.ArrayCharField

rest_framework_filters/filterset.py

@@ -54,15 +54,16 @@ def __new__(cls, name, bases, attrs):
 
 
 class FilterSet(six.with_metaclass(FilterSetMetaclass, filterset.FilterSet)):
-    # In order to support ISO-8601 -- which is the default output for
-    # DRF -- we need to set up custom date/time input formats.
     filter_overrides = {
+
+        # In order to support ISO-8601 -- which is the default output for
+        # DRF -- we need to use django-filter's IsoDateTimeFilter
         models.DateTimeField: {
-            'filter_class': filters.DateTimeFilter,
-        }, 
-        models.DateField: {
-            'filter_class': filters.DateFilter,
-        }, 
+            'filter_class': filters.IsoDateTimeFilter,
+        },
+
+        # Django < 1.6 time input formats did not account for microseconds
+        # https://code.djangoproject.com/ticket/19917
         models.TimeField: {
             'filter_class': filters.TimeFilter,
         },
@@ -183,6 +184,8 @@ def fix_filter_field(cls, f):
         lookup_type = f.lookup_type
         if lookup_type == 'isnull':
             return filters.BooleanFilter(name=("%s%sisnull" % (f.name, LOOKUP_SEP)))
-        if lookup_type == 'in' and type(f) in [filters.NumberFilter]:
+        if lookup_type == 'in' and type(f) == filters.NumberFilter:
             return filters.InSetNumberFilter(name=("%s%sin" % (f.name, LOOKUP_SEP)))
+        if lookup_type == 'in' and type(f) == filters.CharFilter:
+            return filters.InSetCharFilter(name=("%s%sin" % (f.name, LOOKUP_SEP)))
         return f

rest_framework_filters/tests.py

@@ -5,8 +5,9 @@
 import time
 import datetime
 
-from dateutil.parser import parse as date_parse
+from django.utils.dateparse import parse_time, parse_datetime
 
+import django
 from django.db import models
 from django.test import TestCase
 from django.contrib.auth.models import User
@@ -16,6 +17,12 @@
 from .filterset import FilterSet
 from .backends import DjangoFilterBackend
 
+try:
+    from django.test import override_settings
+except ImportError:
+    # TODO: Remove this once Django 1.6 is EOL.
+    from django.test.utils import override_settings
+
 
 class Note(models.Model):
     title = models.CharField(max_length=100)
@@ -231,14 +238,34 @@ class ExplicitLookupsPersonDateFilter(FilterSet):
     class Meta:
         model = Person
 
-class InSetLookupPersonFilter(FilterSet):
+
+class InSetLookupPersonIDFilter(FilterSet):
     pk = AllLookupsFilter('id')
 
     class Meta:
         model = Person
 
+
+class InSetLookupPersonNameFilter(FilterSet):
+    name = AllLookupsFilter('name')
+
+    class Meta:
+        model = Person
+
+
 class TestFilterSets(TestCase):
-    def setUp(self):
+
+    if django.VERSION >= (1, 8):
+        @classmethod
+        def setUpTestData(cls):
+            cls.generateTestData()
+
+    else:
+        def setUp(self):
+            self.generateTestData()
+
+    @classmethod
+    def generateTestData(cls):
         #######################
         # Create users
         #######################
@@ -262,7 +289,7 @@ def setUp(self):
         n.save()
 
         #######################
-        # Create notes 
+        # Create notes
         #######################
         n = Note(
             title="Test 2",
@@ -286,7 +313,7 @@ def setUp(self):
         n.save()
 
         #######################
-        # Create posts 
+        # Create posts
         #######################
         post = Post(
             note=Note.objects.get(title="Test 1"),
@@ -360,7 +387,7 @@ def setUp(self):
         )
         blogpost.save()
         blogpost.tags = [Tag.objects.get(name="house")]
-       
+
         ################################
         # Recursive relations
         ################################
@@ -600,10 +627,10 @@ class Meta:
         date_str = JSONRenderer().render(data['date_joined']).decode('utf-8').strip('"')
 
         # Adjust for imprecise rendering of time
-        datetime_str = JSONRenderer().render(date_parse(data['datetime_joined']) + datetime.timedelta(seconds=0.6)).decode('utf-8').strip('"')
+        datetime_str = JSONRenderer().render(parse_datetime(data['datetime_joined']) + datetime.timedelta(seconds=0.6)).decode('utf-8').strip('"')
 
         # Adjust for imprecise rendering of time
-        dt = datetime.datetime.combine(datetime.date.today(), date_parse(data['time_joined']).time()) + datetime.timedelta(seconds=0.6)
+        dt = datetime.datetime.combine(datetime.date.today(), parse_time(data['time_joined'])) + datetime.timedelta(seconds=0.6)
         time_str = JSONRenderer().render(dt.time()).decode('utf-8').strip('"')
 
         # DateField
@@ -632,14 +659,43 @@ class Meta:
         p = list(f)[0]
         self.assertEqual(p.name, "John")
 
-    def test_inset_filter(self):
+    @override_settings(USE_TZ=True)
+    def test_datetime_timezone_awareness(self):
+        # Addresses issue #24 - ensure that datetime strings terminating
+        # in 'Z' are correctly handled.
+        from rest_framework import serializers
+        from rest_framework.renderers import JSONRenderer
+
+        class PersonSerializer(serializers.ModelSerializer):
+            class Meta:
+                model = Person
+
+        # Figure out what the date strings should look like based on the
+        # serializer output.
+        john = Person.objects.get(name="John")
+        data = PersonSerializer(john).data
+        datetime_str = JSONRenderer().render(parse_datetime(data['datetime_joined']) + datetime.timedelta(seconds=0.6)).decode('utf-8').strip('"')
+
+        # This is more for documentation - DRF appends a 'Z' to timezone aware UTC datetimes when rendering:
+        # https://github.com/tomchristie/django-rest-framework/blob/3.2.0/rest_framework/fields.py#L1002-L1006
+        self.assertTrue(datetime_str.endswith('Z'))
+
+        GET = {
+            'datetime_joined__lte': datetime_str,
+        }
+        f = AllLookupsPersonDateFilter(GET, queryset=Person.objects.all())
+        self.assertEqual(len(list(f)), 1)
+        p = list(f)[0]
+        self.assertEqual(p.name, "John")
+
+    def test_inset_number_filter(self):
         p1 = Person.objects.get(name="John").pk
         p2 = Person.objects.get(name="Mark").pk
 
         ALL_GET = {
             'pk__in': '{:d},{:d}'.format(p1, p2),
         }
-        f = InSetLookupPersonFilter(ALL_GET, queryset=Person.objects.all())
+        f = InSetLookupPersonIDFilter(ALL_GET, queryset=Person.objects.all())
         f = [x.pk for x in f]
         self.assertEqual(len(f), 2)
         self.assertIn(p1, f)
@@ -649,13 +705,13 @@ def test_inset_filter(self):
         INVALID_GET = {
             'pk__in': '{:d},c{:d}'.format(p1, p2)
         }
-        f = InSetLookupPersonFilter(INVALID_GET, queryset=Person.objects.all())
+        f = InSetLookupPersonIDFilter(INVALID_GET, queryset=Person.objects.all())
         self.assertEqual(len(list(f)), 0)
 
         EXTRA_GET = {
             'pk__in': '{:d},{:d},{:d}'.format(p1, p2, p1*p2)
         }
-        f = InSetLookupPersonFilter(EXTRA_GET, queryset=Person.objects.all())
+        f = InSetLookupPersonIDFilter(EXTRA_GET, queryset=Person.objects.all())
         f = [x.pk for x in f]
         self.assertEqual(len(f), 2)
         self.assertIn(p1, f)
@@ -664,7 +720,7 @@ def test_inset_filter(self):
         DISORDERED_GET = {
             'pk__in': '{:d},{:d},{:d}'.format(p2, p2*p1, p1)
         }
-        f = InSetLookupPersonFilter(DISORDERED_GET, queryset=Person.objects.all())
+        f = InSetLookupPersonIDFilter(DISORDERED_GET, queryset=Person.objects.all())
         f = [x.pk for x in f]
         self.assertEqual(len(f), 2)
         self.assertIn(p1, f)
@@ -680,3 +736,40 @@ def test_get_filterset_subset(self):
         # ensure that the FilterSet subset only contains the requested fields
         self.assertIn('email', filterset_class.base_filters)
         self.assertEqual(len(filterset_class.base_filters), 1)
+
+    def test_inset_char_filter(self):
+        p1 = Person.objects.get(name="John").name
+        p2 = Person.objects.get(name="Mark").name
+
+        ALL_GET = {
+            'name__in': '{},{}'.format(p1, p2),
+        }
+        f = InSetLookupPersonNameFilter(ALL_GET, queryset=Person.objects.all())
+        f = [x.name for x in f]
+        self.assertEqual(len(f), 2)
+        self.assertIn(p1, f)
+        self.assertIn(p2, f)
+
+        NONEXISTENT_GET = {
+            'name__in': '{},Foo{}'.format(p1, p2)
+        }
+        f = InSetLookupPersonNameFilter(NONEXISTENT_GET, queryset=Person.objects.all())
+        self.assertEqual(len(list(f)), 1)
+
+        EXTRA_GET = {
+            'name__in': '{},{},{}'.format(p1, p2, p1+p2)
+        }
+        f = InSetLookupPersonNameFilter(EXTRA_GET, queryset=Person.objects.all())
+        f = [x.name for x in f]
+        self.assertEqual(len(f), 2)
+        self.assertIn(p1, f)
+        self.assertIn(p2, f)
+
+        DISORDERED_GET = {
+            'name__in': '{},{},{}'.format(p2, p2+p1, p1)
+        }
+        f = InSetLookupPersonNameFilter(DISORDERED_GET, queryset=Person.objects.all())
+        f = [x.name for x in f]
+        self.assertEqual(len(f), 2)
+        self.assertIn(p1, f)
+        self.assertIn(p2, f)