let date_range filter handle dates given with and without timezones

Author: Sara Safavi

planet/api/filters.py

@@ -100,8 +100,10 @@ def not_filter(*predicates):
 def date_range(field_name, **kwargs):
     '''Build a DateRangeFilter.
 
-    Predicate arguments accept a value str that in ISO-8601 format or a value
-    that has a `isoformat` callable that returns an ISO-8601 str.
+    Predicate arguments accept a str that is ISO-8601 format or a value
+    that has an `isoformat` callable that returns an ISO-8601 compliant str.
+
+    If no timezone is provided, UTC is assumed for RFC 3339 compatability.
 
     :raises: ValueError if predicate value does not parse
 
@@ -116,7 +118,12 @@ def date_range(field_name, **kwargs):
             dt = strp_lenient(str(v))
             if dt is None:
                 raise ValueError("unable to use provided time: " + str(v))
-        kwargs[k] = dt.isoformat() + 'Z'
+        iso_date = dt.isoformat()
+        if not dt.tzinfo:
+            # assume UTC for datetimes without an explicit timezone
+            # necessary for RFC 3339 vs ISO 8601 compatability
+            iso_date += 'Z'
+        kwargs[k] = iso_date
     return _filter('DateRangeFilter', config=kwargs, field_name=field_name)
 
 

tests/test_filters.py

@@ -0,0 +1,27 @@
+import pytest
+from pytz import timezone
+from datetime import datetime
+from planet.api import filters
+
+
+@pytest.mark.parametrize('dt, expected', [
+    (datetime(1900, 1, 1, tzinfo=timezone("US/Central")),
+     {'field_name': 'acquired',
+      'type': 'DateRangeFilter',
+      'config': {'gte': '1900-01-01T00:00:00-05:51'}}),
+
+    (datetime(1999, 12, 31),
+     {'field_name': 'acquired',
+      'type': 'DateRangeFilter',
+      'config': {'gte': '1999-12-31T00:00:00Z'}}),
+
+    ("2018-01-01",
+     {'field_name': 'acquired',
+      'type': 'DateRangeFilter',
+      'config': {'gte': '2018-01-01T00:00:00Z'}}),
+])
+def test_date_range(dt, expected):
+    fieldname = "acquired"
+    arg = "gte"
+
+    assert filters.date_range(fieldname, **{arg: dt}) == expected