ITADN

Add timeout to requests calls

#276Pull Requestcitizenjosh 创建于 2024-01-25
C
citizenjoshcommented
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](https://requests.readthedocs.io/en/latest/user/advanced/#timeouts) 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: ```diff import requests - requests.get("http://example.com") + requests.get("http://example.com", timeout=60) ``` <details> <summary>More reading</summary> * [https://docs.python-requests.org/en/master/user/quickstart/#timeouts](https://docs.python-requests.org/en/master/user/quickstart/#timeouts) </details> I have additional improvements ready for this repo! If you want to see them, leave the comment: ``` @pixeebot next ``` ... and I will open a new PR right away! Powered by: [pixeebot](https://docs.pixee.ai/) (codemod ID: [pixee:python/add-requests-timeouts](https://docs.pixee.ai/codemods/python/pixee_python_add-requests-timeouts)) ![](https://d1zaessa2hpsmj.cloudfront.net/pixel/v1/track?writeKey=2PI43jNm7atYvAuK7rJUz3Kcd6A&event=DRIP_PR%7Ccitizenjosh%2FAmpliGraph%7Ce56c1b15e8fd2127484be7cf0f3dba301a84b4ce) <!--{"type":"DRIP","codemod":"pixee:python/add-requests-timeouts"}-->
合并状态:未合并 关闭于 2024-12-10 0 条评论