* Drop sync client

* Drop unused imports

* Async only

* Update tests/test_decoders.py

Co-Authored-By: Florimond Manca <florimond.manca@gmail.com>

* Linting

* Update docs for async-only

* Import sorting

* Add async notes to docs

* Update README for 0.8 async switch

* Move auth away from middleware where possible

* Drop middleware sub-package

* Client.dispatcher -> Client.dispatch

* Docs tweak

* Linting

* Fix type checking issue

* Import ordering

* Fix up docstrings

* Minor docs fixes

* Linting

* Remove unused import

2019-11-27 12:10:10 +00:00

3.5 KiB

Raw Blame History

HTTPX

A next-generation HTTP client for Python.

HTTPX is an asynchronous client library that supports HTTP/1.1 and HTTP/2.

It can be used in high-performance async web frameworks, using either asyncio or trio, and is able to support making large numbers of concurrent requests.

!!! note The 0.8 release switched HTTPX into focusing exclusively on providing an async client. It is possible that we'll look at re-introducing a sync API at a later date.

Let's get started...

The standard Python REPL does not allow top-level async statements.

To run these async examples 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>...'

Features

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.
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

Documentation

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.

Dependencies

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.
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.

Installation

Install with pip:

$ pip install httpx

HTTPX requires Python 3.6+

3.5 KiB Raw Blame History