HTTPX - A next-generation HTTP client for Python.
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.
Note: HTTPX should 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
release, so that you're able to properly review API changes between package updates. A 1.0 release is expected to be issued sometime in 2021.
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 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.
- 100% 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
Install with pip:
$ pip install httpx
Or, to include the optional HTTP/2 support, use:
$ pip install httpx[http2]
HTTPX requires Python 3.6+.
Project documentation is available at https://www.python-httpx.org/.
For a run-through of all the basics, head over to the QuickStart.
The Developer Interface provides a comprehensive API reference.
To find out about tools that integrate with HTTPX, see Third Party Packages.
If you want to contribute with HTTPX check out the Contributing Guide to learn how to start.
The HTTPX project relies on these excellent libraries:
httpcore- The underlying transport implementation for
h11- HTTP/1.1 support.
h2- HTTP/2 support. (Optional)
certifi- SSL certificates.
rfc3986- URL parsing & normalization.
idna- Internationalized domain name support.
sniffio- Async library autodetection.
async_generator- Backport support for
contextlib.asynccontextmanager. (Only required for Python 3.6)
brotlicffi- 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.
HTTPX is BSD licensed code. Designed & built in Brighton, England.