ecmwf-datastores-client 0.2.0__tar.gz → 0.3.0__tar.gz

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/.github/workflows/on-push.yml

@@ -145,7 +145,7 @@ jobs:
       env:
         ECMWF_DATASTORES_URL: ${{ secrets.ECMWF_DATASTORES_URL }}
         ECMWF_DATASTORES_KEY: ${{ secrets.ECMWF_DATASTORES_KEY }}
-        ECMWF_DATASTORES_ANON_KEY: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
+        ANONYMOUS_PAT: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
       run: |
         make docs-build
     - uses: rossjrw/pr-preview-action@v1
@@ -199,7 +199,7 @@ jobs:
       env:
         ECMWF_DATASTORES_URL: ${{ secrets.ECMWF_DATASTORES_URL }}
         ECMWF_DATASTORES_KEY: ${{ secrets.ECMWF_DATASTORES_KEY }}
-        ECMWF_DATASTORES_ANON_KEY: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
+        ANONYMOUS_PAT: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
       run: |
         make ci-integration-tests COV_REPORT=xml
 

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecmwf-datastores-client
-Version: 0.2.0
+Version: 0.3.0
 Summary: ECMWF Data Stores Service (DSS) API Python client
 License:                                  Apache License
                                    Version 2.0, January 2004

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/client.py

@@ -28,6 +28,8 @@ from ecmwf.datastores.catalogue import Catalogue
 from ecmwf.datastores.processing import Processing, RequestKwargs
 from ecmwf.datastores.profile import Profile
 
+T_STATUS = Literal["accepted", "running", "successful", "failed", "rejected"]
+
 
 @attrs.define(slots=False)
 class Client:
@@ -179,6 +181,21 @@ class Client:
         """
         return self._profile_api.check_authentication()
 
+    def delete(self, *request_ids: str) -> dict[str, Any]:
+        """Delete requests.
+
+        Parameters
+        ----------
+        *request_ids: str
+            Request IDs.
+
+        Returns
+        -------
+        dict[str,Any]
+            Content of the response.
+        """
+        return self._retrieve_api.delete(*request_ids)
+
     def download_results(self, request_id: str, target: str | None = None) -> str:
         """Download the results of a request.
 
@@ -259,7 +276,7 @@ class Client:
         self,
         limit: int | None = None,
         sortby: Literal[None, "created", "-created"] = None,
