Merge pull request #1840 from VWS-Python/rm-func-timeout

Remove func-timeout dependency, for simplicity and type safety

Author: adamtheturtle

pyproject.toml

@@ -144,8 +144,6 @@ strict = true
 [[tool.mypy.overrides]]
 
 module = [
-    "func_timeout",
-    "func_timeout.exceptions",
     "sybil",
     "sybil.parsers.rest",
 ]
@@ -221,7 +219,6 @@ readme = { file = "README.rst", content-type = "text/x-rst"}
 requires-python = ">=3.10"
 dependencies = [
     "VWS-Auth-Tools",
-    "func-timeout",
     "requests",
     "urllib3",
 ]

src/vws/vws.py

@@ -6,14 +6,12 @@
 
 import base64
 import json
+import time
 from datetime import date
-from time import sleep
 from typing import TYPE_CHECKING, BinaryIO
 from urllib.parse import urljoin
 
 import requests
-from func_timeout import func_set_timeout
-from func_timeout.exceptions import FunctionTimedOut
 from requests import Response
 from vws_auth_tools import authorization_header, rfc_1123_date
 
@@ -332,44 +330,11 @@ def get_target_record(self, target_id: str) -> TargetStatusAndRecord:
             target_record=target_record,
         )
 
-    def _wait_for_target_processed(
-        self,
-        target_id: str,
-        seconds_between_requests: float,
-    ) -> None:
-        """
-        Wait indefinitely for a target to get past the processing stage.
-
-        Args:
-            target_id: The ID of the target to wait for.
-            seconds_between_requests: The number of seconds to wait between
-                requests made while polling the target status.
-
-        Raises:
-            ~vws.exceptions.vws_exceptions.AuthenticationFailure: The secret
-                key is not correct.
-            ~vws.exceptions.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.
-            ~vws.exceptions.vws_exceptions.UnknownTarget: The given target ID
-                does not match a target in the database.
-            ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
-                error with the time sent to Vuforia.
-        """
-        while True:
-            report = self.get_target_summary_report(target_id=target_id)
-            if report.status != TargetStatuses.PROCESSING:
-                return
-
-            sleep(seconds_between_requests)
-
     def wait_for_target_processed(
         self,
         target_id: str,
         seconds_between_requests: float = 0.2,
-        timeout_seconds: float | None = 60 * 5,
+        timeout_seconds: float = 60 * 5,
     ) -> None:
         """
         Wait up to five minutes (arbitrary) for a target to get past the
@@ -383,8 +348,7 @@ def wait_for_target_processed(
                 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. If ``None`` is given, no maximum is
-                applied.
+                target to be processed.
 
         Raises:
             ~vws.exceptions.vws_exceptions.AuthenticationFailure: The secret
@@ -400,19 +364,17 @@ def wait_for_target_processed(
             ~vws.exceptions.vws_exceptions.RequestTimeTooSkewed: There is an
                 error with the time sent to Vuforia.
         """
+        start_time = time.monotonic()
+        while True:
+            report = self.get_target_summary_report(target_id=target_id)
+            if report.status != TargetStatuses.PROCESSING:
+                return
+
+            elapsed_time = time.monotonic() - start_time
+            if elapsed_time > timeout_seconds:  # pragma: no cover
+                raise TargetProcessingTimeout
 
-        # func_timeout does not have type hints.
-        @func_set_timeout(timeout=timeout_seconds)  # type: ignore[misc]
-        def decorated() -> None:
-            self._wait_for_target_processed(
-                target_id=target_id,
-                seconds_between_requests=seconds_between_requests,
-            )
-
-        try:
-            decorated()
-        except FunctionTimedOut as exc:
-            raise TargetProcessingTimeout from exc
+            time.sleep(seconds_between_requests)
 
     def list_targets(self) -> list[str]:
         """