encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2af17c8d7a
httpx/docs/compatibility.md
Tom Christie fdc4ab2a89 Tweak compat docs
2019-06-17 17:28:27 +01:00

850 B
Raw Blame History

Requests Compatibility Guide

HTTP3 aims to be compatible with the requests API wherever possible.

This documentation outlines places where the API differs...

QuickStart

Pretty much all the API mentioned in the requests QuickStart should be identical to the API in our own documentation. The following exceptions apply:

  • Response.url - Returns a URL instance, rather than a string. Use str(response.url) if you need a string instance.
  • http3.codes - In our documentation we prefer the uppercased versions, such as codes.NOT_FOUND, but also provide lower-cased versions for API compatibility with requests.
  • stream=True. - Streaming responses provide the .stream() and .raw() byte iterator interfaces, rather than the .iter_content() method and the .raw socket interface.

Advanced Usage

!!! warning TODO