Merge pull request #2879 from VWS-Python/adamtheturtle/rename-timeout-to-request-timeout

Rename transport timeout parameter to request_timeout

Author: adamtheturtle

src/vws/_vws_request.py

@@ -72,5 +72,5 @@ def target_api_request(
         url=url,
         headers=headers,
         data=data,
-        timeout=request_timeout_seconds,
+        request_timeout=request_timeout_seconds,
     )

src/vws/query.py

@@ -152,7 +152,7 @@ def query(
             url=self._base_vwq_url.rstrip("/") + request_path,
             headers=headers,
             data=content,
-            timeout=self._request_timeout_seconds,
+            request_timeout=self._request_timeout_seconds,
         )
 
         if response.status_code == HTTPStatus.REQUEST_ENTITY_TOO_LARGE:

src/vws/transports.py

@@ -24,7 +24,7 @@ def __call__(
         url: str,
         headers: dict[str, str],
         data: bytes,
-        timeout: float | tuple[float, float],
+        request_timeout: float | tuple[float, float],
     ) -> Response:
         """Make an HTTP request.
 
@@ -33,7 +33,7 @@ def __call__(
             url: The full URL to request.
             headers: Headers to send with the request.
             data: The request body as bytes.
-            timeout: The timeout for the request. A float
+            request_timeout: The timeout for the request. A float
                 sets both the connect and read timeouts. A
                 (connect, read) tuple sets them individually.
 
@@ -57,7 +57,7 @@ def __call__(
         url: str,
         headers: dict[str, str],
         data: bytes,
-        timeout: float | tuple[float, float],
+        request_timeout: float | tuple[float, float],
     ) -> Response:
         """Make an HTTP request using ``requests``.
 
@@ -66,7 +66,7 @@ def __call__(
             url: The full URL.
             headers: Request headers.
             data: The request body.
-            timeout: The request timeout.
+            request_timeout: The request timeout.
 
         Returns:
             A Response populated from the requests response.
@@ -76,7 +76,7 @@ def __call__(
             url=url,
             headers=headers,
             data=data,
-            timeout=timeout,
+            timeout=request_timeout,
         )
 
         return Response(
@@ -105,7 +105,7 @@ def __call__(
         url: str,
         headers: dict[str, str],
         data: bytes,
-        timeout: float | tuple[float, float],
+        request_timeout: float | tuple[float, float],
     ) -> Response:
         """Make an HTTP request using ``httpx``.
 
@@ -114,13 +114,13 @@ def __call__(
             url: The full URL.
             headers: Request headers.
             data: The request body.
-            timeout: The request timeout.
+            request_timeout: The request timeout.
 
         Returns:
             A Response populated from the httpx response.
         """
-        if isinstance(timeout, tuple):
-            connect_timeout, read_timeout = timeout
+        if isinstance(request_timeout, tuple):
+            connect_timeout, read_timeout = request_timeout
             httpx_timeout = httpx.Timeout(
                 connect=connect_timeout,
                 read=read_timeout,
@@ -129,8 +129,8 @@ def __call__(
             )
         else:
             httpx_timeout = httpx.Timeout(
-                connect=timeout,
-                read=timeout,
+                connect=request_timeout,
+                read=request_timeout,
                 write=None,
                 pool=None,
             )

tests/test_transports.py

@@ -28,7 +28,7 @@ def test_float_timeout() -> None:
             url="https://example.com/test",
             headers={"Content-Type": "text/plain"},
             data=b"hello",
-            timeout=30.0,
+            request_timeout=30.0,
         )
         assert route.called
         assert isinstance(response, Response)
@@ -54,7 +54,7 @@ def test_tuple_timeout() -> None:
             url="https://example.com/test",
             headers={"Content-Type": "text/plain"},
             data=b"hello",
-            timeout=(5.0, 30.0),
+            request_timeout=(5.0, 30.0),
         )
         assert route.called
         assert isinstance(response, Response)