From 4bd08bed22094c83d61a750711e3e8b410aead0e Mon Sep 17 00:00:00 2001 From: Bart Date: Thu, 10 Sep 2020 21:22:14 +0200 Subject: [PATCH] Update compatibility.md: mention differing query parameter handling (#1262) * Update compatibility.md * Update docs/compatibility.md * Update docs/compatibility.md Co-authored-by: Florimond Manca Co-authored-by: Tom Christie Co-authored-by: Florimond Manca --- docs/compatibility.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/compatibility.md b/docs/compatibility.md index daef4994a7..c52b887b25 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,6 +1,6 @@ # Requests Compatibility Guide -HTTPX aims to be compatible with the `requests` API wherever possible. +HTTPX aims to be broadly compatible with the `requests` API. This documentation outlines places where the API differs... @@ -89,3 +89,7 @@ If you need to mock HTTPX the same way that test utilities like `responses` and `requests` defers most of its HTTP networking code to the excellent [`urllib3` library](https://urllib3.readthedocs.io/en/latest/). On the other hand, HTTPX uses [HTTPCore](https://github.com/encode/httpcore) as its core HTTP networking layer, which is a different project than `urllib3`. + +## Query Parameters + +`requests` omits `params` whose values are `None` (e.g. `requests.get(..., params={"foo": None})`). This is not supported by HTTPX.