encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c08ae7796f
httpx/docs/index.md

4.1 KiB
Raw Blame History

HTTPX

HTTPX

Build Status Coverage Package version

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 HTTPX should currently 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 http==0.8.*.

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][sync-support]. If
you have been using the sync client, you may want to pin to `http==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 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:

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, or the HTTP/2 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+