From: František Nesveda <fnesveda@users.noreply.github.com>
Date: Mon, 7 Nov 2022 14:25:49 +0000 (+0100)
Subject: Mention default timeout differences from Requests in compatibility docs (#2433)
X-Git-Tag: 0.23.1~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a2a69e4bf7fc071b3ad237a643b306e5e131337f;p=thirdparty%2Fhttpx.git

Mention default timeout differences from Requests in compatibility docs (#2433)

I was recently migrating a project from Requests to HTTPX, and I stumbled a bit on the default socket timeouts being different between the two, which I haven't seen explicitly mentioned anywhere.

This adds a mention of those differences to the compatibility section, feel free to edit it or move it around as you choose.
---

diff --git a/docs/compatibility.md b/docs/compatibility.md
index 2a9cbd85..de8f7017 100644
--- a/docs/compatibility.md
+++ b/docs/compatibility.md
@@ -145,6 +145,16 @@ Within a `stream()` block request data is made available with:
 * `.iter_raw()` - Use this instead of `response.raw`
 * `.read()` - Read the entire response body, making `request.text` and `response.content` available.
 
+## Timeouts
+
+HTTPX defaults to including reasonable [timeouts](quickstart.md#timeouts) for all network operations, while Requests has no timeouts by default.
+
+To get the same behavior as Requests, set the `timeout` parameter to `None`:
+
+```python
+httpx.get('https://www.example.com', timeout=None)
+```
+
 ## Proxy keys
 
 When using `httpx.Client(proxies={...})` to map to a selection of different proxies, we use full URL schemes, such as `proxies={"http://": ..., "https://": ...}`.