Use only timezones for datetime parser (#108)

take into account the timezone when parsing datetime and getting the time from the computer

conda_environment_test.yaml

@@ -9,3 +9,4 @@ dependencies:
   - syrupy==4.6.1
   - pip:
     - pytest-order==1.2.1
+    - freezegun==1.5.1

copernicusmarine/catalogue_parser/models.py

@@ -375,7 +375,7 @@ def sort_parts(self) -> tuple[Optional[str], Optional[str]]:
             for part in self.parts
             if part.retired_date
         }
-        max_retired_timestamp = 0
+        max_retired_timestamp = 0.0
         if will_be_retired_parts:
             max_retired_timestamp = max(will_be_retired_parts.values()) + 1
         self.parts = sorted(

copernicusmarine/core_functions/utils.py

@@ -2,7 +2,7 @@
 import logging
 import pathlib
 import re
-from datetime import datetime
+from datetime import datetime, timezone
 from importlib.metadata import version
 from typing import (
     Any,
@@ -43,6 +43,13 @@
     "%Y-%m-%d",
     "%Y-%m-%dT%H:%M:%S",
     "%Y-%m-%d %H:%M:%S",
+    "%Y-%m-%dT%H:%M:%S.%f",
+    "%Y-%m-%dT%H:%M:%S.%fZ",
+    "%Y-%m-%d %H:%M:%S.%f%Z",
+]
+
+DATETIME_NON_ISO_FORMATS = [
+    "%Y",
     "%Y-%m-%dT%H:%M:%S.%fZ",
 ]
 
@@ -122,14 +129,23 @@ class WrongDatetimeFormat(Exception):
     ...
 
 
-def datetime_parser(string: str):
+def datetime_parser(string: str) -> datetime:
     if string == "now":
-        return datetime.now()
-    for format in DATETIME_SUPPORTED_FORMATS:
-        try:
-            return datetime.strptime(string, format)
-        except ValueError:
-            pass
+        return datetime.now(tz=timezone.utc).replace(tzinfo=None)
+    try:
+        parsed_datetime = datetime.fromisoformat(string)
+        if parsed_datetime.tzinfo is None:
+            return parsed_datetime
+        else:
+            return parsed_datetime.astimezone(timezone.utc).replace(
+                tzinfo=None
+            )
+    except ValueError:
+        for datetime_format in DATETIME_NON_ISO_FORMATS:
+            try:
+                return datetime.strptime(string, datetime_format)
+            except ValueError:
+                pass
     raise WrongDatetimeFormat(string)
 
 

tests/__snapshots__/test_help_command_interface.ambr

@@ -253,12 +253,12 @@
     '                                  z-axis) as it is in the dataset originally',
     '                                  produced, named `depth` with descending',
     '                                  positive values.  [default: True]',
-    '  -t, --start-datetime [%Y|%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S|%Y-%m-%dT%H:%M:%S.%fZ]',
+    '  -t, --start-datetime [%Y|%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S|%Y-%m-%dT%H:%M:%S.%f|%Y-%m-%dT%H:%M:%S.%fZ|%Y-%m-%d %H:%M:%S.%f%Z]',
     '                                  The start datetime of the temporal subset.',
     '                                  Caution: encapsulate date with " " to ensure',
     '                                  valid expression for format "%Y-%m-%d',
     '                                  %H:%M:%S".',
-    '  -T, --end-datetime [%Y|%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S|%Y-%m-%dT%H:%M:%S.%fZ]',
+    '  -T, --end-datetime [%Y|%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S|%Y-%m-%dT%H:%M:%S.%f|%Y-%m-%dT%H:%M:%S.%fZ|%Y-%m-%d %H:%M:%S.%f%Z]',
     '                                  The end datetime of the temporal subset.',
     '                                  Caution: encapsulate date with " " to ensure',
     '                                  valid expression for format "%Y-%m-%d',

tests/test_utility_functions.py

@@ -0,0 +1,31 @@
+from datetime import datetime
+
+from freezegun import freeze_time
+
+from copernicusmarine.core_functions.utils import datetime_parser
+
+
+class TestUtilityFunctions:
+    @freeze_time("2012-01-14 03:21:34", tz_offset=-2)
+    def test_datetime_parser(self):
+        # all parsed dates are in UTC
+        assert datetime_parser("now") == datetime(2012, 1, 14, 1, 21, 34)
+        assert datetime_parser("2012-01-14T03:21:34.000000+02:00") == datetime(
+            2012, 1, 14, 1, 21, 34
+        )
+
+        # All format are supported
+        assert datetime_parser("2012") == datetime(2012, 1, 1, 0, 0, 0)
+        assert datetime_parser("2012-01-14") == datetime(2012, 1, 14, 0, 0, 0)
+        assert datetime_parser("2012-01-14T03:21:34") == datetime(
+            2012, 1, 14, 3, 21, 34
+        )
+        assert datetime_parser("2012-01-14 03:21:34") == datetime(
+            2012, 1, 14, 3, 21, 34
+        )
+        assert datetime_parser("2012-01-14T03:21:34.000000") == datetime(
+            2012, 1, 14, 3, 21, 34
+        )
+        assert datetime_parser("2012-01-14T03:21:34.000000Z") == datetime(
+            2012, 1, 14, 3, 21, 34
+        )