Skip to content

Commit 90a452e

Browse files
adamtheturtleclaude
andcommitted
Rename transport timeout parameter to request_timeout
Avoids triggering ruff ASYNC109 (which flags async functions with a `timeout` parameter) without needing a lint suppression. The name `request_timeout` is also more descriptive of its purpose as an HTTP request timeout passed through to httpx/requests. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
1 parent cdc9e43 commit 90a452e

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

src/vws/_vws_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,5 @@ def target_api_request(
7272
url=url,
7373
headers=headers,
7474
data=data,
75-
timeout=request_timeout_seconds,
75+
request_timeout=request_timeout_seconds,
7676
)

src/vws/query.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ def query(
152152
url=self._base_vwq_url.rstrip("/") + request_path,
153153
headers=headers,
154154
data=content,
155-
timeout=self._request_timeout_seconds,
155+
request_timeout=self._request_timeout_seconds,
156156
)
157157

158158
if response.status_code == HTTPStatus.REQUEST_ENTITY_TOO_LARGE:

src/vws/transports.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def __call__(
2424
url: str,
2525
headers: dict[str, str],
2626
data: bytes,
27-
timeout: float | tuple[float, float],
27+
request_timeout: float | tuple[float, float],
2828
) -> Response:
2929
"""Make an HTTP request.
3030
@@ -33,7 +33,7 @@ def __call__(
3333
url: The full URL to request.
3434
headers: Headers to send with the request.
3535
data: The request body as bytes.
36-
timeout: The timeout for the request. A float
36+
request_timeout: The timeout for the request. A float
3737
sets both the connect and read timeouts. A
3838
(connect, read) tuple sets them individually.
3939
@@ -57,7 +57,7 @@ def __call__(
5757
url: str,
5858
headers: dict[str, str],
5959
data: bytes,
60-
timeout: float | tuple[float, float],
60+
request_timeout: float | tuple[float, float],
6161
) -> Response:
6262
"""Make an HTTP request using ``requests``.
6363
@@ -66,7 +66,7 @@ def __call__(
6666
url: The full URL.
6767
headers: Request headers.
6868
data: The request body.
69-
timeout: The request timeout.
69+
request_timeout: The request timeout.
7070
7171
Returns:
7272
A Response populated from the requests response.
@@ -76,7 +76,7 @@ def __call__(
7676
url=url,
7777
headers=headers,
7878
data=data,
79-
timeout=timeout,
79+
timeout=request_timeout,
8080
)
8181

8282
return Response(
@@ -105,7 +105,7 @@ def __call__(
105105
url: str,
106106
headers: dict[str, str],
107107
data: bytes,
108-
timeout: float | tuple[float, float],
108+
request_timeout: float | tuple[float, float],
109109
) -> Response:
110110
"""Make an HTTP request using ``httpx``.
111111
@@ -114,13 +114,13 @@ def __call__(
114114
url: The full URL.
115115
headers: Request headers.
116116
data: The request body.
117-
timeout: The request timeout.
117+
request_timeout: The request timeout.
118118
119119
Returns:
120120
A Response populated from the httpx response.
121121
"""
122-
if isinstance(timeout, tuple):
123-
connect_timeout, read_timeout = timeout
122+
if isinstance(request_timeout, tuple):
123+
connect_timeout, read_timeout = request_timeout
124124
httpx_timeout = httpx.Timeout(
125125
connect=connect_timeout,
126126
read=read_timeout,
@@ -129,8 +129,8 @@ def __call__(
129129
)
130130
else:
131131
httpx_timeout = httpx.Timeout(
132-
connect=timeout,
133-
read=timeout,
132+
connect=request_timeout,
133+
read=request_timeout,
134134
write=None,
135135
pool=None,
136136
)

tests/test_transports.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def test_float_timeout() -> None:
2828
url="https://example.com/test",
2929
headers={"Content-Type": "text/plain"},
3030
data=b"hello",
31-
timeout=30.0,
31+
request_timeout=30.0,
3232
)
3333
assert route.called
3434
assert isinstance(response, Response)
@@ -54,7 +54,7 @@ def test_tuple_timeout() -> None:
5454
url="https://example.com/test",
5555
headers={"Content-Type": "text/plain"},
5656
data=b"hello",
57-
timeout=(5.0, 30.0),
57+
request_timeout=(5.0, 30.0),
5858
)
5959
assert route.called
6060
assert isinstance(response, Response)

0 commit comments

Comments
 (0)