mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-01 14:21:53 +00:00
757c75752e
## Summary S113 exists because `requests` doesn't have a default timeout, so request without timeout may hang indefinitely > B113: Test for missing requests timeout This plugin test checks for requests or httpx calls without a timeout specified. > > Nearly all production code should use this parameter in nearly all requests, **Failure to do so can cause your program to hang indefinitely.** But httpx has default timeout 5s, so S113 for httpx request without `timeout` argument is a false positive, only valid case would be `timeout=None`. https://www.python-httpx.org/advanced/timeouts/ > HTTPX is careful to enforce timeouts everywhere by default. > > The default behavior is to raise a TimeoutException after 5 seconds of network inactivity. ## Test Plan snap updated
72 lines
2.4 KiB
Python
72 lines
2.4 KiB
Python
import httpx
|
|
import requests
|
|
|
|
# OK
|
|
requests.get('https://gmail.com', timeout=5)
|
|
requests.post('https://gmail.com', timeout=5)
|
|
requests.put('https://gmail.com', timeout=5)
|
|
requests.delete('https://gmail.com', timeout=5)
|
|
requests.patch('https://gmail.com', timeout=5)
|
|
requests.options('https://gmail.com', timeout=5)
|
|
requests.head('https://gmail.com', timeout=5)
|
|
|
|
httpx.get('https://gmail.com', timeout=5)
|
|
httpx.post('https://gmail.com', timeout=5)
|
|
httpx.put('https://gmail.com', timeout=5)
|
|
httpx.delete('https://gmail.com', timeout=5)
|
|
httpx.patch('https://gmail.com', timeout=5)
|
|
httpx.options('https://gmail.com', timeout=5)
|
|
httpx.head('https://gmail.com', timeout=5)
|
|
httpx.Client(timeout=5)
|
|
httpx.AsyncClient(timeout=5)
|
|
with httpx.Client(timeout=5) as client:
|
|
client.get('https://gmail.com')
|
|
async def foo():
|
|
async with httpx.AsyncClient(timeout=5) as client:
|
|
await client.get('https://gmail.com')
|
|
|
|
httpx.get('https://gmail.com')
|
|
httpx.post('https://gmail.com')
|
|
httpx.put('https://gmail.com')
|
|
httpx.delete('https://gmail.com')
|
|
httpx.patch('https://gmail.com')
|
|
httpx.options('https://gmail.com')
|
|
httpx.head('https://gmail.com')
|
|
httpx.Client()
|
|
httpx.AsyncClient()
|
|
|
|
async def bar():
|
|
async with httpx.AsyncClient() as client:
|
|
await client.get('https://gmail.com')
|
|
|
|
with httpx.Client() as client:
|
|
client.get('https://gmail.com')
|
|
|
|
# Errors
|
|
requests.get('https://gmail.com')
|
|
requests.get('https://gmail.com', timeout=None)
|
|
requests.post('https://gmail.com')
|
|
requests.post('https://gmail.com', timeout=None)
|
|
requests.put('https://gmail.com')
|
|
requests.put('https://gmail.com', timeout=None)
|
|
requests.delete('https://gmail.com')
|
|
requests.delete('https://gmail.com', timeout=None)
|
|
requests.patch('https://gmail.com')
|
|
requests.patch('https://gmail.com', timeout=None)
|
|
requests.options('https://gmail.com')
|
|
requests.options('https://gmail.com', timeout=None)
|
|
requests.head('https://gmail.com')
|
|
requests.head('https://gmail.com', timeout=None)
|
|
|
|
httpx.get('https://gmail.com', timeout=None)
|
|
httpx.post('https://gmail.com', timeout=None)
|
|
httpx.put('https://gmail.com', timeout=None)
|
|
httpx.delete('https://gmail.com', timeout=None)
|
|
httpx.patch('https://gmail.com', timeout=None)
|
|
httpx.options('https://gmail.com', timeout=None)
|
|
httpx.head('https://gmail.com', timeout=None)
|
|
httpx.Client(timeout=None)
|
|
httpx.AsyncClient(timeout=None)
|
|
|
|
with httpx.Client(timeout=None) as client:
|
|
client.get('https://gmail.com')
|