Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update compatibility.md: mention differing query parameter handling #1262

Merged
merged 5 commits into from
Sep 10, 2020
Merged

Update compatibility.md: mention differing query parameter handling #1262

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dd021cd
Update compatibility.md
Sep 4, 2020
f6f3e09
Update docs/compatibility.md
Sep 5, 2020
af68c27
Merge branch 'master' into master
tomchristie Sep 7, 2020
cebea27
Update docs/compatibility.md
tomchristie Sep 10, 2020
c90f13c
Merge branch 'master' into master
tomchristie Sep 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/compatibility.md
View file
Open in desktop
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 compatible with the `requests` API where we feel it makes sense.
florimondmanca marked this conversation as resolved.
Show resolved Hide resolved
louwers marked this conversation as resolved.
Show resolved Hide resolved

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})`). HTTPX will include a query parameter without a value instead.
tomchristie marked this conversation as resolved.
Show resolved Hide resolved