Make status check possible outside infinite loop (#101)

* make status check possible outside infinite loop

* results_ready property and tests

---------

Co-authored-by: malmans2 <[email protected]>

Author: jakub-valenta

cads_api_client/processing.py

@@ -387,6 +387,7 @@ class Remote:
 
     def __attrs_post_init__(self) -> None:
         self.log_start_time = None
+        self.last_status = None
         self.info(f"Request ID is {self.request_uid}")
 
     @property
@@ -466,7 +467,12 @@ def status(self) -> str:
         """
         reply = self.json
         self._log_metadata(reply.get("metadata", {}))
-        return str(reply["status"])
+
+        status = reply["status"]
+        if self.last_status != status:
+            self.info(f"status has been updated to {status}")
+        self.last_status = status
+        return str(status)
 
     @property
     def creation_datetime(self) -> datetime.datetime:
@@ -502,23 +508,30 @@ def end_datetime(self) -> datetime.datetime | None:
 
     def _wait_on_results(self) -> None:
         sleep = 1.0
-        status = None
-        while True:
-            if status != (status := self.status):
-                self.info(f"status has been updated to {status}")
-            if status == "successful":
-                break
-            elif status == "failed":
-                results = self.make_results(wait=False)
-                raise ProcessingFailedError(error_json_to_message(results.json))
-            elif status in ("accepted", "running"):
-                sleep = min(sleep * 1.5, self.sleep_max)
-            elif status in ("dismissed", "deleted"):
-                raise ProcessingFailedError(f"API state {status!r}")
-            else:
-                raise ProcessingFailedError(f"Unknown API state {status!r}")
+        while not self.results_ready:
             self.debug(f"results not ready, waiting for {sleep} seconds")
             time.sleep(sleep)
+            sleep = min(sleep * 1.5, self.sleep_max)
+
+    @property
+    def results_ready(self) -> bool:
+        """Check if results are ready.
+
+        Returns
+        -------
+        bool
+        """
+        status = self.status
+        if status == "successful":
+            return True
+        if status in ("accepted", "running"):
+            return False
+        if status == "failed":
+            results = self.make_results(wait=False)
+            raise ProcessingFailedError(error_json_to_message(results.json))
+        if status in ("dismissed", "deleted"):
+            raise ProcessingFailedError(f"API state {status!r}")
+        raise ProcessingFailedError(f"Unknown API state {status!r}")
 
     def make_results(self, wait: bool = True) -> Results:
         if wait:

tests/integration_test_30_remote.py

@@ -95,6 +95,7 @@ def test_remote_datetimes(api_anon_client: ApiClient) -> None:
         elapsed=1,
         _timestamp=datetime.datetime.now().isoformat(),
     )
+    assert remote.results_ready is False
     assert isinstance(remote.creation_datetime, datetime.datetime)
     assert remote.end_datetime is None
 

tests/test_10_processing.py

@@ -379,6 +379,7 @@ def test_submit(cat: catalogue.Catalogue) -> None:
     remote = collection.submit(variable="temperature", year="2022")
     assert remote.url == JOB_SUCCESSFUL_URL
     assert remote.status == "successful"
+    assert remote.results_ready is True
 
     assert remote.creation_datetime.isoformat() == "2022-09-02T17:30:48.201213"
     assert remote.start_datetime is not None