Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions cads_api_client/processing.py
Original file line number Diff line number Diff line change
Expand Up @@ -648,15 +648,24 @@ 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
-------
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):
Expand Down
10 changes: 6 additions & 4 deletions tests/integration_test_20_processing.py
Original file line number Diff line number Diff line change
Expand Up @@ -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