HTTPX is a fully featured HTTP client for Python 3, which provides sync and async APIs, and support for both HTTP/1.1 and HTTP/2.
HTTPX should currently be considered in beta.
We believe we've got the public API to a stable point now, but would strongly recommend pinning your dependencies to the
0.11.* release, so that you're able to properly review API changes between package updates.
A 1.0 release is expected to be issued sometime on or before April 2020.
Let's get started...
>>> import httpx >>> r = httpx.get('https://www.example.org/') >>> r <Response [200 OK]> >>> r.status_code 200 >>> r.headers['content-type'] 'text/html; charset=UTF-8' >>> r.text '<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
Or, using the async API...
Use IPython or Python 3.8+ with
python -m asyncio to try this code interactively.
>>> import httpx >>> async with httpx.AsyncClient() as client: >>> r = await client.get('https://www.example.org/') >>> r <Response [200 OK]>
HTTPX is a high performance asynchronous HTTP client, that builds on the
well-established usability of
requests, and gives you:
- A broadly requests-compatible API.
- Standard synchronous interface, but with async support if you need it.
- HTTP/1.1 and HTTP/2 support.
- Ability to make requests directly to WSGI applications or ASGI applications.
- Strict timeouts everywhere.
- Fully type annotated.
- 99% test coverage.
Plus all the standard features of
- International Domains and URLs
- Keep-Alive & Connection Pooling
- Sessions with Cookie Persistence
- Browser-style SSL Verification
- Basic/Digest Authentication
- Elegant Key/Value Cookies
- Automatic Decompression
- Automatic Content Decoding
- Unicode Response Bodies
- Multipart File Uploads
- HTTP(S) Proxy Support
- Connection Timeouts
- Streaming Downloads
- .netrc Support
- Chunked Requests
For a run-through of all the basics, head over to the QuickStart.
The Developer Interface provides a comprehensive API reference.
The HTTPX project relies on these excellent libraries:
urllib3- Sync client support.
h11- HTTP/1.1 support.
h2- HTTP/2 support.
certifi- SSL certificates.
chardet- Fallback auto-detection for response encoding.
hstspreload- determines whether IDNA-encoded host should be only accessed via HTTPS.
idna- Internationalized domain name support.
rfc3986- URL parsing & normalization.
brotlipy- Decoding for "brotli" compressed responses. (Optional)
A huge amount of credit is due to
requests for the API layout that
much of this work follows, as well as to
urllib3 for plenty of design
inspiration around the lower-level networking details.
Install with pip:
$ pip install httpx
HTTPX requires Python 3.6+