[Option Appraisal Module] [Package 1: Measures] Split 2: Adds CostIncome class for measure financial aspects management

CHANGELOG.md

@@ -12,10 +12,13 @@ Code freeze date: YYYY-MM-DD
 
 ### Added
 
-- Better type hints and overloads signatures for ImpactFuncSet [#1250](https://github.com/CLIMADA-project/climada_python/pull/1250)
+- Better type hints and overloads signatures for `ImpactFuncSet` [#1250](https://github.com/CLIMADA-project/climada_python/pull/1250)
+- Adds `CostIncome` class and related tutorial for future new `Measure` class. [#1277](https://github.com/CLIMADA-project/climada_python/pull/1277)
+- Adds `MeasureConfig` and related dataclasses for new `Measure` object retrocompatibility and (de)serialization capabilities [#1276](https://github.com/CLIMADA-project/climada_python/pull/1276)
 
 ### Changed
 - Updated Impact Calculation Tutorial (`doc.climada_engine_Impact.ipynb`) [#1095](https://github.com/CLIMADA-project/climada_python/pull/1095).
+- Makes current `measure` module a legacy module, moving it to `_legacy_measure`, to retain compatibility with `CostBenefit` class and various tests. [#1274](https://github.com/CLIMADA-project/climada_python/pull/1274)
 
 ### Fixed
 

climada/engine/test/test_cost_benefit.py

@@ -33,10 +33,10 @@
     risk_rp_100,
     risk_rp_250,
 )
+from climada.entity._legacy_measures import Measure
+from climada.entity._legacy_measures.base import LOGGER as ILOG
 from climada.entity.disc_rates import DiscRates
 from climada.entity.entity_def import Entity
-from climada.entity.measures import Measure
-from climada.entity.measures.base import LOGGER as ILOG
 from climada.hazard.base import Hazard
 from climada.test import get_test_file
 from climada.util.api_client import Client

climada/engine/unsequa/input_var.py

@@ -518,7 +518,7 @@ def ent(
         exp_list : [climada.entity.exposures.base.Exposure]
             The list of base exposure. Can be one or many to uniformly sample
             from.
-        meas_set : climada.entity.measures.measure_set.MeasureSet
+        meas_set : climada.entity._legacy_measures.measure_set.MeasureSet
             The base measures.
         haz_id_dict : dict
             Dictionary of the impact functions affected by uncertainty.
@@ -660,7 +660,7 @@ def entfut(
         exp_list : [climada.entity.exposures.base.Exposure]
             The list of base exposure. Can be one or many to uniformly sample
             from.
-        meas_set : climada.entity.measures.measure_set.MeasureSet
+        meas_set : climada.entity._legacy_measures.measure_set.MeasureSet
             The base measures.
         haz_id_dict : dict
             Dictionary of the impact functions affected by uncertainty.

climada/entity/__init__.py

@@ -19,8 +19,8 @@
 init entity
 """
 
+from ._legacy_measures import *
 from .disc_rates import *
 from .entity_def import *
 from .exposures import *
 from .impact_funcs import *
-from .measures import *

climada/entity/measures/measure_set.py → climada/entity/_legacy_measures/measure_set.py

@@ -32,7 +32,8 @@
 from matplotlib import colormaps as cm
 
 import climada.util.hdf5_handler as u_hdf5
-from climada.entity.measures.base import Measure
+
+from .base import Measure
 
 LOGGER = logging.getLogger(__name__)
 

climada/entity/measures/test/test_base.py → climada/entity/_legacy_measures/test/test_base.py

@@ -28,12 +28,12 @@
 import climada.entity.exposures.test as exposures_test
 import climada.util.coordinates as u_coord
 from climada import CONFIG
+from climada.entity._legacy_measures.base import IMPF_ID_FACT, Measure
+from climada.entity._legacy_measures.measure_set import MeasureSet
 from climada.entity.entity_def import Entity
 from climada.entity.exposures.base import Exposures
 from climada.entity.impact_funcs.base import ImpactFunc
 from climada.entity.impact_funcs.impact_func_set import ImpactFuncSet
-from climada.entity.measures.base import IMPF_ID_FACT, Measure
-from climada.entity.measures.measure_set import MeasureSet
 from climada.hazard.base import Hazard
 from climada.test import get_test_file
 from climada.util.constants import HAZ_DEMO_H5

climada/entity/measures/test/test_meas_set.py → climada/entity/_legacy_measures/test/test_meas_set.py

@@ -24,8 +24,8 @@
 import numpy as np
 
 from climada import CONFIG
-from climada.entity.measures.base import Measure
-from climada.entity.measures.measure_set import MeasureSet
+from climada.entity._legacy_measures.base import Measure
+from climada.entity._legacy_measures.measure_set import MeasureSet
 from climada.util.constants import ENT_DEMO_TODAY, ENT_TEMPLATE_XLS
 
 DATA_DIR = CONFIG.measures.test_data.dir()
@@ -58,7 +58,7 @@ def test_add_wrong_error(self):
         """Test error is raised when wrong ImpactFunc provided."""
         meas = MeasureSet()
         with self.assertLogs(
-            "climada.entity.measures.measure_set", level="WARNING"
+            "climada.entity._legacy_measures.measure_set", level="WARNING"
         ) as cm:
             meas.append(Measure())
         self.assertIn("Input Measure's hazard type not set.", cm.output[0])
@@ -76,7 +76,9 @@ def test_remove_measure_pass(self):
     def test_remove_wrong_error(self):
         """Test error is raised when invalid inputs."""
         meas = MeasureSet(measure_list=[Measure(name="Mangrove", haz_type="FL")])
-        with self.assertLogs("climada.entity.measures.measure_set", level="INFO") as cm:
+        with self.assertLogs(
+            "climada.entity._legacy_measures.measure_set", level="INFO"
+        ) as cm:
             meas.remove_measure(name="Seawall")
         self.assertIn("No Measure with name Seawall.", cm.output[0])
 

climada/entity/entity_def.py

@@ -26,10 +26,10 @@
 
 import pandas as pd
 
+from climada.entity._legacy_measures.measure_set import Measure, MeasureSet
 from climada.entity.disc_rates.base import DiscRates
 from climada.entity.exposures.base import Exposures
 from climada.entity.impact_funcs.impact_func_set import ImpactFuncSet
-from climada.entity.measures.measure_set import MeasureSet
 
 LOGGER = logging.getLogger(__name__)