litellm/tests/unit/test_completion_timeout_resolution.py

302 lines
8.4 KiB
Python

"""Unit tests for litellm.litellm_core_utils.completion_timeout.CompletionTimeout."""
import os
import sys
from typing import Final, Literal
import httpx
import pytest
from openai import Timeout as SDKTimeout
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../../..")))
from litellm.litellm_core_utils.completion_timeout import CompletionTimeout, StreamKind
from litellm.utils import supports_httpx_timeout
def test_explicit_timeout_wins():
assert (
CompletionTimeout.resolve(
12.5,
{"timeout": 99.0, "request_timeout": 88.0},
"openai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 12.5
)
def test_kwargs_timeout_when_param_none():
assert (
CompletionTimeout.resolve(
None,
{"timeout": 21.0},
"azure_ai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 21.0
)
def test_request_timeout_alias_in_kwargs():
assert (
CompletionTimeout.resolve(
None,
{"request_timeout": 33.0},
"bedrock",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 33.0
)
def test_global_timeout_from_litellm_settings():
assert (
CompletionTimeout.resolve(
None,
{},
"vertex_ai",
global_timeout=360.0,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 360.0
)
def test_explicit_global_timeout_6000_is_preserved():
"""The caller passes the explicitly-configured value (or None); an explicit
6000 must be honored, not silently coerced to 600."""
assert (
CompletionTimeout.resolve(
None,
{},
"openai",
global_timeout=6000.0,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 6000.0
)
def test_explicit_request_timeout_6000_preserved():
"""Explicit deployment/request timeout must not be truncated by the package sentinel."""
assert (
CompletionTimeout.resolve(
None,
{"request_timeout": 6000.0},
"openai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 6000.0
)
def test_explicit_model_timeout_6000_preserved():
assert (
CompletionTimeout.resolve(
6000.0,
{"timeout": 1.0, "request_timeout": 2.0},
"openai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 6000.0
)
def test_fallback_600_when_no_global_timeout():
assert (
CompletionTimeout.resolve(
None,
{},
"azure_ai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== 600.0
)
def test_httpx_timeout_coerced_for_provider_without_httpx_timeout_support():
t = httpx.Timeout(50.0, connect=2.0)
out = CompletionTimeout.resolve(
t,
{},
"azure_ai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
assert out == 50.0
assert not isinstance(out, httpx.Timeout)
SHARED_HTTPX_HANDLER_PROVIDERS: Final = (
"a2a",
"anthropic_text",
"bedrock_mantle",
"bytez",
"cloudflare",
"cohere",
"cohere_chat",
"cometapi",
"compactifai",
"databricks",
"databricks_agent",
"datarobot",
"deepseek",
"edenai",
"fal_ai",
"fireworks_ai",
"gdc",
"gigachat",
"gradient_ai",
"groq",
"heroku",
"hosted_vllm",
"huggingface",
"langflow",
"langgraph",
"lemonade",
"minimax",
"mistral",
"nadir",
"oci",
"ollama",
"ollama_chat",
"openrouter",
"ovhcloud",
"ragflow",
"scaledown",
"snowflake",
"text-completion-codestral",
"together_ai",
"triton",
"vercel_ai_gateway",
"watsonx_text",
"xai",
)
@pytest.mark.parametrize("provider", SHARED_HTTPX_HANDLER_PROVIDERS)
def test_httpx_timeout_preserved_for_shared_httpx_handler_providers(provider: str) -> None:
"""Providers dispatched to the shared httpx handler accept httpx.Timeout (issue #47822)."""
assert supports_httpx_timeout(provider) is True
t: Final = httpx.Timeout(40.0, connect=5.0)
resolved: Final = CompletionTimeout.resolve(
t,
{},
provider,
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
assert resolved is t
@pytest.mark.parametrize("provider", ("azure_ai", "vertex_ai", "anthropic", "gemini", "watsonx"))
def test_httpx_timeout_still_coerced_for_sdk_providers(provider: str) -> None:
"""Providers on third-party SDKs keep the float coercion."""
assert supports_httpx_timeout(provider) is False
def test_httpx_timeout_preserved_for_openai():
t = httpx.Timeout(40.0, connect=5.0)
out = CompletionTimeout.resolve(
t,
{},
"openai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
assert out is t
assert isinstance(out, httpx.Timeout)
@pytest.mark.parametrize("source", ("model", "timeout", "request_timeout"))
def test_sdk_timeout_preserves_components_for_httpx_providers(
source: Literal["model", "timeout", "request_timeout"],
) -> None:
timeout: Final = SDKTimeout(connect=2.0, read=None, write=5.0, pool=7.0)
resolved: Final = CompletionTimeout.resolve(
timeout if source == "model" else None,
{} if source == "model" else {source: timeout},
"openai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
assert isinstance(resolved, httpx.Timeout)
assert resolved.as_dict() == timeout.as_dict()
@pytest.mark.parametrize("read_timeout, expected", ((23.0, 23.0), (None, 600.0)))
def test_sdk_timeout_coerces_read_timeout_for_providers_without_httpx_support(
read_timeout: float | None, expected: float
) -> None:
assert (
CompletionTimeout.resolve(
SDKTimeout(connect=2.0, read=read_timeout, write=5.0, pool=7.0),
{},
"azure_ai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.NOT_STREAMED,
)
== expected
)
@pytest.mark.parametrize(
"stream_kind, timeout, stream_timeout, expected",
(
(StreamKind.NOT_STREAMED, 120.0, 15.0, 120.0),
(StreamKind.LIVE, 120.0, 15.0, 15.0),
(StreamKind.LIVE, 1.0, 15.0, 15.0),
(StreamKind.FAKED, 120.0, 15.0, 120.0),
(StreamKind.FAKED, 1.0, 15.0, 15.0),
(StreamKind.FAKED, httpx.Timeout(5.0, read=None), 15.0, httpx.Timeout(15.0, read=None)),
(StreamKind.FAKED, httpx.Timeout(1.0, read=120.0), 15.0, httpx.Timeout(15.0, read=120.0)),
),
)
def test_stream_timeout_bounds_a_live_stream_and_never_shortens_a_fake_one(
stream_kind: StreamKind, timeout: float | httpx.Timeout, stream_timeout: float, expected: float | httpx.Timeout
) -> None:
assert (
CompletionTimeout.resolve(
timeout,
{"stream_timeout": stream_timeout},
"openai",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=stream_kind,
)
== expected
)
def test_fake_stream_with_only_a_stream_timeout_keeps_the_global_request_timeout() -> None:
assert (
CompletionTimeout.resolve(
None,
{"stream_timeout": 15.0},
"bedrock",
global_timeout=None,
supports_httpx_timeout=supports_httpx_timeout,
stream_kind=StreamKind.FAKED,
)
== 600.0
)