-        status: Literal[None, "accepted", "running", "successful", "failed"] = None,
+        status: None | T_STATUS | list[T_STATUS] = None,
     ) -> datastores.Jobs:
         """Retrieve submitted jobs.
 
@@ -269,7 +286,7 @@ class Client:
             Number of jobs per page.
         sortby: {None, 'created', '-created'}
             Field to sort results by.
-        status: {None, 'accepted', 'running', 'successful', 'failed'}
+        status: None or {'accepted', 'running', 'successful', 'failed', 'rejected'} or list
             Status of the results.
 
         Returns

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/processing.py

@@ -467,7 +467,7 @@ class Remote:
             return True
         if status in ("accepted", "running"):
             return False
-        if status == "failed":
+        if status in ("failed", "rejected"):
             results = self._make_results(wait=False)
             raise ProcessingFailedError(error_json_to_message(results._json_dict))
         if status in ("dismissed", "deleted"):
@@ -705,6 +705,13 @@ class Processing:
             log_callback=self.log_callback,
         )
 
+    def delete(self, *job_ids: str) -> dict[str, Any]:
+        url = f"{self.url}/jobs/delete"
+        response = ApiResponse.from_request(
+            "post", url, json={"job_ids": job_ids}, **self._request_kwargs
+        )
+        return response._json_dict
+
     def get_processes(self, **params: Any) -> Processes:
         url = f"{self.url}/processes"
         return Processes.from_request("get", url, params=params, **self._request_kwargs)

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/version.py

@@ -1,2 +1,2 @@
 # Do not change! Do not track in version control!
-__version__ = "0.2.0"
+__version__ = "0.3.0"

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/ecmwf_datastores_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecmwf-datastores-client
-Version: 0.2.0
+Version: 0.3.0
 Summary: ECMWF Data Stores Service (DSS) API Python client
 License:                                  Apache License
                                    Version 2.0, January 2004

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/ecmwf_datastores_client.egg-info/SOURCES.txt

@@ -41,8 +41,8 @@ tests/integration_test_20_processing.py
 tests/integration_test_30_remote.py
 tests/integration_test_40_results.py
 tests/integration_test_50_profile.py
-tests/integration_test_60_api_client.py
-tests/integration_test_70_legacy_api_client.py
+tests/integration_test_60_client.py
+tests/integration_test_70_legacy_client.py
 tests/integration_test_80_adaptors.py
 tests/integration_test_90_features.py
 tests/test_00_version.py

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/tests/conftest.py

@@ -21,10 +21,7 @@ def api_root_url() -> str:
 
 @pytest.fixture
 def api_anon_key() -> str:
-    return os.getenv(
-        "ECMWF_DATASTORES_ANON_KEY",
-        "00112233-4455-6677-c899-aabbccddeeff",  # gitleaks:allow
-    )
+    return os.getenv("ANONYMOUS_PAT", "00112233-4455-6677-c899-aabbccddeeff")
 
 
 @pytest.fixture

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/tests/integration_test_20_processing.py

@@ -73,3 +73,12 @@ def test_processing_get_jobs_sortby(api_anon_client: Client) -> None:
     ids = api_anon_client.get_jobs(sortby="-created").request_ids
     assert ids.index(id2) < ids.index(id1)
     assert [id2] != api_anon_client.get_jobs(sortby="created", limit=1).request_ids
+
+
+def test_processing_delete(api_anon_client: Client) -> None:
+    id1 = api_anon_client.submit("test-adaptor-dummy", {}).request_id
+    id2 = api_anon_client.submit("test-adaptor-dummy", {}).request_id
+    job1, job2 = api_anon_client.delete(id1, id2)["jobs"]
+    assert job1["status"] == job2["status"] == "dismissed"
+    assert job1["jobID"] == id1
+    assert job2["jobID"] == id2

ecmwf_datastores_client-0.2.0/tests/integration_test_60_api_client.py → ecmwf_datastores_client-0.3.0/tests/integration_test_60_client.py

@@ -9,7 +9,7 @@ from urllib3.exceptions import InsecureRequestWarning
 from ecmwf.datastores import Client, Remote, Results, processing
 
 
-def test_api_client_download_results(
+def test_client_download_results(
     api_anon_client: Client, tmp_path: pathlib.Path
 ) -> None:
     remote = api_anon_client.submit("test-adaptor-dummy", {})
@@ -20,27 +20,27 @@ def test_api_client_download_results(
     assert os.path.exists(result)
 
 
-def test_api_client_get_process(api_anon_client: Client) -> None:
+def test_client_get_process(api_anon_client: Client) -> None:
     process = api_anon_client.get_process("test-adaptor-dummy")
     assert isinstance(process, processing.Process)
     assert process.id == "test-adaptor-dummy"
     assert set(process.headers) == {"User-Agent", "PRIVATE-TOKEN"}
 
 
-def test_api_client_get_remote(api_anon_client: Client) -> None:
+def test_client_get_remote(api_anon_client: Client) -> None:
     request_id = api_anon_client.submit("test-adaptor-dummy", {}).request_id
     remote = api_anon_client.get_remote(request_id)
     assert remote.request_id == request_id
     assert set(remote.headers) == {"User-Agent", "PRIVATE-TOKEN"}
 
 
-def test_api_client_get_results(api_anon_client: Client) -> None:
+def test_client_get_results(api_anon_client: Client) -> None:
     request_id = api_anon_client.submit("test-adaptor-dummy", {}).request_id
     results = api_anon_client.get_results(request_id)
     assert isinstance(results, Results)
 
 
-def test_api_client_retrieve(
+def test_client_retrieve(
     api_anon_client: Client,
     tmp_path: pathlib.Path,
 ) -> None:
@@ -54,24 +54,24 @@ def test_api_client_retrieve(
     assert os.path.getsize(actual_target) == 1
 
 
-def test_api_client_submit(api_anon_client: Client) -> None:
+def test_client_submit(api_anon_client: Client) -> None:
     remote = api_anon_client.submit("test-adaptor-dummy", {})
     assert isinstance(remote, Remote)
 
 
-def test_api_client_submit_and_wait_on_results(api_anon_client: Client) -> None:
+def test_client_submit_and_wait_on_results(api_anon_client: Client) -> None:
     results = api_anon_client.submit_and_wait_on_results("test-adaptor-dummy", {})
     assert isinstance(results, Results)
 
 
-def test_api_client_verify(api_root_url: str, api_anon_key: str) -> None:
+def test_client_verify(api_root_url: str, api_anon_key: str) -> None:
     if not api_root_url.startswith("https"):
         pytest.skip(f"{api_root_url=} does not use https protocol")
     with pytest.warns(InsecureRequestWarning):
         Client(url=api_root_url, key=api_anon_key, verify=False, maximum_tries=0)
 
 
-def test_api_client_timeout(
+def test_client_timeout(
     api_root_url: str,
     api_anon_key: str,
     tmp_path: pathlib.Path,

ecmwf_datastores_client-0.2.0/tests/integration_test_70_legacy_api_client.py → ecmwf_datastores_client-0.3.0/tests/integration_test_70_legacy_client.py

@@ -54,7 +54,7 @@ def legacy_update(remote: processing.Remote) -> None:
             )
 
 
-def test_legacy_api_client_retrieve(
+def test_legacy_client_retrieve(
     tmp_path: pathlib.Path, legacy_client: LegacyClient
 ) -> None:
     collection_id = "test-adaptor-dummy"
@@ -65,7 +65,7 @@ def test_legacy_api_client_retrieve(
     assert os.path.getsize(target) == 1
 
 
-def test_legacy_api_client_result(
+def test_legacy_client_result(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: pathlib.Path,
     legacy_client: LegacyClient,
@@ -92,7 +92,7 @@ def test_legacy_api_client_result(
 
 
 @pytest.mark.parametrize("quiet", [True, False])
-def test_legacy_api_client_quiet(
+def test_legacy_client_quiet(
     caplog: pytest.LogCaptureFixture,
     api_root_url: str,
     api_anon_key: str,
@@ -105,7 +105,7 @@ def test_legacy_api_client_quiet(
 
 
 @pytest.mark.parametrize("debug", [True, False])
-def test_legacy_api_client_debug(
+def test_legacy_client_debug(
     caplog: pytest.LogCaptureFixture,
     api_root_url: str,
     api_anon_key: str,
@@ -120,7 +120,7 @@ def test_legacy_api_client_debug(
     "wait_until_complete,expected_type",
     [(True, processing.Results), (False, processing.Remote)],
 )
-def test_legacy_api_client_wait_until_complete(
+def test_legacy_client_wait_until_complete(
     tmp_path: pathlib.Path,
     api_root_url: str,
     api_anon_key: str,
@@ -156,7 +156,7 @@ def test_legacy_api_client_wait_until_complete(
         ),
     ],
 )
-def test_legacy_api_client_update(
+def test_legacy_client_update(
     api_root_url: str,
     api_anon_key: str,
     collection_id: str,
@@ -173,7 +173,7 @@ def test_legacy_api_client_update(
 
 
 @pytest.mark.filterwarnings("ignore:Unverified HTTPS")
-def test_legacy_api_client_kwargs(api_root_url: str, api_anon_key: str) -> None:
+def test_legacy_client_kwargs(api_root_url: str, api_anon_key: str) -> None:
     session = requests.Session()
     client = LegacyClient(
         url=api_root_url,
@@ -198,7 +198,7 @@ def test_legacy_api_client_kwargs(api_root_url: str, api_anon_key: str) -> None:
     assert client.client.session is session
 
 
-def test_legacy_api_client_logging(
+def test_legacy_client_logging(
     caplog: pytest.LogCaptureFixture,
     api_root_url: str,
     api_anon_key: str,
@@ -226,7 +226,7 @@ def test_legacy_api_client_logging(
         ]
 
 
-def test_legacy_api_client_download(
+def test_legacy_client_download(
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
     api_root_url: str,
@@ -258,7 +258,7 @@ def test_legacy_api_client_download(
     assert all(os.path.getsize(target) == 1 for target in targets)
 
 
-def test_legacy_api_client_status(legacy_client: LegacyClient) -> None:
+def test_legacy_client_status(legacy_client: LegacyClient) -> None:
     status = legacy_client.status()
     assert set(status) <= {
         "critical",
@@ -277,7 +277,7 @@ def test_legacy_api_client_status(legacy_client: LegacyClient) -> None:
     )
 
 
-def test_legacy_api_client_remote(
+def test_legacy_client_remote(
     legacy_client: LegacyClient, tmp_path: pathlib.Path
 ) -> None:
     results = legacy_client.retrieve("test-adaptor-dummy", {"size": 1})
@@ -288,7 +288,7 @@ def test_legacy_api_client_remote(
     assert os.path.getsize(target) == 1
 
 
-def test_legacy_api_client_warning(
+def test_legacy_client_warning(
     api_root_url: str,
     api_anon_key: str,
 ) -> None:
@@ -305,7 +305,7 @@ def test_legacy_api_client_warning(
         )
 
 
-def test_legacy_api_client_toolbox(legacy_client: LegacyClient) -> None:
+def test_legacy_client_toolbox(legacy_client: LegacyClient) -> None:
     with pytest.raises(NotImplementedError):
         legacy_client.service("service")
     with pytest.raises(NotImplementedError):

{ecmwf_datastores_client-0.2.0 → ecmwf_datastores_client-0.3.0}/tests/test_20_processing.py

@@ -411,8 +411,12 @@ def test_wait_on_result(cat: catalogue.Catalogue) -> None:
     remote._wait_on_results()
 
 
+@pytest.mark.parametrize("status", ["failed", "rejected"])
 @responses.activate
-def test_wait_on_result_failed(cat: catalogue.Catalogue) -> None:
+def test_wait_on_result_failed(
+    cat: catalogue.Catalogue, status: str, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    monkeypatch.setitem(JOB_FAILED_JSON, "status", status)
     responses_add()
 
     collection = cat.get_collection(COLLECTION_ID)
@@ -424,6 +428,7 @@ def test_wait_on_result_failed(cat: catalogue.Catalogue) -> None:
     ):
         remote._wait_on_results()
 
+    assert remote.status == status
     assert remote.created_at.isoformat() == "2022-09-02T17:30:48.201213+00:00"
     assert remote.started_at is not None
     assert remote.started_at.isoformat() == "2022-09-02T17:32:43.890617+00:00"