docs: document exceptions raised by request()#7356
Open
Conversation
Adds :raises: entries to the request() docstring listing the exceptions that can be raised, as requested in psf#6653. The exceptions are documented on the main request() function only to avoid duplication across the convenience methods (get, post, put, etc.) that all delegate to request(). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Author
|
Hi! Just checking in on this PR — happy to make any changes if needed. Thanks! |
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
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.
Closes #6653
Summary
Adds
:raises:RST docstring entries to therequest()function documenting the exceptions that callers should be prepared to handle.The documentation is added only on the main
request()function (not repeated on each convenience method likeget(),post(), etc.) to avoid duplication — all convenience methods delegate torequest()and can raise the same exceptions.Exceptions documented
ConnectionErrorTimeoutConnectTimeoutandReadTimeout)TooManyRedirectsURLRequiredMissingSchemahttp://)InvalidSchemaInvalidURLInvalidHeaderThese match the exceptions listed in the Requests exceptions API docs that are relevant to the request() call itself (as opposed to exceptions from response processing like
JSONDecodeError).