Skip to content

httpx_compat

langroid/language_models/httpx_compat.py

Compatibility shim over the httpx / httpx2 split in the OpenAI SDK.

openai < 3 is built on httpx; openai >= 3 replaced it with httpx2 (the Pydantic-maintained successor). Both expose the same Client / AsyncClient / Timeout API, but each SDK major only depends on its own family, so langroid must import the family that matches the installed openai major rather than hard-coding httpx.

Everything in langroid that needs an HTTP-client type should go through this module instead of importing httpx or httpx2 directly.

HTTPX_MODULE_NAME = 'httpx2' if _openai_major() >= 3 else 'httpx' module-attribute

Name of the httpx family the installed openai SDK is built on.

import_httpx()

Import and return the httpx family matching the installed openai SDK.

The import is performed on every call (cheap: sys.modules caches it) so callers can wrap it in try/except ImportError and report a family-specific install hint.

Returns:

Type Description
ModuleType

The httpx module (openai 2.x) or the httpx2 module
ModuleType

(openai 3.x).

Raises:

Type Description
ImportError

If the required package is not installed.
Source code in langroid/language_models/httpx_compat.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def import_httpx() -> ModuleType:
    """Import and return the httpx family matching the installed openai SDK.

    The import is performed on every call (cheap: ``sys.modules`` caches it)
    so callers can wrap it in ``try/except ImportError`` and report a
    family-specific install hint.

    Returns:
        The ``httpx`` module (openai 2.x) or the ``httpx2`` module
        (openai 3.x).

    Raises:
        ImportError: If the required package is not installed.
    """
    return import_module(HTTPX_MODULE_NAME)

missing_httpx_message()

Error text for http_client_config when the httpx family is missing.

Source code in langroid/language_models/httpx_compat.py 
52
53
54
55
56
57
def missing_httpx_message() -> str:
    """Error text for ``http_client_config`` when the httpx family is missing."""
    return (
        f"{HTTPX_MODULE_NAME} is required to use http_client_config. "
        f"Install it with: pip install {HTTPX_MODULE_NAME}"
    )