diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fbf795..17d156b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## Unreleased +### Breaking Changes + +- **`monitor_progress()` `job_id` parameter removed** (HYBIM-931): The deprecated + `job_id` keyword argument of `Experiment.monitor_progress()` has been fully removed. + Callers passing `job_id=` must remove that argument. + ### Added - Added deployment-aware configuration and authentication for Splunk diff --git a/src/splunk_ao/experiment.py b/src/splunk_ao/experiment.py index 6cd4bc8..4ea2cfe 100644 --- a/src/splunk_ao/experiment.py +++ b/src/splunk_ao/experiment.py @@ -3,7 +3,6 @@ import builtins import datetime import re -import warnings from collections.abc import Iterator from time import sleep from typing import TYPE_CHECKING, Any @@ -1126,7 +1125,6 @@ def monitor_progress( poll_interval_seconds: float = 2.0, *, timeout_seconds: float | None = 3600.0, - job_id: str | None = None, ) -> None: """ Monitor the progress of the experiment with a progress bar. @@ -1141,9 +1139,6 @@ def monitor_progress( timeout_seconds : float or None, optional Maximum seconds to wait before raising TimeoutError. Defaults to 3600.0 (one hour). Pass None to wait indefinitely (not recommended). - job_id : str or None, optional - Deprecated. This parameter is ignored; it existed in a prior version - that polled the jobs table, which has been retired. Returns ------- @@ -1168,14 +1163,6 @@ def monitor_progress( experiment.monitor_progress() """ - if job_id is not None: - warnings.warn( - "The 'job_id' parameter of monitor_progress() is deprecated and will be removed in a future release. " - "Progress is now tracked directly via experiment status; the job_id value is ignored.", - DeprecationWarning, - stacklevel=2, - ) - if self.id is None: raise ValueError("Experiment ID is not set. Cannot monitor progress for a local-only experiment.") if self.project_id is None: diff --git a/tests/test_experiment_progress.py b/tests/test_experiment_progress.py index 8f3d016..525dfbe 100644 --- a/tests/test_experiment_progress.py +++ b/tests/test_experiment_progress.py @@ -89,17 +89,6 @@ def test_raises_without_project_id(self): with pytest.raises(ValueError, match="Project ID is not set"): exp.monitor_progress() - @patch("splunk_ao.experiment.Experiment.get_status") - @patch("splunk_ao.experiment.sleep", return_value=None) - def test_deprecated_job_id_warns(self, mock_sleep, mock_get_status): - # Given: an experiment that is already complete, and a caller passing the deprecated job_id - mock_get_status.return_value = _make_status(100.0) - exp = _make_experiment() - - # When/Then: monitor_progress emits a DeprecationWarning when job_id is supplied - with pytest.warns(DeprecationWarning, match="job_id"): - exp.monitor_progress(job_id="some-old-job-id") - @patch("splunk_ao.experiment.Experiment.get_status") @patch("splunk_ao.experiment.sleep", return_value=None) def test_raises_runtime_error_on_failed_experiment(self, mock_sleep, mock_get_status):