Increase test coverage (#486)

martin-springer · cdeline · mdeceglie · web-flow · commit 2560977aef07 · 2026-03-05T11:07:59.000-05:00
* add keyword 'label' to degradation_timeseries_plot, enabling 'left' and 'center' labeling options. * Update changelog, add pytests, update sphinx documentation * fix flake8 grumbles * update pytests to include axes limits * fix flake8 grumbles * add 'label' input option to `degradation_year_on_year`. Fixes #459 * add pytests and update changelog. * flake8 grumbles * Minor updates to setup.py (constrain scipy<1.16) and refactor degradation_test * Custom fix for Pandas < 2.0.0 which can't average two columns of timestamps. * flake8 grumbles * keep TZ-aware timestamps. Update pytests to specifically test _avg_timestamp_old_Pandas * flake8 grumbles * try to UTC localize the pytest... * Add .asfreq() to get pytests to agree * switch to calendar.timegm to hopefully remove TZ issues.. * regardless of uncertainty_method, return calc_info{'YoY_values') * update _right dt labels to correct _left labels in degradation_year_on_year * update _avg_timestamp_old_Pandas to allow for numeric index instead of timestamp * add left label option to degradation_year_on_year * update degradation_year_on_year, index set to either left, center or right. Consistent with #394 - multi_yoy * update return for default = none uncertainty option * degradation_year_on_year - go back to single return when uncertainty_value = None to avoid breaking pytests. * add multi-year aggregation of slopes in degradation_year_on_year * add multi_yoy kwarg in degradation_year_on_year to toggle the multi-YoY function. * update plotting for detailed=True, allow usage_of_points > 2 * flake8 grumbles * update plotting detailed=True for (even) and (odd) number of points coloring * To allow multi_yoy=True in plotting.degradation_timeseries_plot, resample.mean() the YoY_values. * flake8 grumbles * Add warning to degradation_timeseries_plot when multi_YoY=True * update to warning message in plotting.degradation_timeseries_plot * fix flake8 grumbles * nbval fixes from qnguyen345-bare_except_error * Add pandas 3.0 futurewarning handling * Try again to solve pandas3.0 futurewarning * attempt 3 to fix nbval * Add infer_objects to remove futurewarning * minor inline comment update * update plotting tests to be relative value, update ordering of module import in plotting.py, per Copilot review. * update inline comments and whatsnew docs * Clean up inline comments per Copilot review * added multi-YoY pytest - still need to catch warnings * Add a warnings.catch_warnings to the plotting pytest * flake8 grumbles * add multi-YoY=True pytest * updated changelog * update changelog * implement copilot suggestions * linting * use s instead of ns for pandas 3 compatibility * update pandas version comparison * set matplotlib non-gui backend for tests * set dtype resolution based on pandas version * linting import order * boost degradation.py test coverage * add tests for error handling in analysis_chain * update changelog * update changelog * exclude coverage reports with suffixes * Update rdtools/degradation.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * remove label=None handling, rely on default 'right' behavior * refactor dt_center tz handling for old pandas * simplify _avg_timestamp_old_Pandas * degradation_timeseries_plot: change rolling median min_periods to rolling_days / 4. * remove degradation_timeseries_plot(label=) and just default to center=True * update sensor_analysis() and clearsky_analysis() docstrings to discuss passing `label=right` kwargs * flake8 updates * Initial commit - multi-YoY notebook * pretty-print notebook dataframes with tabulate. * update notebook requirements to silence pandas warnings * add multi-yoy nb to tutorials * fix nblink path * Change the yoy_values index to be named 'dt'. Add new illustrations at the end of the multi-YoY notebook. * clean up pending changelog --------- Co-authored-by: cdeline <chris.deline@nrel.gov> Co-authored-by: Michael Deceglie <mdeceglie@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
diff --git a/docs/sphinx/source/changelog/pending.rst b/docs/sphinx/source/changelog/pending.rst
@@ -8,7 +8,8 @@ Enhancements
   to return the calc_info['YoY_values'] as either right labeled (default), left or
   center labeled. (:issue:`459`)
 * :py:func:`~rdtools.plotting.degradation_timeseries_plot` now defaults to rolling
-  median, centered on the timestamp (pd.rolling(center=True)).
+  median, centered on the timestamp (pd.rolling(center=True)), and reduces
+  ``min_periods`` from ``rolling_days//2`` to ``rolling_days//4``.
   (:issue:`455`)
 * :py:func:`~rdtools.degradation.degradation_year_on_year` has new parameter ``multi_yoy``
   (default False) to trigger multiple YoY degradation calculations similar to Hugo Quest et
@@ -27,6 +28,9 @@ Enhancements
 * Added new example notebook ``docs/Multi-year_on_year_example.ipynb`` demonstrating the
   ``label='center'`` and ``multi_yoy=True`` features of
   :py:func:`~rdtools.degradation.degradation_year_on_year`.  (:issue:`394`)
+* :py:meth:`~rdtools.analysis_chains.TrendAnalysis.sensor_analysis` and
+  :py:meth:`~rdtools.analysis_chains.TrendAnalysis.clearsky_analysis` now
+  explicitly default ``yoy_kwargs={"label": "right"}``.
 
 Bug Fixes
 ---------
@@ -43,14 +47,24 @@ Maintenance
 * Updated ``docs/notebook_requirements.txt`` to require ``numexpr>=2.10.2`` and
   ``tabulate>=0.9.0`` to satisfy pandas' optional dependency minimum versions and
   avoid related warnings/errors.
+* Removed trailing semicolons in example notebooks.
+* Added ``.coverage.*`` pattern to ``.gitignore``.
 
 Testing
 -------
+* Added tests for error handling paths in :py:mod:`~rdtools.analysis_chains`:
+  ``filter_params`` and ``filter_params_aggregated`` setter validation,
+  ``clearsky_rescale_index_mismatch``, ``poa_filter_without_poa``,
+  ``tcell_filter_without_temperature``, ``hour_angle_filter_without_location``,
+  ``clearsky_filter_without_poa``, and ``degradation_timeseries_plot_invalid_case``.
 * Added tests for error handling paths in :py:mod:`~rdtools.degradation`:
   ``classical_decomposition`` missing/irregular data, ``year_on_year`` circular block
   validation, no valid pairs error, and ``_mk_test`` edge cases (no trend, ties,
   decreasing).
 * Added test for ``multi_yoy=True`` parameter in ``degradation_year_on_year``.
+* Added tests for :py:func:`~rdtools.plotting.degradation_timeseries_plot`
+  covering ``label='center'``, ``label='left'``, multi-YoY duplicate index
+  handling, and ``KeyError`` path.
 * Set matplotlib backend to ``Agg`` in test ``conftest.py`` to avoid tkinter issues.
 
 
diff --git a/rdtools/test/analysis_chains_test.py b/rdtools/test/analysis_chains_test.py
@@ -1018,3 +1018,90 @@ def test_invalid_filter_params_aggregated(
         KeyError, match=f"Key '{filter_param_aggregated}' is not a valid filter parameter."
     ):
         sensor_analysis.filter_params_aggregated[filter_param_aggregated] = {}
+
+
+def test_filter_params_setter_non_dict(sensor_parameters):
+    """Test that filter_params setter raises error for non-dict input."""
+    rd_analysis = TrendAnalysis(**sensor_parameters)
+    with pytest.raises(ValueError, match="must be a dictionary"):
+        rd_analysis.filter_params = "not a dict"
+
+
+def test_filter_params_aggregated_setter_non_dict(sensor_parameters):
+    """Test that filter_params_aggregated setter raises error for non-dict."""
+    rd_analysis = TrendAnalysis(**sensor_parameters)
+    with pytest.raises(ValueError, match="must be a dictionary"):
+        rd_analysis.filter_params_aggregated = "not a dict"
+
+
+def test_clearsky_rescale_index_mismatch(sensor_parameters, cs_input):
+    """Test that rescale=True raises error when indices don't match."""
+    rd_analysis = TrendAnalysis(**sensor_parameters)
+    rd_analysis.set_clearsky(**cs_input)
+
+    # Create explicit times that don't match the poa_global index
+    mismatched_times = pd.date_range(
+        "2020-01-01", periods=100, freq="h", tz=cs_input["pvlib_location"].tz
+    )
+
+    with pytest.raises(ValueError, match="rescale=True can only be used"):
+        rd_analysis._calc_clearsky_poa(times=mismatched_times, rescale=True)
+
+
+def test_poa_filter_without_poa(sensor_parameters):
+    """Test that poa_filter raises error when poa is not available."""
+    params = sensor_parameters.copy()
+    rd_analysis = TrendAnalysis(**params)
+    rd_analysis.filter_params = {"poa_filter": {}}
+    # Set poa_global to None after initialization
+    rd_analysis.poa_global = None
+    # Need power_expected to get past other checks
+    rd_analysis.power_expected = sensor_parameters["pv"]
+
+    with pytest.raises(ValueError, match="poa_global must be available"):
+        rd_analysis.sensor_analysis()
+
+
+def test_tcell_filter_without_temperature(sensor_parameters):
+    """Test that tcell_filter raises error when cell temp not available."""
+    params = sensor_parameters.copy()
+    params["temperature_ambient"] = None
+    params["temperature_cell"] = None
+    rd_analysis = TrendAnalysis(**params)
+    rd_analysis.poa_global = sensor_parameters["poa_global"]
+    rd_analysis.filter_params = {"tcell_filter": {}}
+
+    # Need power_expected to skip thermal calculation
+    rd_analysis.power_expected = sensor_parameters["pv"]
+
+    with pytest.raises(ValueError, match="Cell temperature must be available"):
+        rd_analysis.sensor_analysis()
+
+
+def test_hour_angle_filter_without_location(sensor_parameters):
+    """Test hour_angle_filter raises error without pvlib_location."""
+    rd_analysis = TrendAnalysis(**sensor_parameters)
+    rd_analysis.filter_params = {"hour_angle_filter": {}}
+
+    with pytest.raises(ValueError, match="pvlib location must be provided"):
+        rd_analysis.sensor_analysis()
+
+
+def test_clearsky_filter_without_poa(sensor_parameters, cs_input):
+    """Test clearsky_filter raises error without required poa data."""
+    rd_analysis = TrendAnalysis(**sensor_parameters)
+    rd_analysis.set_clearsky(**cs_input)
+
+    # Store the pv_energy for filtering, then set poa_global to None
+    energy_normalized = rd_analysis.pv_energy.copy()
+    rd_analysis.poa_global = None
+    rd_analysis.filter_params = {"clearsky_filter": {}}
+
+    with pytest.raises(ValueError, match="poa_global and poa_global_clearsky"):
+        rd_analysis._filter(energy_normalized, "clearsky")
+
+
+def test_degradation_timeseries_plot_invalid_case(sensor_analysis):
+    """Test plot_degradation_timeseries raises error for invalid case."""
+    with pytest.raises(ValueError, match="case must be either"):
+        sensor_analysis.plot_degradation_timeseries(case="invalid")
