Skip to content

Commit 9e34169

Browse files
authored
Merge pull request #25 from Spitfire1900/patch-1
Update README.md - add notes about specific libraries
2 parents d607936 + 79c7960 commit 9e34169

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55

66
A flake8 plugin that checks for missing `timeout` parameters in network calls.
77

8-
By default, the plugin checks common HTTP libraries but can be configured to track any function that accepts a timeout parameter.
8+
[requests](https://requests.readthedocs.io/en/latest/api/#requests.Session.request) and [urllib.request.urlopen](https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen) do not set timeouts by default unlike [httpx](https://www.python-httpx.org/advanced/timeouts/) and [aiohttp](https://docs.aiohttp.org/en/stable/client_quickstart.html#timeouts).
9+
10+
flake8-timeout checks `requests` and `urllib.request.urlopen` calls by default but can be configured to track any function that accepts a timeout parameter.
911

1012
## installation
1113

0 commit comments

Comments
 (0)