register icon indicating copy to clipboard operation
register copied to clipboard

Add timeout to `requests` calls

Open pixeebot[bot] opened this issue 10 months ago • 3 comments

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)
More reading

Powered by: pixeebot (codemod ID: pixee:python/add-requests-timeouts)

pixeebot[bot] avatar Apr 21 '24 03:04 pixeebot[bot]

Deploy Preview for capable-cactus-9ea0d7 ready!

Name Link
Latest commit 4b341ab36acdcc6a8616ef9a83643678bb2f8e41
Latest deploy log https://app.netlify.com/sites/capable-cactus-9ea0d7/deploys/662484166e3bcf000886fed3
Deploy Preview https://deploy-preview-20--capable-cactus-9ea0d7.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 21 '24 03:04 netlify[bot]

I'm confident in this change, and the CI checks pass, too!

If you see any reason not to merge this, or you have suggestions for improvements, please let me know!

pixeebot[bot] avatar Apr 29 '24 03:04 pixeebot[bot]

Just a friendly ping to remind you about this change. If there are concerns about it, we'd love to hear about them!

pixeebot[bot] avatar Apr 30 '24 03:04 pixeebot[bot]

This change may not be a priority right now, so I'll close it. If there was something I could have done better, please let me know!

You can also customize me to make sure I'm working with you in the way you want.

pixeebot[bot] avatar May 06 '24 03:05 pixeebot[bot]