Merge pull request #895 from adamtheturtle/custom-timeout

Custom timeout

Author: adamtheturtle

src/vws/vws.py

@@ -310,6 +310,7 @@ def wait_for_target_processed(
         self,
         target_id: str,
         seconds_between_requests: float = 0.2,
+        timeout_seconds: float = 60 * 5,
     ) -> None:
         """
         Wait up to five minutes (arbitrary) for a target to get past the
@@ -322,18 +323,19 @@ def wait_for_target_processed(
                 We wait 0.2 seconds by default, rather than less, than that to
                 decrease the number of calls made to the API, to decrease the
                 likelihood of hitting the request quota.
+            timeout_seconds: The maximum number of seconds to wait for the
+                target to be processed.
 
         Raises:
             ~vws.exceptions.AuthenticationFailure: The secret key is not
                 correct.
             ~vws.exceptions.Fail: There was an error with the request. For
                 example, the given access key does not match a known database.
             TimeoutError: The target remained in the processing stage for more
-                than five minutes.
+                than ``timeout_seconds`` seconds.
             ~vws.exceptions.UnknownTarget: The given target ID does not match a
                 target in the database.
         """
-        timeout_seconds = 60 * 5
 
         @timeout(seconds=timeout_seconds)
         def decorated() -> None:

tests/test_vws.py

@@ -6,6 +6,7 @@
 from typing import Optional
 
 import pytest
+import timeout_decorator
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 
@@ -364,6 +365,42 @@ def test_custom_seconds_between_requests(
             )
             assert report['request_usage'] == expected_requests
 
+    def test_custom_timeout(
+        self,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        It is possible to set a maximum timeout.
+        """
+        with MockVWS(processing_time_seconds=0.5) as mock:
+            database = VuforiaDatabase()
+            mock.add_database(database=database)
+            client = VWS(
+                server_access_key=database.server_access_key.decode(),
+                server_secret_key=database.server_secret_key.decode(),
+            )
+
+            target_id = client.add_target(
+                name='x',
+                width=1,
+                image=high_quality_image,
+            )
+
+            report = client.get_target_summary_report(target_id=target_id)
+            assert report['status'] == 'processing'
+            with pytest.raises(timeout_decorator.TimeoutError):
+                client.wait_for_target_processed(
+                    target_id=target_id,
+                    timeout_seconds=0.1,
+                )
+
+            client.wait_for_target_processed(
+                target_id=target_id,
+                timeout_seconds=0.5,
+            )
+            report = client.get_target_summary_report(target_id=target_id)
+            assert report['status'] != 'processing'
+
 
 class TestGetDuplicateTargets:
     """