Merge pull request #890 from adamtheturtle/better-timeout-error

Better timeout error

Author: adamtheturtle

src/vws/vws.py

@@ -276,14 +276,18 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
 
         return dict(response.json()['target_record'])
 
-    @timeout_decorator.timeout(seconds=60 * 5)
-    def wait_for_target_processed(self, target_id: str) -> None:
+    def _wait_for_target_processed(
+        self,
+        target_id: str,
+        seconds_between_requests: float,
+    ) -> None:
         """
-        Wait up to five minutes (arbitrary) for a target to get past the
-        processing stage.
+        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.AuthenticationFailure: The secret key is not
@@ -300,10 +304,35 @@ def wait_for_target_processed(self, target_id: str) -> None:
             if report['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)
+            sleep(seconds_between_requests)
+
+    @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:
+            ~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.
+            ~vws.exceptions.UnknownTarget: The given target ID does not match a
+                target in the database.
+        """
+        # 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.
+        seconds_between_requests = 0.2
+        self._wait_for_target_processed(
+            target_id=target_id,
+            seconds_between_requests=seconds_between_requests,
+        )
 
     def list_targets(self) -> List[str]:
         """