HTTPX - A next-generation HTTP client for Python.
HTTPX is an asynchronous HTTP client, that supports HTTP/2 and HTTP/1.1.
It can be used in high-performance async web frameworks, using either asyncio or trio, and is able to support making large numbers of requests concurrently.
Note: HTTPX should still be considered in alpha. We'd love early users and feedback,
but would strongly recommend pinning your dependencies to the latest median
release, so that you're able to properly review API changes between package
updates. Currently you should be using httpx==0.9.*
.
In particular, the 0.8 release switched HTTPX into focusing exclusively on
providing an async client, in order to move the project forward, and help
us change our approach to providing sync+async support. If
you have been using the sync client, you may want to pin to httpx==0.7.*
,
and wait until our sync client is reintroduced.
Let's get started...
The standard Python REPL does not allow top-level async statements.
To run async examples directly you'll probably want to either use ipython
,
or use Python 3.8 with python -m asyncio
.
>>> import httpx
>>> r = await httpx.get('https://www.example.org/')
>>> r
<Response [200 OK]>
>>> r.status_code
200
>>> r.http_version
'HTTP/1.1'
>>> r.headers['content-type']
'text/html; charset=UTF-8'
>>> r.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
HTTPX builds on the well-established usability of requests
, and gives you:
- A requests-compatible API wherever possible.
- HTTP/2 and HTTP/1.1 support.
- Ability to make requests directly to ASGI applications.
- Strict timeouts everywhere.
- Fully type annotated.
- 100% test coverage.
Plus all the standard features of requests
...
- 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
httpx requires Python 3.6+
Project documentation is available at www.encode.io/httpx/.
For a run-through of all the basics, head over to the QuickStart.
For more advanced topics, see the Advanced Usage section.
The Developer Interface provides a comprehensive API reference.
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:
h2
- HTTP/2 support.h11
- HTTP/1.1 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.sniffio
- Async library autodetection.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.
โ โญ๏ธ โ
HTTPX is BSD licensed code. Designed & built in Brighton, England.