fix typing, update tests, add test for retries

Author: CoreyEWood

src/groundlight/client.py

@@ -273,7 +273,7 @@ def _user_is_privileged(self) -> bool:
     def get_detector(
         self,
         id: Union[str, Detector],
-        request_timeout: Optional[float] = None,
+        request_timeout: Optional[Union[float, Tuple[float, float]]] = None,
     ) -> Detector:  # pylint: disable=redefined-builtin
         """
         Get a Detector by id.
@@ -675,7 +675,7 @@ def submit_image_query(  # noqa: PLR0913 # pylint: disable=too-many-arguments, t
         inspection_id: Optional[str] = None,
         metadata: Union[dict, str, None] = None,
         image_query_id: Optional[str] = None,
-        request_timeout: Optional[float] = None,
+        request_timeout: Optional[Union[float, Tuple[float, float]]] = None,
     ) -> ImageQuery:
         """
         Evaluates an image with Groundlight. This is the core method for getting predictions about images.

test/integration/test_groundlight.py

@@ -27,7 +27,8 @@
     PaginatedDetectorList,
     PaginatedImageQueryList,
 )
-from urllib3.exceptions import ReadTimeoutError
+from urllib3.exceptions import MaxRetryError
+from urllib3.util.retry import Retry
 
 DEFAULT_CONFIDENCE_THRESHOLD = 0.9
 IQ_IMPROVEMENT_THRESHOLD = 0.75
@@ -80,6 +81,21 @@ def fixture_image() -> str:
     return "test/assets/dog.jpeg"
 
 
+def test_create_groundlight_with_retries():
+    """Verify that the `retries` parameter can be successfully passed to the `Groundlight` constructor."""
+    # Set retries using int value
+    num_retries = 25
+    gl = Groundlight(retries=num_retries)
+    assert gl.configuration.retries == num_retries
+    assert gl.api_client.configuration.retries == num_retries
+
+    # Set retries using Retry object
+    retries = Retry(total=num_retries)
+    gl = Groundlight(retries=retries)
+    assert gl.configuration.retries.total == retries.total
+    assert gl.api_client.configuration.retries.total == retries.total
+
+
 def test_create_detector(gl: Groundlight):
     name = f"Test {datetime.utcnow()}"  # Need a unique name
     query = "Is there a dog?"
@@ -227,12 +243,12 @@ def test_get_detector_with_low_request_timeout(gl: Groundlight, detector: Detect
     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):
+    with pytest.raises(MaxRetryError):
         # 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):
+    with pytest.raises(MaxRetryError):
         # Ensure a tuple can be passed.
         gl.get_detector(id=detector.id, request_timeout=(1e-8, 1e-8))
 
@@ -370,12 +386,12 @@ def test_submit_image_query_with_low_request_timeout(gl: Groundlight, detector:
     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):
+    with pytest.raises(MaxRetryError):
         # 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):
+    with pytest.raises(MaxRetryError):
         # Ensure a tuple can be passed.
         gl.submit_image_query(detector=detector, image=image, human_review="NEVER", request_timeout=(1e-8, 1e-8))