Changes datetime.date to pandas.Timestamp

Author: spjuhel

climada/trajectories/snapshot.py

@@ -28,6 +28,8 @@
 import logging
 import warnings
 
+import pandas as pd
+
 from climada.entity.exposures import Exposures
 from climada.entity.impact_funcs import ImpactFuncSet
 from climada.entity.measures.base import Measure
@@ -47,10 +49,9 @@ class Snapshot:
     exposure : Exposures
     hazard : Hazard
     impfset : ImpactFuncSet
-    date : int | datetime.date | str
+    date : int | datetime.date | str | pd.Timestamp
         The date of the Snapshot, it can be an integer representing a year,
-        a datetime object or a string representation of a datetime object
-        with format "YYYY-MM-DD".
+        a datetime object or a string representation of a datetime object.
     ref_only : bool, default False
         Should the `Snapshot` contain deep copies of the Exposures, Hazard and Impfset (False)
         or references only (True).
@@ -82,7 +83,7 @@ def __init__(
         hazard: Hazard,
         impfset: ImpactFuncSet,
         measure: Measure | None,
-        date: int | datetime.date | str,
+        date: int | datetime.date | str | pd.Timestamp,
         ref_only: bool = False,
         _from_factory: bool = False,
     ) -> None:
@@ -97,7 +98,7 @@ def __init__(
         self._hazard = hazard if ref_only else copy.deepcopy(hazard)
         self._impfset = impfset if ref_only else copy.deepcopy(impfset)
         self._measure = measure if ref_only else copy.deepcopy(measure)
-        self._date = self._convert_to_date(date)
+        self._date = self._convert_to_timestamp(date)
 
     @classmethod
     def from_triplet(
@@ -106,7 +107,7 @@ def from_triplet(
         exposure: Exposures,
         hazard: Hazard,
         impfset: ImpactFuncSet,
-        date: int | datetime.date | str,
+        date: int | datetime.date | str | pd.Timestamp,
         ref_only: bool = False,
     ) -> "Snapshot":
         """Create a Snapshot from exposure, hazard and impact functions set
@@ -121,7 +122,7 @@ def from_triplet(
         exposure : Exposures
         hazard : Hazard
         impfset : ImpactFuncSet
-        date : int | datetime.date | str
+        date : int | datetime.date | str | pd.Timestamp
         ref_only : bool
             If true, uses references to the exposure, hazard and impact
             function objects. Note that modifying the original objects after
@@ -170,7 +171,7 @@ def measure(self) -> Measure | None:
         return self._measure
 
     @property
-    def date(self) -> datetime.date:
+    def date(self) -> pd.Timestamp:
         """Date of the snapshot."""
         return self._date
 
@@ -184,22 +185,25 @@ def impact_calc_data(self) -> dict:
         }
 
     @staticmethod
-    def _convert_to_date(date_arg) -> datetime.date:
-        """Convert date argument of type int or str to a datetime.date object."""
+    def _convert_to_timestamp(date_arg) -> pd.Timestamp:
+        """Convert date argument of type int or str or datetime.date to pandas Timestamp object."""
         if isinstance(date_arg, int):
             # Assume the integer represents a year
-            return datetime.date(date_arg, 1, 1)
+            return pd.Timestamp(year=date_arg, month=1, day=1)
         if isinstance(date_arg, str):
             # Try to parse the string as a date
             try:
-                return datetime.datetime.strptime(date_arg, "%Y-%m-%d").date()
+                return pd.Timestamp(date_arg)
             except ValueError as exc:
                 raise ValueError("String must be in the format 'YYYY-MM-DD'") from exc
         if isinstance(date_arg, datetime.date):
-            # Already a date object
+            return pd.Timestamp(date_arg)
+        if isinstance(date_arg, pd.Timestamp):
             return date_arg
 
-        raise TypeError("date_arg must be an int, str, or datetime.date")
+        raise TypeError(
+            "date_arg must be an int, str, datetime.date or pandas.Timestamp"
+        )
 
     def apply_measure(self, measure: Measure) -> "Snapshot":
         """Create a new snapshot by applying a Measure object.

climada/trajectories/test/test_snapshot.py

@@ -57,6 +57,7 @@ def mock_context(shared_data):
         "mod_exp": modified_exp,
         "mod_haz": modified_haz,
         "mod_imp": modified_imp,
+        "date": pd.Timestamp(2023),
     }
 
 
@@ -78,9 +79,9 @@ def test_not_from_factory_warning(mock_context):
 @pytest.mark.parametrize(
     "input_date,expected",
     [
-        (2023, datetime.date(2023, 1, 1)),
-        ("2023-01-01", datetime.date(2023, 1, 1)),
-        (datetime.date(2023, 1, 1), datetime.date(2023, 1, 1)),
+        (2023, pd.Timestamp(2023, 1, 1)),
+        ("2023-01-01", pd.Timestamp(2023, 1, 1)),
+        (datetime.date(2023, 1, 1), pd.Timestamp(2023, 1, 1)),
     ],
 )
 def test_init_valid_dates(mock_context, input_date, expected):
@@ -106,7 +107,8 @@ def test_init_invalid_date_format(mock_context):
 
 def test_init_invalid_date_type(mock_context):
     with pytest.raises(
-        TypeError, match=r"date_arg must be an int, str, or datetime.date"
+        TypeError,
+        match=r"date_arg must be an int, str, datetime.date or pandas.Timestamp",
     ):
         Snapshot.from_triplet(exposure=mock_context["exp"], hazard=mock_context["haz"], impfset=mock_context["imp"], date=2023.5)  # type: ignore
 
@@ -116,7 +118,7 @@ def test_properties(mock_context):
         exposure=mock_context["exp"],
         hazard=mock_context["haz"],
         impfset=mock_context["imp"],
-        date=2023,
+        date=mock_context["date"],
     )
 
     # Check that it's a deep copy (new reference)
@@ -129,14 +131,15 @@ def test_properties(mock_context):
     pd.testing.assert_frame_equal(snapshot.exposure.gdf, mock_context["exp"].gdf)
     assert snapshot.hazard.haz_type == mock_context["haz"].haz_type
     assert snapshot.impfset == mock_context["imp"]
+    assert snapshot.date == mock_context["date"]
 
 
 def test_reference(mock_context):
     snapshot = Snapshot.from_triplet(
         exposure=mock_context["exp"],
         hazard=mock_context["haz"],
         impfset=mock_context["imp"],
-        date=2023,
+        date=mock_context["date"],
         ref_only=True,
     )
 
@@ -146,18 +149,13 @@ def test_reference(mock_context):
     assert snapshot.impfset is mock_context["imp"]
     assert snapshot.measure is None
 
-    # Check data equality
-    pd.testing.assert_frame_equal(snapshot.exposure.gdf, mock_context["exp"].gdf)
-    assert snapshot.hazard.haz_type == mock_context["haz"].haz_type
-    assert snapshot.impfset == mock_context["imp"]
-
 
 def test_apply_measure(mock_context):
     snapshot = Snapshot.from_triplet(
         exposure=mock_context["exp"],
         hazard=mock_context["haz"],
         impfset=mock_context["imp"],
-        date=2023,
+        date=mock_context["date"],
     )
     new_snapshot = snapshot.apply_measure(mock_context["measure"])
 
@@ -166,3 +164,4 @@ def test_apply_measure(mock_context):
     assert new_snapshot.exposure == mock_context["mod_exp"]
     assert new_snapshot.hazard == mock_context["mod_haz"]
     assert new_snapshot.impfset == mock_context["mod_imp"]
+    assert new_snapshot.date == mock_context["date"]