Skip to content

Commit

Permalink
Update compatibility.md: mention differing query parameter handling (#…
Browse files Browse the repository at this point in the history
…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>
  • Loading branch information
3 people committed Sep 10, 2020
1 parent 6006721 commit 4bd08be
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/compatibility.md
Original file line number Diff line number Diff line change
@@ -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...

Expand Down Expand Up @@ -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.

0 comments on commit 4bd08be

Please sign in to comment.