Skip to main content

Async HTTP client for mgf-common consumers — typed httpx wrapper with retries, timeouts, header redaction, OTel-aware logging. Sibling of mgf-common under the mgf.* namespace.

Project description

mgf-http — typed async HTTP client for mgf-common consumers

PyPI Python

Shape: Federation sibling of mgf-common; depends on mgf-common>=0.33,<0.34. (Per v2.6 DOC-01 / project-shape taxonomy.)

Sibling of mgf-common under the mgf.* namespace. Houses the typed httpx wrapper that previously lived under mgf.common.http.* — extracted at mgf-common v0.29 / mgf-http v0.1 per the federation split plan.

What this provides

Submodule What
mgf.http AsyncHttpClient — thin wrapper over httpx.AsyncClient with retries, timeouts, header redaction, OTel-aware logging, typed error translation. RetryPolicy — exponential backoff with jitter; per-request override.
mgf.http.exceptions HttpTransportError(OperationError) — transport-layer failure (timeout, connect-refused, network unreachable). Renamed from HttpClientError at the v0.29 cutover to disambiguate from mgf.common.exceptions.HttpClientError (the HTTP-01 4xx-class hierarchy parent, which stays in mgf-common).

Install

pip install mgf-http
# Or with the test extra (respx for mocking httpx in your tests):
pip install 'mgf-http[test]'

Pulls in mgf-common and httpx automatically.

Quick start

import asyncio
from mgf.http import AsyncHttpClient, RetryPolicy

async def main() -> None:
    async with AsyncHttpClient(
        base_url="https://api.example.com",
        timeout=10.0,
        retry=RetryPolicy(max_attempts=3),
    ) as http:
        response = await http.get("/users", params={"page": 1})
        response.raise_for_status()
        users = response.json()

asyncio.run(main())

The client auto-derives a User-Agent of the shape <app>/<ver> mgf-http/<libver> from mgf.common.app_name() / mgf.common.app_version() (call mgf.common.bootstrap() at startup for accurate identity). Authorization / Cookie / X-Api-Key family headers are redacted in logs and OTel spans automatically.

Documentation

For the federation-wide engineering standards (DESIGN_PRINCIPLES, ERROR_HANDLING, SECURITY, etc.) see mgf-common/docs/standards/. This sibling inherits them by reference; the standards source-of-truth lives in mgf-common.

Status

🚧 Experimental — every public name is experimental per AP-09. Promotion to stable happens release-by-release as consumer feedback in mgf-common/FEEDBACK.md converges. The 0.x window applies. Pin tightly: mgf-http = ">=0.X.0,<0.Y".

Cross-references

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mgf_http-0.3.0.tar.gz (131.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mgf_http-0.3.0-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file mgf_http-0.3.0.tar.gz.

File metadata

  • Download URL: mgf_http-0.3.0.tar.gz
  • Upload date:
  • Size: 131.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for mgf_http-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f8c2391ea68e196d78db6aee387c532ba1886c5e8b091eac3abb8a14326f71bd
MD5 e23e530ec058b5f137759584621911a8
BLAKE2b-256 d3d9ed25788e50041c64a0c7ccf824facf605cd9d00e0466bbbc3e39c22f2902

See more details on using hashes here.

File details

Details for the file mgf_http-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: mgf_http-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for mgf_http-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4087e340699465121925f3f4b2827eaa36f68e5cc3f50e4f434de1de42e9579e
MD5 98a3917e3cf69d230a145768bdd629b7
BLAKE2b-256 af27912317d8142893678beabd86fdaf7cac2cea7c9ecdb70568893d1fe3db60

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page