rename to multi-year

Author: wschoonveld

decoimpact/business/entities/rules/time_aggregation_rule.py

@@ -35,31 +35,33 @@ def __init__(
         name: str,
         input_variable_names: List[str],
         operation_type: TimeOperationType,
-        start_year: Optional[int] = None,
-        end_year: Optional[int] = None,
+        multi_year_start: Optional[int] = None,
+        multi_year_end: Optional[int] = None,
     ):
+        # pylint: disable=too-many-arguments
+        # pylint: disable=too-many-parameters
         super().__init__(name, input_variable_names)
         self._settings = TimeOperationSettings({"month": "ME", "year": "YE"})
         self._settings.percentile_value = 0
         self._settings.operation_type = operation_type
         self._settings.time_scale = "year"
-        self._start_year = start_year
-        self._end_year = end_year
+        self._multi_year_start = multi_year_start
+        self._multi_year_end = multi_year_end
 
     @property
     def settings(self):
         """Time operation settings"""
         return self._settings
 
     @property
-    def start_year(self) -> Optional[int]:
+    def multi_year_start(self) -> Optional[int]:
         """Start year for the aggregation (inclusive)"""
-        return self._start_year
+        return self._multi_year_start
 
     @property
-    def end_year(self) -> Optional[int]:
+    def multi_year_end(self) -> Optional[int]:
         """End year for the aggregation (inclusive)"""
-        return self._end_year
+        return self._multi_year_end
 
     def validate(self, logger: ILogger) -> bool:
         """Validates if the rule is valid
@@ -77,8 +79,10 @@ def filter_years(
         Args:
             value_array (DataArray): value to filter
         """
-        start = str(self._start_year) if self._start_year is not None else None
-        end = str(self._end_year) if self._end_year is not None else None
+        start = (
+            str(self._multi_year_start) if self._multi_year_start is not None else None
+        )
+        end = str(self._multi_year_end) if self._multi_year_end is not None else None
         slice_obj = slice(start, end)
         return value_array.sel({time_dim_name: slice_obj})
 

decoimpact/data/api/i_time_aggregation_rule_data.py

@@ -45,10 +45,10 @@ def time_scale(self) -> str:
 
     @property
     @abstractmethod
-    def start_year(self) -> Optional[int]:
+    def multi_year_start(self) -> Optional[int]:
         """Start year for the aggregation (inclusive)"""
 
     @property
     @abstractmethod
-    def end_year(self) -> Optional[int]:
+    def multi_year_end(self) -> Optional[int]:
         """End year for the aggregation (inclusive)"""

decoimpact/data/entities/time_aggregation_rule_data.py

@@ -27,28 +27,29 @@ def __init__(
         name: str,
         input_variable: str,
         operation: TimeOperationType,
-        start_year: Optional[int] = None,
-        end_year: Optional[int] = None,
+        multi_year_start: Optional[int] = None,
+        multi_year_end: Optional[int] = None,
     ):
         # pylint: disable=too-many-arguments
+        # pylint: disable=too-many-parameters
         super().__init__(name, operation)
         self._name = name
         self._input_variable = input_variable
         self._operation = operation
-        self._start_year = start_year
-        self._end_year = end_year
+        self._multi_year_start = multi_year_start
+        self._multi_year_end = multi_year_end
 
     @property
     def input_variable(self) -> str:
         """Name of the input variable"""
         return self._input_variable
 
     @property
-    def start_year(self) -> Optional[int]:
+    def multi_year_start(self) -> Optional[int]:
         """Start year for aggregation"""
-        return self._start_year
+        return self._multi_year_start
 
     @property
-    def end_year(self) -> Optional[int]:
+    def multi_year_end(self) -> Optional[int]:
         """End year for aggregation"""
-        return self._end_year
+        return self._multi_year_end

tests/business/entities/rules/test_time_aggregation_rule.py

@@ -472,8 +472,8 @@ def test_multi_yearly_month_average_with_year_range():
         name="test",
         input_variable_names=["foo"],
         operation_type=TimeOperationType.MULTI_YEAR_MONTHLY_AVERAGE,
-        start_year=2020,
-        end_year=2020,
+        multi_year_start=2020,
+        multi_year_end=2020,
     )
     rule.settings.time_scale = "month"