ecmwf-datastores-client 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

ecmwf/datastores/catalogue.py

@@ -15,7 +15,6 @@
 from __future__ import annotations
 
 import datetime
-import warnings
 from typing import Any, Callable
 
 import attrs
@@ -93,16 +92,6 @@ class Collection(ApiResponse):
         url = self._get_link_href(rel="retrieve")
         return datastores.Process.from_request("get", url, **self._request_kwargs)
 
-    @property
-    def process(self) -> datastores.Process:
-        warnings.warn(
-            "`process` has been deprecated, and in the future will raise an error."
-            "Please use `submit` and `apply_constraints` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self._process
-
     @property
     def form(self) -> list[dict[str, Any]]:
         url = f"{self.url}/form.json"

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.
 
@@ -234,7 +251,7 @@ class Client:
         Parameters
         ----------
         limit: int | None
-            Number of processes per page.
+            Number of collections per page.
         sortby: {None, 'id', 'relevance', 'title', 'update'}
             Field to sort results by.
         query: str or None
@@ -259,17 +276,17 @@ 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.
 
         Parameters
         ----------
         limit: int or None
-            Number of processes per page.
+            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/processing.py

@@ -400,16 +400,6 @@ class Remote:
         """Request ID."""
         return self.url.rpartition("/")[2]
 
-    @property
-    def request_uid(self) -> str:
-        warnings.warn(
-            "`request_uid` has been deprecated, and in the future will raise an error."
-            "Please use `request_id` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.request_id
-
     @property
     def json(self) -> dict[str, Any]:
         """Content of the response."""
@@ -450,48 +440,18 @@ class Remote:
         """When the job was created."""
         return utils.string_to_datetime(self.json["created"])
 
-    @property
-    def creation_datetime(self) -> datetime.datetime:
-        warnings.warn(
-            "`creation_datetime` has been deprecated, and in the future will raise an error."
-            "Please use `created_at` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.created_at
-
     @property
     def started_at(self) -> datetime.datetime | None:
         """When the job started. If None, the job has not started."""
         value = self.json.get("started")
         return value if value is None else utils.string_to_datetime(value)
 
-    @property
-    def start_datetime(self) -> datetime.datetime | None:
-        warnings.warn(
-            "`start_datetime` has been deprecated, and in the future will raise an error."
-            "Please use `started_at` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.started_at
-
     @property
     def finished_at(self) -> datetime.datetime | None:
         """When the job finished. If None, the job has not finished."""
         value = self.json.get("finished")
         return value if value is None else utils.string_to_datetime(value)
 
-    @property
-    def end_datetime(self) -> datetime.datetime | None:
-        warnings.warn(
-            "`end_datetime` has been deprecated, and in the future will raise an error."
-            "Please use `finished_at` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.finished_at
-
     def _wait_on_results(self) -> None:
         sleep = 1.0
         while not self.results_ready:
@@ -507,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"):
@@ -525,15 +485,6 @@ class Remote:
         results = Results.from_request("get", results_url, **self._request_kwargs)
         return results
 
-    def make_results(self, wait: bool = True) -> Results:
-        warnings.warn(
-            "`make_results` has been deprecated, and in the future will raise an error."
-            "Please use `get_results` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self._make_results(wait)
-
     def get_results(self) -> Results:
         """Retrieve results.
 
@@ -641,15 +592,6 @@ class Job(ApiResponse):
             url = self._get_link_href(rel="self")
         return Remote(url, **self._request_kwargs)
 
-    def make_remote(self) -> Remote:
-        warnings.warn(
-            "`make_remote` has been deprecated, and in the future will raise an error."
-            "Please use `get_remote` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.get_remote()
-
 
 @attrs.define
 class Jobs(ApiResponsePaginated):
@@ -660,16 +602,6 @@ class Jobs(ApiResponsePaginated):
         """List of request IDs."""
         return [job["jobID"] for job in self._json_dict["jobs"]]
 
-    @property
-    def request_uids(self) -> list[str]:
-        warnings.warn(
-            "`request_uids` has been deprecated, and in the future will raise an error."
-            "Please use `request_ids` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.request_ids
-
 
 @attrs.define
 class Results(ApiResponse):
@@ -773,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/version.py

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

{ecmwf_datastores_client-0.1.0.dist-info → ecmwf_datastores_client-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecmwf-datastores-client
-Version: 0.1.0
+Version: 0.3.0
 Summary: ECMWF Data Stores Service (DSS) API Python client
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -228,25 +228,20 @@ Requires-Dist: multiurl>=0.3.2
 Requires-Dist: requests
 Requires-Dist: typing-extensions
 Provides-Extra: legacy
-Requires-Dist: cdsapi>=0.7.5; extra == "legacy"
+Requires-Dist: cdsapi>=0.7.6; extra == "legacy"
 Dynamic: license-file
 
 <p align="center">
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE">
-  </a>
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE"></a>
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level">
-  </a>
-  <!-- <a href="https://codecov.io/gh/ecmwf/earthkit">
-    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage">
-  </a> -->
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level"></a>
+  <!-- <a href="https://codecov.io/gh/ecmwf/ecmwf-datastores-client">
+    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage"></a> -->
   <a href="https://opensource.org/licenses/apache-2-0">
-    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence">
-  </a>
-  <a href="https://github.com/ecmwf/earthkit/releases">
-    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release">
-  </a>
+    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence"></a>
+  <a href="https://github.com/ecmwf/ecmwf-datastores-client/releases">
+    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release"></a>
 </p>
 
 <p align="center">
@@ -282,8 +277,11 @@ $ pip install ecmwf-datastores-client
 
 ## Configuration
 
-The `Client` requires the `url` to the API root and a valid API `key`. You can also set the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables, or use a configuration file.
-The configuration file must be located at `~/.ecmwfdatastoresrc`, or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
+The `Client` requires the `url` to the API root and a valid API `key`. These can be provided in three ways, in order of precedence:
+
+1. As keyword arguments when instantiating the `Client`.
+1. Via the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables.
+1. From a configuration file, which must be located at `~/.ecmwfdatastoresrc` or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
 
 ```
 $ cat $HOME/.ecmwfdatastoresrc
@@ -291,14 +289,6 @@ url: https://cds.climate.copernicus.eu/api
 key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 ```
 
-It is possible (though not recommended) to use the API key of one of the test users:
-
-```
-00112233-4455-6677-c899-aabbccddeeff
-```
-
-This key is used for anonymous tests and is designed to be the least performant option for accessing the system.
-
 ## Quick Start
 
 Configure the logging level to display INFO messages:
@@ -312,12 +302,8 @@ Configure the logging level to display INFO messages:
 Instantiate the API client and optionally verify authentication:
 
 ```python
->>> import os
 >>> from ecmwf.datastores import Client
->>> client = Client(
-...     url=os.getenv("ECMWF_DATASTORES_URL"),
-...     key=os.getenv("ECMWF_DATASTORES_KEY"),
-... )
+>>> client = Client()
 >>> client.check_authentication()  # optional check
 {...}
 

ecmwf_datastores_client-0.3.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+ecmwf/datastores/__init__.py,sha256=RQ5WNfEjLQ1qlZxyvGv3S6zPcFO35UcgN4iiz_Uh06I,1243
+ecmwf/datastores/catalogue.py,sha256=I-ON4lxI13Y5dR7joU1qeQrWTxYBQMFGYoOrLa2oLic,6257
+ecmwf/datastores/client.py,sha256=bCXSb1q3T-kX7csOshi4z6qU54s8JrczPVbEPxa_UiA,13053
+ecmwf/datastores/config.py,sha256=45C4nvgk-uGucCAnN3bUtr_zv-_dm8IN_P5xl7LPqfs,1497
+ecmwf/datastores/legacy_client.py,sha256=UEkQNg9IA_zNnpZrc4I9O2X2h39NsaxYM0xpL2OKghA,9491
+ecmwf/datastores/processing.py,sha256=C6nMsPCQGVWGN0gCHU59Q2C1QfbGGwEbOscv0GgqLaw,22093
+ecmwf/datastores/profile.py,sha256=VjT6GSoSZZyaDHXZh0SQbrzxSX3Ug2DOWhq7VIu-QX8,2974
+ecmwf/datastores/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ecmwf/datastores/utils.py,sha256=fc6wma5qRpgAsX3dOmg0aoIc-qjWG6NY9PSHaWR8CpE,320
+ecmwf/datastores/version.py,sha256=3h8WahDhaqqG0csM7Cbye1f4Rwme9vn3Dz_DYKtqceo,72
+ecmwf_datastores_client-0.3.0.dist-info/licenses/LICENSE,sha256=e2Qp4JUZeHZZSYCADyp1B3siZB5aQE5MRCYRx7vqlNI,11346
+ecmwf_datastores_client-0.3.0.dist-info/METADATA,sha256=ulKbZeg6q4nUICkZ_A2P2tWSB-eekToBmUnim-HzJHk,21463
+ecmwf_datastores_client-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ecmwf_datastores_client-0.3.0.dist-info/top_level.txt,sha256=gvA9-Z3hRaFzijz-mf8v2t84s25ptpWeqhyuUomJoJk,6
+ecmwf_datastores_client-0.3.0.dist-info/RECORD,,

{ecmwf_datastores_client-0.1.0.dist-info → ecmwf_datastores_client-0.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.3.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ecmwf_datastores_client-0.1.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-ecmwf/datastores/__init__.py,sha256=RQ5WNfEjLQ1qlZxyvGv3S6zPcFO35UcgN4iiz_Uh06I,1243
-ecmwf/datastores/catalogue.py,sha256=Mj5myLRkk_NcjWSZISuZxU-jJIhSAATFhsJJveiyiHo,6609
-ecmwf/datastores/client.py,sha256=0hRAHOV-i5Cbu6z_VL7nyMzx_qjCAtxVzhuxexiciGI,12646
-ecmwf/datastores/config.py,sha256=45C4nvgk-uGucCAnN3bUtr_zv-_dm8IN_P5xl7LPqfs,1497
-ecmwf/datastores/legacy_client.py,sha256=UEkQNg9IA_zNnpZrc4I9O2X2h39NsaxYM0xpL2OKghA,9491
-ecmwf/datastores/processing.py,sha256=FrDBoO8HfQ_dlqo15xe_SK_AHiPBQ9fvJ5UYbaeLxsE,24095
-ecmwf/datastores/profile.py,sha256=VjT6GSoSZZyaDHXZh0SQbrzxSX3Ug2DOWhq7VIu-QX8,2974
-ecmwf/datastores/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ecmwf/datastores/utils.py,sha256=fc6wma5qRpgAsX3dOmg0aoIc-qjWG6NY9PSHaWR8CpE,320
-ecmwf/datastores/version.py,sha256=FGsmFbZ942cZk42U_qHqxgRCbsD--5Vld_eR6xKJ-mQ,72
-ecmwf_datastores_client-0.1.0.dist-info/licenses/LICENSE,sha256=e2Qp4JUZeHZZSYCADyp1B3siZB5aQE5MRCYRx7vqlNI,11346
-ecmwf_datastores_client-0.1.0.dist-info/METADATA,sha256=iWh4WP7qUyNI2kxFJJmj9kxo9a-c_rwIQkhE3o2NiEA,21715
-ecmwf_datastores_client-0.1.0.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-ecmwf_datastores_client-0.1.0.dist-info/top_level.txt,sha256=gvA9-Z3hRaFzijz-mf8v2t84s25ptpWeqhyuUomJoJk,6
-ecmwf_datastores_client-0.1.0.dist-info/RECORD,,