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 <florimond.manca@gmail.com>

Co-authored-by: Tom Christie <tom@tomchristie.com>
Co-authored-by: Florimond Manca <florimond.manca@gmail.com>
This commit is contained in:
Bart 2020-09-10 21:22:14 +02:00 committed by GitHub
parent 6006721c6d
commit 4bd08bed22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.