What, Why & How

Many developers will be surprised to learn that requests library calls do not include timeouts by default. This means that an attempted request could hang indefinitely if no connection is established or if no data is received from the server.

The requests documentation suggests that most calls should explicitly include a timeout parameter. This codemod adds a default timeout value in order to set an upper bound on connection times and ensure that requests connect or fail in a timely manner. This value also ensures the connection will timeout if the server does not respond with data within a reasonable amount of time.

While timeout values will be application dependent, we believe that this codemod adds a reasonable default that serves as an appropriate ceiling for most situations.

Our changes look like the following:

 import requests
 
- requests.get("http://example.com")
+ requests.get("http://example.com", timeout=60)

Can this PR break any existing features. If yes, please list possible items. If no, please explain why. (PS: Admins do not merge the PR without this section filled)

• If this logic is not in place, requests could last longer than they should. However, if you do have a request that you know should take more than 60 seconds, then there could be issues but I believe that case to be situational/rare.

Database Migrations

• N/A

Env Config

• N/A

Relevant Docs

• Mentioned above, but will link here as well: * https://docs.python-requests.org/en/master/user/quickstart/#timeouts

Related Issues or PRs

• N/A

Dependencies Versions

• N/A

Notes on Testing

• Requests will have a definite time before they are timed out.

Screenshots

Checklist

I have read and understood the Contribution Guidelines.

🧚🤖 Powered by Pixeebot