Allow None to be used as format_query_date() input

julianblue · Jun 26, 2018 · e421a54 · e421a54
1 parent f974c2e
commit e421a54
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/sentinelsat/sentinel.py b/sentinelsat/sentinel.py
@@ -842,9 +842,29 @@ def ensure_2d(geometry):
 
 
 def format_query_date(in_date):
-    """Format a date, datetime or a YYYYMMDD string input as YYYY-MM-DDThh:mm:ssZ
-    or validate a string input as suitable for the full text search interface and return it.
     """
+    Format a date, datetime or a YYYYMMDD string input as YYYY-MM-DDThh:mm:ssZ
+    or validate a date string as suitable for the full text search interface and return it.
+
+    `None` will be converted to '\*', meaning an unlimited date bound in date ranges.
+
+    Parameters
+    ----------
+    in_date : str or datetime or date or None
+        Date to be formatted
+
+    Returns
+    -------
+    str
+        Formatted string
+
+    Raises
+    ------
+    ValueError
+        If the input date type is incorrect or passed date string is invalid
+    """
+    if in_date is None:
+        return '*'
     if isinstance(in_date, (datetime, date)):
         return in_date.strftime('%Y-%m-%dT%H:%M:%SZ')
     elif not isinstance(in_date, string_types):

diff --git a/tests/test_mod.py b/tests/test_mod.py
@@ -60,6 +60,7 @@ def test_format_date():
     assert format_query_date('2015-01-01T00:00:00Z') == '2015-01-01T00:00:00Z'
     assert format_query_date('20150101') == '2015-01-01T00:00:00Z'
     assert format_query_date(' NOW ') == 'NOW'
+    assert format_query_date(None) == '*'
 
     api = SentinelAPI(**_api_auth)
     for date_str in ("NOW", "NOW-1DAY", "NOW-1DAYS", "NOW-500DAY", "NOW-500DAYS",