Update timeout behavior and default-timeout tests

Author: adamtheturtle

src/vws/query.py

@@ -64,7 +64,7 @@ def __init__(
         self._client_access_key = client_access_key
         self._client_secret_key = client_secret_key
         self._base_vwq_url = base_vwq_url
-        self.request_timeout_seconds = request_timeout_seconds
+        self._request_timeout_seconds = request_timeout_seconds
 
     def query(
         self,
@@ -147,7 +147,7 @@ def query(
             url=urljoin(base=self._base_vwq_url, url=request_path),
             headers=headers,
             data=content,
-            timeout=self.request_timeout_seconds,
+            timeout=self._request_timeout_seconds,
         )
         response = Response(
             text=requests_response.text,

src/vws/vws.py

@@ -152,7 +152,7 @@ def __init__(
         self._server_access_key = server_access_key
         self._server_secret_key = server_secret_key
         self._base_vws_url = base_vws_url
-        self.request_timeout_seconds = request_timeout_seconds
+        self._request_timeout_seconds = request_timeout_seconds
 
     def make_request(
         self,
@@ -196,7 +196,7 @@ def make_request(
             data=data,
             request_path=request_path,
             base_vws_url=self._base_vws_url,
-            request_timeout_seconds=self.request_timeout_seconds,
+            request_timeout_seconds=self._request_timeout_seconds,
         )
 
         if (

tests/test_query.py

@@ -6,6 +6,7 @@
 
 import pytest
 import requests
+from freezegun import freeze_time
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 
@@ -48,18 +49,38 @@ class TestCustomRequestTimeout:
     """Tests for using a custom request timeout."""
 
     @staticmethod
-    def test_default_timeout() -> None:
-        """By default, the request timeout is 30 seconds."""
-        default_timeout_seconds = 30.0
-        with MockVWS() as mock:
+    @pytest.mark.parametrize(
+        argnames=("response_delay_seconds", "expect_timeout"),
+        argvalues=[(29, False), (31, True)],
+    )
+    def test_default_timeout(
+        image: io.BytesIO | BinaryIO,
+        *,
+        response_delay_seconds: int,
+        expect_timeout: bool,
+    ) -> None:
+        """At 29 seconds there is no error; at 31 seconds there is a
+        timeout.
+        """
+        with (
+            freeze_time(auto_tick_seconds=1),
+            MockVWS(response_delay_seconds=response_delay_seconds) as mock,
+        ):
             database = VuforiaDatabase()
             mock.add_database(database=database)
             cloud_reco_client = CloudRecoService(
                 client_access_key=database.client_access_key,
                 client_secret_key=database.client_secret_key,
             )
-            expected = default_timeout_seconds
-            assert cloud_reco_client.request_timeout_seconds == expected
+
+            if expect_timeout:
+                with pytest.raises(
+                    expected_exception=requests.exceptions.Timeout,
+                ):
+                    cloud_reco_client.query(image=image)
+            else:
+                matches = cloud_reco_client.query(image=image)
+                assert matches == []
 
     @staticmethod
     @pytest.mark.parametrize(

tests/test_vws.py

@@ -97,18 +97,49 @@ class TestCustomRequestTimeout:
     """Tests for using a custom request timeout."""
 
     @staticmethod
-    def test_default_timeout() -> None:
-        """By default, the request timeout is 30 seconds."""
-        default_timeout_seconds = 30.0
-        with MockVWS() as mock:
+    @pytest.mark.parametrize(
+        argnames=("response_delay_seconds", "expect_timeout"),
+        argvalues=[(29, False), (31, True)],
+    )
+    def test_default_timeout(
+        image: io.BytesIO | BinaryIO,
+        *,
+        response_delay_seconds: int,
+        expect_timeout: bool,
+    ) -> None:
+        """At 29 seconds there is no error; at 31 seconds there is a
+        timeout.
+        """
+        with (
+            freeze_time(auto_tick_seconds=1),
+            MockVWS(response_delay_seconds=response_delay_seconds) as mock,
+        ):
             database = VuforiaDatabase()
             mock.add_database(database=database)
             vws_client = VWS(
                 server_access_key=database.server_access_key,
                 server_secret_key=database.server_secret_key,
             )
-            expected = default_timeout_seconds
-            assert vws_client.request_timeout_seconds == expected
+
+            if expect_timeout:
+                with pytest.raises(
+                    expected_exception=requests.exceptions.Timeout,
+                ):
+                    vws_client.add_target(
+                        name="x",
+                        width=1,
+                        image=image,
+                        active_flag=True,
+                        application_metadata=None,
+                    )
+            else:
+                vws_client.add_target(
+                    name="x",
+                    width=1,
+                    image=image,
+                    active_flag=True,
+                    application_metadata=None,
+                )
 
     @staticmethod
     @pytest.mark.parametrize(