Fix timeout type hint in RequestsClient#1537
Merged
helenye-stripe merged 1 commit intoJul 11, 2025
Merged
Conversation
The `RequestsClient`'s `__init__` method incorrectly typed the `timeout` parameter as `int`. The underlying `requests` library accepts a float for a total timeout or a `(connect_timeout, read_timeout)` tuple. This commit updates the type hint to `Union[float, Tuple[float, float]]` to accurately reflect the timeout in the requests library. https://github.com/psf/requests/blob/91a3eabd3dcc4d7f36dd8249e4777a90ef9b4305/src/requests/sessions.py#L538
|
|
|
|
1 similar comment
|
|
Contributor
Author
|
Good job bot (@cla-assistant) but why 3 duplicate message? |
Contributor
|
@abe-101 Thanks for this change! |
helenye-stripe
approved these changes
Jul 11, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The
RequestsClient's__init__method incorrectly typed thetimeoutparameter asint. The underlyingrequestslibrary accepts a float for a total timeout or a(connect_timeout, read_timeout)tuple.What?
This commit updates the type hint to
Union[float, Tuple[float, float]]to accurately reflect the timeout in the requests library.See Also
https://github.com/psf/requests/blob/91a3eabd3dcc4d7f36dd8249e4777a90ef9b4305/src/requests/sessions.py#L538