Merge pull request #793 from adamtheturtle/wait-for-target-processed

Add initial function to wait for target processed

Author: adamtheturtle

requirements.txt

@@ -1 +1,2 @@
 requests==2.19.1
+timeout-decorator==0.4.0

src/vws/vws.py

@@ -5,10 +5,12 @@
 import base64
 import io
 import json
+from time import sleep
 from typing import Any, Dict, Union
 from urllib.parse import urljoin
 
 import requests
+import timeout_decorator
 from requests import Response
 
 from vws._authorization import authorization_header, rfc_1123_date
@@ -154,3 +156,26 @@ def get_target(self, target_id: str) -> Dict[str, Any]:
         )
 
         return dict(response.json())
+
+    @timeout_decorator.timeout(seconds=60 * 5)
+    def wait_for_target_processed(self, target_id: str) -> None:
+        """
+        Wait up to five minutes (arbitrary) for a target to get past the
+        processing stage.
+
+        Args:
+            target_id: The ID of the target to wait for.
+
+        Raises:
+            TimeoutError: The target remained in the processing stage for more
+                than five minutes.
+        """
+        while True:
+            target_details = self.get_target(target_id=target_id)
+            if target_details['status'] != 'processing':
+                return
+
+            # We wait 0.2 seconds rather than less than that to decrease the
+            # number of calls made to the API, to decrease the likelihood of
+            # hitting the request quota.
+            sleep(0.2)

tests/test_wait_for_target_processed.py

@@ -0,0 +1,32 @@
+"""
+Tests for helper function for waiting for a target to be processed.
+"""
+
+import io
+
+from vws import VWS
+
+
+class TestWaitForTargetProcessed:
+    """
+    Test for successfully adding a target.
+    """
+
+    def test_wait_for_target_processed(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        It is possible to wait until a target is processed.
+        """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+        )
+        target_details = client.get_target(target_id=target_id)
+        assert target_details['status'] == 'processing'
+        client.wait_for_target_processed(target_id=target_id)
+        target_details = client.get_target(target_id=target_id)
+        assert target_details['status'] != 'processing'