From: Srikanth Chekuri Date: Wed, 25 Mar 2020 21:33:16 +0000 (+0530) Subject: Add docs on request instances to Requests compatibility guide (#823) X-Git-Tag: 0.13.0.dev0~20 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5cf1acc403f99b683ab058dc95c79172caef0eef;p=thirdparty%2Fhttpx.git Add docs on request instances to Requests compatibility guide (#823) * Update docs/compatibility.md * Add prepare_request equivalent of httpx to compatibility document * Add difference b/w httpx.Request and requests.Request arguments to compatibility document * Update docs/compatibility.md * Remove Request arguments section * Add new section Request instantiation with necessary info * Update docs/compatibility.md Commit the suggested changes Co-Authored-By: Florimond Manca Co-authored-by: Florimond Manca --- diff --git a/docs/compatibility.md b/docs/compatibility.md index 89235b12..c827f352 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -64,6 +64,12 @@ is generally equivalent to client = httpx.Client(**kwargs) ``` +## Request instantiation + +There is no notion of [prepared requests](https://requests.readthedocs.io/en/stable/user/advanced/#prepared-requests) in HTTPX. If you need to customize request instantiation, see [Request instances](/advanced#request-instances). + +Besides, `httpx.Request()` does not support the `auth`, `timeout`, `allow_redirects`, `proxies`, `verify` and `cert` parameters. However these are available in `httpx.request`, `httpx.get`, `httpx.post` etc., as well as on [`Client` instances](/advanced#client-instances). + ## Mocking If you need to mock HTTPX the same way that test utilities like `responses` and `requests-mock` does for `requests`, see [RESPX](https://github.com/lundberg/respx).