diff --git a/cads_api_client/processing.py b/cads_api_client/processing.py index 8971657..3975e50 100644 --- a/cads_api_client/processing.py +++ b/cads_api_client/processing.py @@ -648,8 +648,8 @@ class Jobs(ApiResponsePaginated): """A class to interact with submitted jobs.""" @property - def job_ids(self) -> list[str]: - """List of job IDs. + def request_uids(self) -> list[str]: + """List of request UIDs. Returns ------- @@ -657,6 +657,15 @@ def job_ids(self) -> list[str]: """ return [job["jobID"] for job in self.json["jobs"]] + @property + def job_ids(self) -> list[str]: + warnings.warn( + "`.job_ids` has been deprecated, and in the future will raise an error." + " Please use `.request_uids` from now on.", + DeprecationWarning, + ) + return self.request_uids + @attrs.define class Results(ApiResponse): diff --git a/tests/integration_test_20_processing.py b/tests/integration_test_20_processing.py index 4e3ed43..4886960 100644 --- a/tests/integration_test_20_processing.py +++ b/tests/integration_test_20_processing.py @@ -62,12 +62,14 @@ def test_processing_get_jobs_status(api_anon_client: ApiClient) -> None: request_uid = remote.request_uid with pytest.raises(HTTPError, match="400 Client Error: Bad Request"): remote.make_results() - assert request_uid in api_anon_client.get_jobs(status="failed").job_ids - assert request_uid not in api_anon_client.get_jobs(status="successful").job_ids + assert request_uid in api_anon_client.get_jobs(status="failed").request_uids + assert request_uid not in api_anon_client.get_jobs(status="successful").request_uids def test_processing_get_jobs_sortby(api_anon_client: ApiClient) -> None: uid1 = api_anon_client.submit("test-adaptor-dummy").request_uid uid2 = api_anon_client.submit("test-adaptor-dummy").request_uid - assert [uid2, uid1] == api_anon_client.get_jobs(sortby="-created", limit=2).job_ids - assert [uid2] != api_anon_client.get_jobs(sortby="created", limit=1).job_ids + assert [uid2, uid1] == api_anon_client.get_jobs( + sortby="-created", limit=2 + ).request_uids + assert [uid2] != api_anon_client.get_jobs(sortby="created", limit=1).request_uids