All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog.
- Fix race condition when removing closed connections from the pool (#437)
- Failed connections no longer remain in the pool. (Pull #433)
max_connections
becomes optional. (Pull #429)certifi
is now included in the install dependancies. (Pull #428)h2
is now strictly optional. (Pull #428)
The 0.14 release is a complete reworking of httpcore
, comprehensively addressing some underlying issues in the connection pooling, as well as substantially redesigning the API to be more user friendly.
Some of the lower-level API design also makes the components more easily testable in isolation, and the package now has 100% test coverage.
See discussion #419 for a little more background.
There's some other neat bits in there too, such as the "trace" extension, which gives a hook into inspecting the internal events that occur during the request/response cycle. This extension is needed for the HTTPX cli, in order to...
- Log the point at which the connection is established, and the IP/port on which it is made.
- Determine if the outgoing request should log as HTTP/1.1 or HTTP/2, rather than having to assume it's HTTP/2 if the --http2 flag was passed. (Which may not actually be true.)
- Log SSL version info / certificate info.
Note that curio
support is not currently available in 0.14.0. If you're using httpcore
with curio
please get in touch, so we can assess if we ought to prioritize it as a feature or not.
- Fix broken error messaging when URL scheme is missing, or a non HTTP(S) scheme is used. (Pull #403)
- Close sockets when read or write timeouts occur. (Pull #365)
- Resolved niggles with AnyIO EOF behaviours. (Pull #358, #362)
- Improved error messaging when URL scheme is missing, or a non HTTP(S) scheme is used. (Pull #354)
- Switched to
anyio
as the default backend implementation when running withasyncio
. Resolves some awkward TLS timeout issues.
- Support HTTP/2 prior knowledge, using
httpcore.SyncConnectionPool(http1=False)
. (Pull #333)
- Handle cases where environment does not provide
select.poll
support. (Pull #331)
- Improve error message for specific case of
RemoteProtocolError
where server disconnects without sending a response. (Pull #313)
- More resiliant testing for closed connections. (Pull #311)
- Don't raise exceptions on ungraceful connection closes. (Pull #310)
The 0.13 release updates the core API in order to match the HTTPX Transport API, introduced in HTTPX 0.18 onwards.
An example of making requests with the new interface is:
with httpcore.SyncConnectionPool() as http:
status_code, headers, stream, extensions = http.handle_request(
method=b'GET',
url=(b'https', b'example.org', 443, b'/'),
headers=[(b'host', b'example.org'), (b'user-agent', b'httpcore')]
stream=httpcore.ByteStream(b''),
extensions={}
)
body = stream.read()
print(status_code, body)
- The
.request()
method is nowhandle_request()
. (Pull #296) - The
.arequest()
method is now.handle_async_request()
. (Pull #296) - The
headers
argument is no longer optional. (Pull #296) - The
stream
argument is no longer optional. (Pull #296) - The
ext
argument is now namedextensions
, and is no longer optional. (Pull #296) - The
"reason"
extension keyword is now named"reason_phrase"
. (Pull #296) - The
"reason_phrase"
and"http_version"
extensions now use byte strings for their values. (Pull #296) - The
httpcore.PlainByteStream()
class becomeshttpcore.ByteStream()
. (Pull #296)
- Streams now support a
.read()
interface. (Pull #296)
- Task cancellation no longer leaks connections from the connection pool. (Pull #305)
- Abort SSL connections on close rather than waiting for remote EOF when using
asyncio
. (Pull #167) - Fix exception raised in case of connect timeouts when using the
anyio
backend. (Pull #236) - Fix
Host
header precedence for:authority
in HTTP/2. (Pull #241, #243) - Handle extra edge case when detecting for socket readability when using
asyncio
. (Pull #242, #244) - Fix
asyncio
SSL warning when using proxy tunneling. (Pull #249)
- Properly wrap connect errors on the asyncio backend. (Pull #235)
- Fix
ImportError
occurring on Python 3.9 when using the HTTP/1.1 sync client in a multithreaded context. (Pull #237)
- Add connect retries. (Pull #221)
- Tweak detection of dropped connections, resolving an issue with open files limits on Linux. (Pull #185)
- Avoid leaking connections when establishing an HTTP tunnel to a proxy has failed. (Pull #223)
- Properly wrap OS errors when using
trio
. (Pull #225)
- HTTP header casing is now preserved, rather than always sent in lowercase. (#216 and python-hyper/h11#104)
- Add Python 3.9 to officially supported versions.
- Gracefully handle a stdlib asyncio bug when a connection is closed while it is in a paused-for-reading state. (#201)
- Add await to async semaphore release() coroutine (#197)
- Drop incorrect curio classifier (#192)
The Transport API with 0.11.0 has a couple of significant changes.
Firstly we've moved changed the request interface in order to allow extensions, which will later enable us to support features such as trailing headers, HTTP/2 server push, and CONNECT/Upgrade connections.
The interface changes from:
def request(method, url, headers, stream, timeout):
return (http_version, status_code, reason, headers, stream)
To instead including an optional dictionary of extensions on the request and response:
def request(method, url, headers, stream, ext):
return (status_code, headers, stream, ext)
Having an open-ended extensions point will allow us to add later support for various optional features, that wouldn't otherwise be supported without these API changes.
In particular:
- Trailing headers support.
- HTTP/2 Server Push
- sendfile.
- Exposing raw connection on CONNECT, Upgrade, HTTP/2 bi-di streaming.
- Exposing debug information out of the API, including template name, template context.
Currently extensions are limited to:
- request:
timeout
- Optional. Timeout dictionary. - response:
http_version
- Optional. Include the HTTP version used on the response. - response:
reason
- Optional. Include the reason phrase used on the response. Only valid with HTTP/1.*.
See encode/httpx#1274 (comment) for the history behind this.
Secondly, the async version of request
is now namespaced as arequest
.
This allows concrete transports to support both sync and async implementations on the same class.
- Add curio support. (Pull #168)
- Add anyio support, with
backend="anyio"
. (Pull #169)
- Update the Transport API to use 'ext' for optional extensions. (Pull #190)
- Update the Transport API to use
.request
and.arequest
so implementations can support both sync and async. (Pull #189)
- Added Unix Domain Socket support. (Pull #139)
- Always include the port on proxy CONNECT requests. (Pull #154)
- Fix
max_keepalive_connections
configuration. (Pull #153) - Fixes behaviour in HTTP/1.1 where server disconnects can be used to signal the end of the response body. (Pull #164)
- Include
max_keepalive_connections
onAsyncHTTPProxy
/SyncHTTPProxy
classes.
The most notable change in the 0.10.0 release is that HTTP/2 support is now fully optional.
Use either pip install httpcore
for HTTP/1.1 support only, or pip install httpcore[http2]
for HTTP/1.1 and HTTP/2 support.
- HTTP/2 support becomes optional. (Pull #121, #130)
- Add
local_address=...
support. (Pull #100, #134) - Add
PlainByteStream
,IteratorByteStream
,AsyncIteratorByteStream
. TheAsyncByteSteam
andSyncByteStream
classes are now pure interface classes. (#133) - Add
LocalProtocolError
,RemoteProtocolError
exceptions. (Pull #129) - Add
UnsupportedProtocol
exception. (Pull #128) - Add
.get_connection_info()
method. (Pull #102, #137) - Add better TRACE logs. (Pull #101)
max_keepalive
is deprecated in favour ofmax_keepalive_connections
. (Pull #140)
- Improve handling of server disconnects. (Pull #112)
- Proper host resolution for sync case, including IPv6 support. (Pull #97)
- Close outstanding connections when connection pool is closed. (Pull #98)
- URL port becomes an
Optional[int]
instead ofint
. (Pull #92)
- Honor HTTP/2 max concurrent streams settings. (Pull #89, #90)
- Remove incorrect debug log. (Pull #83)
- Logging via HTTPCORE_LOG_LEVEL and HTTPX_LOG_LEVEL environment variables and TRACE level logging. (Pull #79)
- Reuse of connections on HTTP/2 in close concurrency situations. (Pull #81)
- Include
Host
andAccept
headers on proxy "CONNECT" requests. - De-duplicate any headers also contained in proxy_headers.
- HTTP/2 flag not being passed down to proxy connections.
- Fix connections using proxy forwarding requests not being added to the connection pool properly. (Pull #70)
- Allow inherintance of both
httpcore.AsyncByteStream
,httpcore.SyncByteStream
without type conflicts.
- Fixed tunnel proxy support.
### Added
- New
TimeoutException
base class.
- First integration with HTTPX.