Merge pull request #31 from rpkilby/24-isodatetimezones

Fix timezone-aware datetime handling (#24)

Author: philipn

.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:

rest_framework_filters/filters.py

@@ -1,43 +1,12 @@
 from __future__ import absolute_import
 from __future__ import unicode_literals
 
+import django
 from django.utils import six
-
-from rest_framework.settings import api_settings
-import rest_framework.filters
-import django_filters
 from django_filters.filters import *
 
 from . import fields
 
-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):
@@ -50,7 +19,7 @@ def setup_filterset(self):
             # This is a recursive relation, defined via a string, so we need
             # to create and import the class here.
             items = self.filterset.split('.')
-            cls = str(items[-1]) # Ensure not unicode on py2.x
+            cls = str(items[-1])  # Ensure not unicode on py2.x
             mod = __import__('.'.join(items[:-1]), fromlist=[cls])
             self.filterset = getattr(mod, cls)
 
@@ -65,22 +34,9 @@ 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(django_filters.DateTimeFilter):
-    def __init__(self, *args, **kwargs):
-        super(TimeFilter, self).__init__(*args, **kwargs)
-        self.extra.update({'input_formats': TIME_INPUT_FORMATS})
+class TimeFilter(TimeFilter):
+    if django.VERSION < (1, 6):
+        field_class = fields.Django14TimeField
 
 
 class InSetNumberFilter(NumberFilter):

rest_framework_filters/filterset.py

@@ -24,18 +24,19 @@
 
 
 class FilterSet(django_filters.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,
-        },
+        }
     }
 
     LOOKUP_TYPES = django_filters.filters.LOOKUP_TYPES
@@ -68,7 +69,7 @@ def __init__(self, *args, **kwargs):
 
     def fix_filter_field(self, f):
         """
-        Fix the filter field based on the lookup type. 
+        Fix the filter field based on the lookup type.
         """
         lookup_type = f.lookup_type
         if lookup_type == 'isnull':

rest_framework_filters/tests.py

@@ -5,7 +5,7 @@
 import time
 import datetime
 
-from dateutil.parser import parse as date_parse
+from django.utils.dateparse import parse_time, parse_datetime
 
 from django.db import models
 from django.test import TestCase
@@ -16,6 +16,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)
@@ -262,7 +268,7 @@ def setUp(self):
         n.save()
 
         #######################
-        # Create notes 
+        # Create notes
         #######################
         n = Note(
             title="Test 2",
@@ -286,7 +292,7 @@ def setUp(self):
         n.save()
 
         #######################
-        # Create posts 
+        # Create posts
         #######################
         post = Post(
             note=Note.objects.get(title="Test 1"),
@@ -360,7 +366,7 @@ def setUp(self):
         )
         blogpost.save()
         blogpost.tags = [Tag.objects.get(name="house")]
-       
+
         ################################
         # Recursive relations
         ################################
@@ -600,10 +606,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,6 +638,35 @@ class Meta:
         p = list(f)[0]
         self.assertEqual(p.name, "John")
 
+    @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_filter(self):
         p1 = Person.objects.get(name="John").pk
         p2 = Person.objects.get(name="Mark").pk