Merge pull request #37 from cyiallou/fix/flake8-fixes

Fix flake8 issues

Author: cyiallou

src/frequenz/lib/notebooks/solar/maintenance/data_fetch.py

@@ -380,6 +380,10 @@ def _handle_outliers(
 
     Returns:
         The reporting data after outlier detection and replacement.
+
+    Raises:
+        TypeError: If the bounds, method, or method_params are not of the
+            expected type.
     """
     message_1 = (
         "Columns that denote power values (will use these for outlier detection): "
@@ -393,10 +397,12 @@ def _handle_outliers(
     bounds = params.get("bounds", (0.0, 0.0))
     method = params.get("method", "")
     method_params = params.get("params", {})
-    # sanity checks
-    assert isinstance(bounds, tuple)
-    assert isinstance(method, str)
-    assert isinstance(method_params, dict)
+    if not isinstance(bounds, tuple):
+        raise TypeError("bounds must be a tuple")
+    if not isinstance(method, str):
+        raise TypeError("method must be a string")
+    if not isinstance(method_params, dict):
+        raise TypeError("method_params must be a dictionary")
     data = outlier_removal(
         data=data,
         columns=power_column_labels,

src/frequenz/lib/notebooks/solar/maintenance/data_processing.py

@@ -135,12 +135,13 @@ def parse_unit(unit_str: str) -> tuple[float, str]:
     time_diff_seconds_series = time_diff_seconds_arr[
         time_diff_seconds_arr.notna() & (time_diff_seconds_arr != 0)
     ]
-    try:
-        assert (
-            time_diff_seconds_series.nunique() == 1
-        ), "Time differences are not constant. Taking the most frequent value."
+    if time_diff_seconds_series.nunique() == 1:
         time_diff_seconds = time_diff_seconds_series.values[0]
-    except AssertionError:
+    else:
+        warnings.warn(
+            "Detected multiple unique time differences; this may indicate inconsistent "
+            "timestamps. Falling back to the mode of the time differences."
+        )
         time_diff_seconds = time_diff_seconds_series.mode()[0]
     for unit in energy_units:
         energy_factor, base_unit = parse_unit(unit)

src/frequenz/lib/notebooks/solar/maintenance/models.py

@@ -250,6 +250,9 @@ def sampled_moving_average(
         prediction (i.e. the moving average) corresponding to the ground truth
         does not include the ground truth itself. This can be achieved by
         shifting the Series by sampling_interval.
+
+    Raises:
+        TypeError: If the output is not a pandas Series.
     """
     sampling_interval = abs(int(sampling_interval))
     data_index = pd.to_datetime(data.index).to_series()
@@ -270,7 +273,8 @@ def sampled_moving_average(
     ).apply(lambda x: x[::sampling_interval].mean(), raw=True)
     if isinstance(predictions, pd.DataFrame):
         predictions = predictions.squeeze()
-        assert isinstance(predictions, pd.Series)  # for type checker
+        if not isinstance(predictions, pd.Series):
+            raise TypeError("Output is not a pandas Series.")
     predictions.name = "predictions"
     return predictions
 
@@ -303,7 +307,8 @@ def naive_efficiency_factor_irr_to_power(  # pylint: disable=too-many-arguments
         A pandas Series containing the predicted power (in kilo-Watts) output.
 
     Raises:
-        ValueError: If the input dataframe contains duplicate index entries.
+        ValueError: If the input dataframe contains duplicate index entries or
+            if the validity_ts is not unique.
     """
     data_copy = data.copy(deep=True)
     data_copy.sort_values(by=["creation_ts", "validity_ts"], inplace=True)
@@ -319,9 +324,8 @@ def naive_efficiency_factor_irr_to_power(  # pylint: disable=too-many-arguments
         to_include.loc[to_include.index[position + 1 :]] = True
     data_copy = data_copy[to_include]
 
-    assert (
-        data_copy.validity_ts.nunique() == data_copy.validity_ts.count()
-    ), "validity_ts is not unique"
+    if data_copy.validity_ts.nunique() != data_copy.validity_ts.count():
+        raise ValueError("validity_ts is not unique")
     data_copy.set_index("validity_ts", inplace=True)
     data_copy.index.name = "timestamp"
     if resample_rate:
@@ -450,6 +454,9 @@ def _get_pvgis_hourly(
         Returns:
             A pandas DataFrame containing the hourly data.
 
+        Raises:
+            ValueError: If the minute values in the index are not unique.
+
         References:
         - https://pvlib-python.readthedocs.io/en/stable/reference/generated/
         pvlib.iotools.get_pvgis_hourly.html
@@ -462,7 +469,8 @@ def _get_pvgis_hourly(
             raddatabase="PVGIS-SARAH2",
             url="https://re.jrc.ec.europa.eu/api/v5_2/",
         )
-        assert pvgis_df.index.minute.nunique() == 1  # sanity check
+        if pvgis_df.index.minute.nunique() != 1:
+            raise ValueError("Minute values in the index are not unique.")
         pvgis_df.index = pvgis_df.index - pd.Timedelta(
             minutes=pvgis_df.index.minute.unique()[0]
         )

src/frequenz/lib/notebooks/solar/maintenance/plot_manager.py

@@ -562,13 +562,19 @@ def _update_axes_legends(
             axs: List of matplotlib Axes objects.
             modifications: A dictionary containing modifications.
             **legend_kwargs: Additional keyword arguments for the legend function.
+
+        Raises:
+            TypeError: If the inputs are invalid.
         """
         additional_items, remove_label, replace_label = self._get_modifications(
             modifications
         )
-        assert self._is_additional_items_type(additional_items)
-        assert self._is_text_modification_type(remove_label)
-        assert self._is_replace_label_type(replace_label)
+        if not self._is_additional_items_type(additional_items):
+            raise TypeError("additional_items must be of type AdditionalItemsType")
+        if not self._is_text_modification_type(remove_label):
+            raise TypeError("remove_label must be of type TextModificationType")
+        if not self._is_replace_label_type(replace_label):
+            raise TypeError("replace_label must be of type ReplaceLabelType")
 
         for i, ax in enumerate(axs):
             handles, labels = ax.get_legend_handles_labels()
@@ -602,13 +608,19 @@ def _update_figure_legend(
             axs: List of matplotlib Axes objects.
             modifications: A dictionary containing modifications.
             **legend_kwargs: Additional keyword arguments for the legend function.
+
+        Raises:
+            TypeError: If the inputs are invalid.
         """
         additional_items, remove_label, replace_label = self._get_modifications(
             modifications
         )
-        assert self._is_additional_items_type(additional_items)
-        assert self._is_text_modification_type(remove_label)
-        assert self._is_replace_label_type(replace_label)
+        if not self._is_additional_items_type(additional_items):
+            raise TypeError("additional_items must be of type AdditionalItemsType")
+        if not self._is_text_modification_type(remove_label):
+            raise TypeError("remove_label must be of type TextModificationType")
+        if not self._is_replace_label_type(replace_label):
+            raise TypeError("replace_label must be of type ReplaceLabelType")
 
         all_handles, all_labels = [], []
         for ax in axs:

src/frequenz/lib/notebooks/solar/maintenance/solar_maintenance_app.py

@@ -90,6 +90,8 @@ async def run_workflow(
                 This is not an issue in this version because the column labels
                 (i.e. `short_term_view_col_to_plot` and
                 `stat_profile_view_col_to_plot`) are hardcoded.
+            - If the timezone of the data does not match the timezone in the
+                configuration.
     """
     config, all_client_site_info = _load_and_validate_config(user_config_changes)
 
@@ -221,7 +223,8 @@ async def run_workflow(
             )
             normalisation_factor = 1
         timezone = str(pd.to_datetime(data.index).tzinfo)
-        assert timezone == config.time_zone.key, "Timezone mismatch."  # sanity check
+        if timezone != config.time_zone.key:
+            raise ValueError("Timezone mismatch.")
 
         pv_system = None
         if "simulation" in config.baseline_models:

tests/test_config.py

@@ -160,6 +160,10 @@ def _assert_optional_field(value: float | None, expected: float) -> None:
     Args:
         value: The optional field value to check.
         expected: The expected value to assert if `value` is not None.
+
+    Raises:
+        AssertionError: If `value` is not None and does not match `expected`.
     """
     if value is not None:
-        assert value == expected
+        if value != expected:
+            raise AssertionError(f"Expected {expected}, got {value}")