Merge pull request #124 from ImagingDataCommons/feature/timeout

Add timeout to all requests

Author: CPBridge

src/dicomweb_client/web.py

@@ -226,7 +226,8 @@ def __init__(
         headers: Optional[Dict[str, str]] = None,
         callback: Optional[Callable] = None,
         chunk_size: int = 10**6,
-        permissive_uid: bool = False
+        permissive_uid: bool = False,
+        timeout: float | tuple = 20,
     ) -> None:
         """Instatiate client.
 
@@ -269,6 +270,10 @@ def __init__(
             this flag is **not** recommended, since non-conformant UIDs may
             lead to unexpected errors downstream, e.g., rejection by a DICOMweb
             server, etc.
+        timeout: float | tuple, optional
+            Timeout parameter used for all requests in the format used by the
+            requests library. May provide a single number or a tuple of
+            (connect timeout, read timeout), using seconds in both cases.
 
         Warning
         -------
@@ -306,6 +311,7 @@ def __init__(
                 'Argument "delete_url_prefix" must not be a zero length string.'
             )
         self.delete_url_prefix = delete_url_prefix
+        self._timeout = timeout
 
         # This regular expression extracts the scheme and host name from the URL
         # and optionally the port number and prefix:
@@ -558,7 +564,12 @@ def _invoke_get_request(
             # encoding. The iter_content() method can be used to iterate over
             # chunks. If stream is not set, iter_content() will return the
             # full payload at once.
-            return self._session.get(url=url, headers=headers, stream=stream)
+            return self._session.get(
+                url=url,
+                headers=headers,
+                stream=stream,
+                timeout=self._timeout,
+            )
 
         if headers is None:
             headers = {}
@@ -1543,7 +1554,12 @@ def _invoke_post_request(
             headers: Optional[Dict[str, str]] = None
         ) -> requests.models.Response:
             logger.debug(f'POST: {url} {headers}')
-            return self._session.post(url, data=data, headers=headers)
+            return self._session.post(
+                url,
+                data=data,
+                headers=headers,
+                timeout=self._timeout,
+            )
 
         if len(data) > self._chunk_size:
             logger.info('store data in chunks using chunked transfer encoding')
@@ -1644,7 +1660,7 @@ def _http_delete(self, url: str):
             stop_max_attempt_number=self._max_attempts
         )
         def _invoke_delete_request(url: str) -> requests.models.Response:
-            return self._session.delete(url)
+            return self._session.delete(url, timeout=self._timeout)
 
         response = _invoke_delete_request(url)
         if response.status_code == HTTPStatus.METHOD_NOT_ALLOWED: