pathapi-httpx

The httpx HTTP transports for pathapi. pathapi.http sends requests with a transport built on the standard library, and from an event loop with that transport on worker threads. Install this distribution and HTTPClient sends through an httpx.Client, and AsyncHTTPClient through an httpx.AsyncClient on the caller's loop, with nothing to configure. It is documented at https://jose-pr.github.io/pathapi-httpx/.

Features

• Credentials belong to one server. The auth of a client is sent to the server of the first request and to no other, and the clients of pathapi.http never take an Authorization header to another server on a redirect.
• Exactly the headers it is given. A client's default headers and cookies are not added: HTTPClient and AsyncHTTPClient own the headers of a request.
• No third-party text in an error. A failure of httpx is a TimeoutError, ConnectionError, ssl.SSLError, ValueError or OSError(EIO); what the library says, which can quote a URL, is never passed on.
• The same promises as the built-in transports. The tests pathapi runs over its own transports run over these (python -m pathapi.http.testing --http-transports httpx --http-async-transports httpx).

Installation

pip install pathapi-httpx

Requires pathapi and httpx, which pip installs with it. HTTP/2 needs pip install "httpx[http2]".

Quick start

Send through an httpx.Client from threads or a script:

import httpx
from pathapi.http import HTTPClient
from pathapi_httpx import HttpxTransport

with httpx.Client() as session:
    with HTTPClient(HttpxTransport(session), timeout=(3, 30)) as client:
        reply = client.request("GET", "http://files.example.org/reports/today.txt")
        print(reply.read().decode())

The httpx.Client stays yours: neither the client nor the transport closes it.

Send from an event loop with httpx.AsyncClient on that loop:

import asyncio

from pathapi.http import AsyncHTTPClient
from pathapi_httpx import AsyncHttpxTransport


async def main():
    async with AsyncHttpxTransport() as transport:
        async with AsyncHTTPClient(transport) as client:
            replies = await asyncio.gather(
                *(
                    client.request("GET", f"http://files.example.org/reports/{day}.txt")
                    for day in ("mon", "tue", "wed")
                )
            )
            print([len(await reply.read()) for reply in replies])


asyncio.run(main())

Choose them for the whole process. PATHAPI_HTTP_TRANSPORT=httpx and PATHAPI_HTTP_ASYNC_TRANSPORT=httpx make every HTTPClient and AsyncHTTPClient that was given no transport send through a new httpx client:

PATHAPI_HTTP_ASYNC_TRANSPORT=httpx python -c "from pathapi.http import AsyncHTTPClient; print(type(AsyncHTTPClient().transport))"

API overview

pathapi.http finds the classes through the httpx entries of its pathapi.http_transports and pathapi.http_async_transports entry-point groups, which this distribution declares. The reference is in the API header that ships with the package.

Development

python -m venv .venv/3.14-posix-x86_64
.venv/3.14-posix-x86_64/bin/python -m pip install -e ".[dev]"
.venv/3.14-posix-x86_64/bin/python -m pytest -q -rs

pathapi 0.1.2 is a dependency; while it is not on PyPI, install it editable from its checkout first (pip install -e ../pathapi). The test run includes python -m pathapi.http.testing --http-transports httpx --http-async-transports httpx, the tests pathapi runs over its own transports.

Releasing

This project follows Semantic Versioning and keeps a CHANGELOG.md. Pushing a tag matching v* triggers the release workflow: test gate → build (checking the tag names the version built) → a strict docs build as a gate → GitHub release → publish. The release workflow never deploys the docs site itself: for a final release its last job dispatches the docs workflow at the tag, which owns every Pages deploy.

License

MIT — see LICENSE.