Skip to content

Add timeout best practices to documentation #7133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kana44 wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

Add timeout best practices to documentation #7133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/user/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1136,3 +1136,18 @@ coffee.

.. _`wall clock`: https://wiki.php.net/rfc/max_execution_wall_time
.. _`connect()`: https://linux.die.net/man/2/connect

Timeout Best Practices
---------------------

Using timeouts helps prevent requests from hanging indefinitely.
It is generally recommended to specify a timeout value for production code.

For example::

requests.get('https://example.com', timeout=5)

Note: A timeout value does not limit the total time of the request. It applies to
the connect and read operations (see the section above).

This can improve application reliability and make error handling more predictable.