Add timeout to requests calls

[pixeeai]

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

• https://docs.python-requests.org/en/master/user/quickstart/#timeouts

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

[pixeeai]

FYI - This change was autogenerated from a new trending GitHub app - called Pixeebot. A code-quality GitHub App; like Dependabot, but for source code.

[FurkanGozukara]

FYI - This change was autogenerated from a new trending GitHub app - called Pixeebot. A code-quality GitHub App; like Dependabot, but for source code.

60 second is very low in some cases

what is default timeout?

[dunningdan]

@FurkanGozukara 👋 I'm Dan, one of the developers on the pixee team. Great question! Since therequests library does not have a default timeout it's going to hang until it gets a response, this could be a few seconds to several minutes. This PR suggests 60 seconds as a default(as it may be good enough for 95% of use cases). As you pointed out, that may be on the lower side in some cases. If you find that to be the case for you, we recommend increasing that value as needed.

[pixeeai]

Any chance you've had the time to review these changes?

If you're not interested implementing them at this time, no worries. I can close the PR and follow up with additional changes in the future. Also, this plugin is free for non-commercial open sourced projects, so feel free to give it an install if you want to see the other recommended PRs.

Thanks,
Zach