The next generation HTTP client.
Project description
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>...'
Features
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
Installation
Install with pip:
$ pip install httpx
httpx requires Python 3.6+
Documentation
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.
Contribute
If you want to contribute with HTTPX check out the Contributing Guide to learn how to start.
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.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.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog.
0.9.5 (December 20th, 2019)
Fixed
- Fix Host header and HSTS rewrites when an explicit
:80port is included in URL. (Pull #649) - Query Params on the URL string are merged with any
params=...argument. (Pull #653) - More robust behavior when closing connections. (Pull #640)
- More robust behavior when handling HTTP/2 headers with trailing whitespace. (Pull #637)
- Allow any explicit
Content-Typeheader to take precedence over the encoding default. (Pull #633)
0.9.4 (December 12th, 2019)
Fixed
- Added expiry to Keep-Alive connections, resolving issues with acquiring connections. (Pull #627)
- Increased flow control windows on HTTP/2, resolving download speed issues. (Pull #629)
0.9.3 (December 7th, 2019)
Fixed
- Fixed HTTP/2 with autodetection backend. (Pull #614)
0.9.2 (December 7th, 2019)
- Released due to packaging build artifact.
0.9.1 (December 6th, 2019)
- Released due to packaging build artifact.
0.9.0 (December 6th, 2019)
The 0.9 releases brings some major new features, including:
- A new streaming API.
- Autodetection of either asyncio or trio.
- Nicer timeout configuration.
- HTTP/2 support off by default, but can be enabled.
We've also removed all private types from the top-level package export.
In order to ensure you are only ever working with public API you should make
sure to only import the top-level package eg. import httpx, rather than
importing modules within the package.
Added
- Added concurrency backend autodetection. (Pull #585)
- Added
Client(backend='trio')andClient(backend='asyncio')API. (Pull #585) - Added
response.stream_lines()API. (Pull #575) - Added
response.is_errorAPI. (Pull #574) - Added support for
timeout=Timeout(5.0, connect_timeout=60.0)styles. (Pull #593)
Fixed
- Requests or Clients with
timeout=Nonenow correctly always disable timeouts. (Pull #592) - Request 'Authorization' headers now have priority over
.netrcauthentication info. (Commit 095b691) - Files without a filename no longer set a Content-Type in multipart data. (Commit ed94950)
Changed
- Added
httpx.stream()API. Usingstream=Truenow results in a warning. (Pull #600, #610) - HTTP/2 support is switched to "off by default", but can be enabled explicitly. (Pull #584)
- Switched to
Client(http2=True)API fromClient(http_versions=["HTTP/1.1", "HTTP/2"]). (Pull #586) - Removed all private types from the top-level package export. (Pull #608)
- The SSL configuration settings of
verify,cert, andtrust_envnow raise warnings if used per-request when using a Client instance. They should always be set on the Client instance itself. (Pull #597) - Use plain strings "TUNNEL_ONLY" or "FORWARD_ONLY" on the HTTPProxy
proxy_modeargument. TheHTTPProxyModeenum still exists, but its usage will raise warnings. (#610) - Pool timeouts are now on the timeout configuration, not the pool limits configuration. (Pull #563)
- The timeout configuration is now named
httpx.Timeout(...), nothttpx.TimeoutConfig(...). The old version currently remains as a synonym for backwards compatability. (Pull #591)
0.8.0 (November 27, 2019)
Removed
- The synchronous API has been removed, in order to allow us to fundamentally change how we approach supporting both sync and async variants. (See #588 for more details.)
0.7.8 (November 17, 2019)
Added
- Add support for proxy tunnels for Python 3.6 + asyncio. (Pull #521)
0.7.7 (November 15, 2019)
Fixed
- Resolve an issue with cookies behavior on redirect requests. (Pull #529)
Added
- Add request/response DEBUG logs. (Pull #502)
- Use TRACE log level for low level info. (Pull #500)
0.7.6 (November 2, 2019)
Removed
- Drop
proxiesparameter from the high-level API. (Pull #485)
Fixed
- Tweak multipart files: omit null filenames, add support for
strfile contents. (Pull #482) - Cache NETRC authentication per-client. (Pull #400)
- Rely on
getproxiesfor all proxy environment variables. (Pull #470) - Wait for the
asynciostream to close when closing a connection. (Pull #494)
0.7.5 (October 10, 2019)
Added
- Allow lists of values to be passed to
params. (Pull #386) ASGIDispatch,WSGIDispatchare now available in thehttpx.dispatchnamespace. (Pull #407)HTTPErroris now available in thehttpxnamespace. (Pull #421)- Add support for
start_tls()to the Trio concurrency backend. (Pull #467)
Fixed
- Username and password are no longer included in the
Hostheader when basic authentication credentials are supplied via the URL. (Pull #417)
Removed
- The
.delete()function no longer hasjson,data, orfilesparameters to match the expected semantics of theDELETEmethod. (Pull #408) - Removed the
trioextra. Trio support is detected automatically. (Pull #390)
0.7.4 (September 25, 2019)
Added
- Add Trio concurrency backend. (Pull #276)
- Add
paramsparameter toClientfor setting default query parameters. (Pull #372) - Add support for
SSL_CERT_FILEandSSL_CERT_DIRenvironment variables. (Pull #307) - Add debug logging to calls into ASGI apps. (Pull #371)
- Add debug logging to SSL configuration. (Pull #378)
Fixed
- Fix a bug when using
Clientwithout timeouts in Python 3.6. (Pull #383) - Propagate
Clientconfiguration to HTTP proxies. (Pull #377)
0.7.3 (September 20, 2019)
Added
- HTTP Proxy support. (Pulls #259, #353)
- Add Digest authentication. (Pull #332)
- Add
.build_request()method toClientandAsyncClient. (Pull #319) - Add
.elapsedproperty on responses. (Pull #351) - Add support for
SSLKEYLOGFILEin Python 3.8b4+. (Pull #301)
Removed
- Drop NPN support for HTTP version negotiation. (Pull #314)
Fixed
- Fix distribution of type annotations for mypy (Pull #361).
- Set
Hostheader when redirecting cross-origin. (Pull #321) - Drop
Content-Lengthheaders onGETredirects. (Pull #310) - Raise
KeyErrorif header isn't found inHeaders. (Pull #324) - Raise
NotRedirectResponseinresponse.next()if there is no redirection to perform. (Pull #297) - Fix bug in calculating the HTTP/2 maximum frame size. (Pull #153)
0.7.2 (August 28, 2019)
- Enforce using
httpx.AsyncioBackendfor the synchronous client. (Pull #232) httpx.ConnectionPoolwill properly release a dropped connection. (Pull #230)- Remove the
raise_app_exceptionsargument fromClient. (Pull #238) DecodeErrorwill no longer be raised for an empty body encoded with Brotli. (Pull #237)- Added
http_versionsparameter toClient. (Pull #250) - Only use HTTP/1.1 on short-lived connections like
httpx.get(). (Pull #284) - Convert
Client.cookiesandClient.headerswhen set as a property. (Pull #274) - Setting
HTTPX_DEBUG=1enables debug logging on all requests. (Pull #277)
0.7.1 (August 18, 2019)
- Include files with source distribution to be installable. (Pull #233)
0.7.0 (August 17, 2019)
- Add the
trust_envproperty toBaseClient. (Pull #187) - Add the
linksproperty toBaseResponse. (Pull #211) - Accept
ssl.SSLContextinstances intoSSLConfig(verify=...). (Pull #215) - Add
Response.stream_text()with incremental encoding detection. (Pull #183) - Properly updated the
Hostheader when a redirect changes the origin. (Pull #199) - Ignore invalid
Content-Encodingheaders. (Pull #196) - Use
~/.netrcand~/_netrcfiles by default whentrust_env=True. (Pull #189) - Create exception base class
HTTPErrorwithrequestandresponseproperties. (Pull #162) - Add HSTS preload list checking within
BaseClientto upgrade HTTP URLs to HTTPS. (Pull #184) - Switch IDNA encoding from IDNA 2003 to IDNA 2008. (Pull #161)
- Expose base classes for alternate concurrency backends. (Pull #178)
- Improve Multipart parameter encoding. (Pull #167)
- Add the
headersproeprty toBaseClient. (Pull #159) - Add support for Google's
brotlilibrary. (Pull #156) - Remove deprecated TLS versions (TLSv1 and TLSv1.1) from default
SSLConfig. (Pull #155) - Fix
URL.join(...)to work similarly to RFC 3986 URL joining. (Pull #144)
0.6.8 (July 25, 2019)
- Check for disconnections when searching for an available
connection in
ConnectionPool.keepalive_connections(Pull #145) - Allow string comparison for
URLobjects (Pull #139) - Add HTTP status codes 418 and 451 (Pull #135)
- Add support for client certificate passwords (Pull #118)
- Enable post-handshake client cert authentication for TLSv1.3 (Pull #118)
- Disable using
commonNamefor hostname checking for OpenSSL 1.1.0+ (Pull #118) - Detect encoding for
Response.json()(Pull #116)
0.6.7 (July 8, 2019)
- Check for connection aliveness on re-acquiry (Pull #111)
0.6.6 (July 3, 2019)
- Improve
USER_AGENT(Pull #110) - Add
Connection: keep-aliveby default to HTTP/1.1 connections. (Pull #110)
0.6.5 (June 27, 2019)
- Include
Hostheader by default. (Pull #109) - Improve HTTP protocol detection. (Pull #107)
0.6.4 (June 25, 2019)
- Implement read and write timeouts (Pull #104)
0.6.3 (June 24, 2019)
- Handle early connection closes (Pull #103)
0.6.2 (June 23, 2019)
- Use urllib3's
DEFAULT_CIPHERSfor theSSLConfigobject. (Pull #100)
0.6.1 (June 21, 2019)
- Add support for setting a
base_urlon theClient.
0.6.0 (June 21, 2019)
- Honor
local_flow_control_windowfor HTTP/2 connections (Pull #98)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file httpx-0.9.5.tar.gz.
File metadata
- Download URL: httpx-0.9.5.tar.gz
- Upload date:
- Size: 60.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3f277b2a68c5d5fd83d89f80fec811ea6eb1c3c9e47a26f7ecc294c255b10b8d
|
|
| MD5 |
683f7ff687aa4cd3b7c73168dfc6295b
|
|
| BLAKE2b-256 |
13f4ae99c743887398cd375b955683f349a55261a148faf0f0ff6ce71430e4ad
|
File details
Details for the file httpx-0.9.5-py2.py3-none-any.whl.
File metadata
- Download URL: httpx-0.9.5-py2.py3-none-any.whl
- Upload date:
- Size: 65.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ea1ec7da0616eb74cadc4d4dc8e0c2cde0fcdb2d17bbc3e3d05153d52087139
|
|
| MD5 |
aa9e120ee037b4001abdd6d40804efcf
|
|
| BLAKE2b-256 |
cb9b333b8e25ef595c6c4dcf0d3e5ebf2ca5272b1b3826b990629adb6e611614
|
