httpx-retries: A retry layer for httpx

[will-ockmore]

Hello! I've just released the first version of httpx-retries - a retry layer for HTTPX.

It's very common to deal with flaky and unreliable APIs. When requests fail, your program needs to be able to retry them.

Motivation

HTTPX doesn't support this by default - the emphasis in the documentation is to use a third party library if you need more than connection retries. HTTPX Retries is focused on retrying failed requests where a response has been received.

The familiar approach, for those who have used requests and urllib3, is to use urllib3's Retry utility (as shown in the requests documentation). To keep it simple to migrate from requests to HTTPX, the retry configuration uses an API that closely mirrors urllib3's Retry.

Usage

Install HTTPX Retries using pip:

pip install httpx-retries

---

To get started, add the transport to your client:

import httpx
from httpx_retries import RetryTransport

with httpx.Client(transport=RetryTransport()) as client:
    response = client.get("https://example.com")

Async usage is just as straightforward.

async with httpx.AsyncClient(transport=RetryTransport()) as client:
    response = await client.get("https://example.com")

If you want to use a specific retry strategy, provide a Retry configuration:

from httpx_retries import Retry

retry = Retry(total=5, backoff_factor=0.5)
transport = RetryTransport(retry=retry)

with httpx.Client(transport=transport) as client:
    response = client.get("https://example.com")

See the documentation for more information.

I hope you like it!

Thanks for taking the time to read. I'd love to hear about anyone who might make use of this, or if you have any feedback or ideas for the project!

[karpetrosyan]

Hey! LGTM, good job 🎉