Add request_timeout param to get_detector and add tests

Author: CoreyEWood

src/groundlight/client.py

@@ -270,7 +270,11 @@ def _user_is_privileged(self) -> bool:
         obj = self.user_api.who_am_i()
         return obj["is_superuser"]
 
-    def get_detector(self, id: Union[str, Detector]) -> Detector:  # pylint: disable=redefined-builtin
+    def get_detector(
+        self,
+        id: Union[str, Detector],
+        request_timeout: Optional[float] = None,
+    ) -> Detector:  # pylint: disable=redefined-builtin
         """
         Get a Detector by id.
 
@@ -281,6 +285,8 @@ def get_detector(self, id: Union[str, Detector]) -> Detector:  # pylint: disable
             print(detector)
 
         :param id: the detector id
+        :param request_timeout: The request timeout for the image query submission API request. Most users will not need
+            to modify this. If not set, the default value will be used.
 
         :return: Detector
         """
@@ -289,7 +295,8 @@ def get_detector(self, id: Union[str, Detector]) -> Detector:  # pylint: disable
             # Short-circuit
             return id
         try:
-            obj = self.detectors_api.get_detector(id=id, _request_timeout=DEFAULT_REQUEST_TIMEOUT)
+            request_timeout = request_timeout if request_timeout is not None else DEFAULT_REQUEST_TIMEOUT
+            obj = self.detectors_api.get_detector(id=id, _request_timeout=request_timeout)
         except NotFoundException as e:
             raise NotFoundError(f"Detector with id '{id}' not found") from e
         return Detector.parse_obj(obj.to_dict())
@@ -750,8 +757,8 @@ def submit_image_query(  # noqa: PLR0913 # pylint: disable=too-many-arguments, t
         :param image_query_id: The ID for the image query. This is to enable specific functionality
                             and is not intended for general external use. If not set, a random ID
                             will be generated.
-        :param request_timeout: The total request timeout for the image query submission API request. Most users will
-            not need to modify this. If not set, the default value will be used.
+        :param request_timeout: The request timeout for the image query submission API request. Most users will not need
+            to modify this. If not set, the default value will be used.
 
         :return: ImageQuery with query details and result (if wait > 0)
         :raises ValueError: If wait > 0 when want_async=True

test/integration/test_groundlight.py

@@ -222,6 +222,21 @@ def test_get_detector(gl: Groundlight, detector: Detector):
     assert isinstance(_detector, Detector)
 
 
+def test_get_detector_with_low_request_timeout(gl: Groundlight, detector: Detector):
+    """
+    Verifies that get_detector respects the request_timeout parameter and raises a ReadTimeoutError when timeout is
+    exceeded. Verifies that request_timeout parameter can be a float or a tuple.
+    """
+    with pytest.raises(ReadTimeoutError):
+        # Setting a very low request_timeout value should result in a timeout.
+        # NOTE: request_timeout=0 seems to have special behavior that does not result in a timeout.
+        gl.get_detector(id=detector.id, request_timeout=1e-8)
+
+    with pytest.raises(ReadTimeoutError):
+        # Ensure a tuple can be passed.
+        gl.get_detector(id=detector.id, request_timeout=(1e-8, 1e-8))
+
+
 def test_get_detector_by_name(gl: Groundlight, detector: Detector):
     _detector = gl.get_detector_by_name(name=detector.name)
     assert str(_detector)
@@ -352,14 +367,18 @@ def test_submit_image_query_with_human_review_param(gl: Groundlight, detector: D
 
 def test_submit_image_query_with_low_request_timeout(gl: Groundlight, detector: Detector, image: str):
     """
-    Test that submit_image_query respects the request_timeout parameter and raises a ReadTimeoutError when timeout is
-    exceeded.
+    Verifies that submit_image_query respects the request_timeout parameter and raises a ReadTimeoutError when timeout is
+    exceeded. Verifies that request_timeout parameter can be a float or a tuple.
     """
     with pytest.raises(ReadTimeoutError):
         # Setting a very low request_timeout value should result in a timeout.
         # NOTE: request_timeout=0 seems to have special behavior that does not result in a timeout.
         gl.submit_image_query(detector=detector, image=image, human_review="NEVER", request_timeout=1e-8)
 
+    with pytest.raises(ReadTimeoutError):
+        # Ensure a tuple can be passed.
+        gl.submit_image_query(detector=detector, image=image, human_review="NEVER", request_timeout=(1e-8, 1e-8))
+
 
 @pytest.mark.skip_for_edge_endpoint(reason="The edge-endpoint does not support passing detector metadata.")
 def test_create_detector_with_metadata(gl: Groundlight):