From 7cbdac717a1f1d7ef93fc80fc5b9f2b3c3d9580b Mon Sep 17 00:00:00 2001 From: mateo-berri <277851410+mateo-berri@users.noreply.github.com> Date: Thu, 5 Nov 2026 18:14:07 -0800 Subject: [PATCH] fix(prompt_templates): keep moved private helpers importable from common_utils The split moved 83 private helpers out of common_utils, so code importing them by their old path got ImportError. A module __getattr__ now serves each one from its new module. Also renames the new test files to the directory's naming convention --- .../prompt_templates/common_utils.py | 125 +++++++++++++++++ ...ore_utils_prompt_templates_common_utils.py | 130 ++++++++++++++++++ ...e_utils_prompt_templates_file_id_utils.py} | 0 ...ils_prompt_templates_json_schema_utils.py} | 0 ...emplates_prompt_cache_breakpoint_utils.py} | 0 ...utils_prompt_templates_reasoning_utils.py} | 0 ...prompt_templates_tool_call_json_repair.py} | 0 ...utils_prompt_templates_tpm_media_utils.py} | 0 tests/unit/llms/test_file_content_block.py | 4 +- 9 files changed, 258 insertions(+), 1 deletion(-) rename tests/unit/litellm_core_utils/prompt_templates/{test_file_id_utils.py => test_litellm_core_utils_prompt_templates_file_id_utils.py} (100%) rename tests/unit/litellm_core_utils/prompt_templates/{test_json_schema_utils.py => test_litellm_core_utils_prompt_templates_json_schema_utils.py} (100%) rename tests/unit/litellm_core_utils/prompt_templates/{test_prompt_cache_breakpoint_utils.py => test_litellm_core_utils_prompt_templates_prompt_cache_breakpoint_utils.py} (100%) rename tests/unit/litellm_core_utils/prompt_templates/{test_reasoning_utils.py => test_litellm_core_utils_prompt_templates_reasoning_utils.py} (100%) rename tests/unit/litellm_core_utils/prompt_templates/{test_tool_call_json_repair.py => test_litellm_core_utils_prompt_templates_tool_call_json_repair.py} (100%) rename tests/unit/litellm_core_utils/prompt_templates/{test_tpm_media_utils.py => test_litellm_core_utils_prompt_templates_tpm_media_utils.py} (100%) diff --git a/litellm/litellm_core_utils/prompt_templates/common_utils.py b/litellm/litellm_core_utils/prompt_templates/common_utils.py index 8f874edfddf..bd2a0a53d79 100644 --- a/litellm/litellm_core_utils/prompt_templates/common_utils.py +++ b/litellm/litellm_core_utils/prompt_templates/common_utils.py @@ -2,10 +2,12 @@ Common utility functions used for translating messages across providers """ +import importlib import json from collections.abc import Hashable, Iterable, Mapping, Sequence from dataclasses import dataclass from itertools import chain, groupby +from types import MappingProxyType from typing import TYPE_CHECKING, Any, Final, Literal, TypeAlias, cast from pydantic import TypeAdapter @@ -222,6 +224,122 @@ _extract_reasoning_content: Final = extract_reasoning_content _get_image_mime_type_from_url: Final = get_image_mime_type_from_url _parse_content_for_reasoning: Final = parse_content_for_reasoning +_MOVED_PRIVATE_NAME_MODULES: Final = MappingProxyType( + { + **dict.fromkeys( + ("_decode_vector_store_ids_in_tools",), + "file_id_utils", + ), + **dict.fromkeys( + ( + "_EMPTY_SCHEMA", + "_LOCAL_SCHEMA_REF_PREFIXES", + "_MAX_SCHEMA_FLATTEN_DEPTH", + "_MAX_SCHEMA_NESTING", + "_OPENAI_REJECTED_TOP_LEVEL_SCHEMA_KEYS", + "_REGEX_LOOKAROUND_RE", + "_SCHEMA_LIST", + "_SUBSCHEMA_KEYWORDS", + "_SUBSCHEMA_LIST_KEYWORDS", + "_SUBSCHEMA_MAP_KEYWORDS", + "_TOP_LEVEL_SCHEMA_COMBINATORS", + "_any_of", + "_combinator_required_names", + "_dropped_pattern_properties", + "_flatten_schema_against_root", + "_grammar_branches", + "_is_not_python_regex", + "_is_object_schema", + "_is_open_object", + "_is_union", + "_keyword_value_rebuilt", + "_list_at", + "_may_be_string", + "_mergeable_branch", + "_named_schemas", + "_node_without_rejected_regex", + "_optional_property_names", + "_property_schemas", + "_refs_in", + "_resolve_local_schema_ref", + "_root_definitions", + "_schema_at", + "_schema_branches", + "_schema_levels", + "_schema_nodes", + "_schema_properties", + "_schema_required_names", + "_schema_without_rejected_regex", + "_subschemas", + "_uses_regex_lookaround", + ), + "json_schema_utils", + ), + **dict.fromkeys( + ( + "_AcceptedBreakpointT", + "_BREAKPOINT_BLOCKS", + "_BREAKPOINT_BLOCK_LIST_KEYS", + "_BREAKPOINT_FIELDS", + "_CHAT_COMPLETION_PROMPT_CACHE_BREAKPOINT", + "_MarkedT", + "_PROMPT_CACHE_BREAKPOINT", + "_accepted_prompt_cache_breakpoint", + "_breakpoint_fields_or_none", + "_breakpoints_stripped_from", + "_cache_control_for_prompt_cache_breakpoint", + "_part_with_chat_completion_prompt_cache_breakpoint", + "_without_prompt_cache_breakpoint", + ), + "prompt_cache_breakpoint_utils", + ), + **dict.fromkeys( + ( + "_carries_encrypted_reasoning", + "_converse_wrapped_payload", + "_encrypted_reasoning_field", + "_provider_text_or_none", + "_readable_thinking_text", + "_reasoning_item_from_block_group", + "_reasoning_replay_group_key", + "_strip_encrypted_reasoning_from_blocks", + ), + "reasoning_utils", + ), + **dict.fromkeys( + ( + "_DECODED_JSON", + "_attempt_json_repair", + ), + "tool_call_json_repair", + ), + **dict.fromkeys( + ( + "_BASE64_PAYLOAD", + "_TPMMediaProjection", + "_TPM_EMBEDDING_FILE_MIME_PREFIXES", + "_is_base64_data_uri", + "_is_json_array", + "_tpm_blank_fields", + "_tpm_code_output_media", + "_tpm_document_media", + "_tpm_embedding_file", + "_tpm_embedding_file_block", + "_tpm_embedding_item", + "_tpm_embedding_leaf", + "_tpm_file_media", + "_tpm_image_part", + "_tpm_input_media", + "_tpm_media_leaf", + "_tpm_media_list", + "_tpm_replace_field", + "_tpm_tool_result_media", + ), + "tpm_media_utils", + ), + } +) + if TYPE_CHECKING: from litellm.litellm_core_utils.litellm_logging import Logging as LoggingClass @@ -1577,3 +1695,10 @@ def invalid_type_message(field_path: str, value: object) -> str: def is_unhashable_value_behind(error: TypeError, value: object) -> bool: return not isinstance(value, Hashable) and f"unhashable type: '{type(value).__name__}'" in str(error) + + +def __getattr__(name: str) -> object: + module_name: Final = _MOVED_PRIVATE_NAME_MODULES.get(name) + if module_name is None: + raise AttributeError(f"module {__name__!r} has no attribute {name!r}") + return getattr(importlib.import_module(f"litellm.litellm_core_utils.prompt_templates.{module_name}"), name) diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_common_utils.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_common_utils.py index 390da500c32..c3b31f3ac60 100644 --- a/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_common_utils.py +++ b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_common_utils.py @@ -1,10 +1,12 @@ import copy +import importlib import json from collections.abc import Mapping from typing import Final, cast import pytest +from litellm.litellm_core_utils.prompt_templates import common_utils from litellm.litellm_core_utils.prompt_templates.common_utils import ( TOOL_RESULT_IMAGE_BOUNDARY, TOOL_RESULT_IMAGE_PLACEHOLDER, @@ -983,3 +985,131 @@ def test_content_list_flattening_returns_new_messages_and_leaves_the_callers_unt assert flattened == [{"role": "user", "content": "Hello world"}, {"role": "assistant", "content": "Hi"}] assert messages == messages_before + + +_MOVED_PRIVATE_NAMES_BY_MODULE: Final = ( + ( + "file_id_utils", + ("_decode_vector_store_ids_in_tools",), + ), + ( + "json_schema_utils", + ( + "_EMPTY_SCHEMA", + "_LOCAL_SCHEMA_REF_PREFIXES", + "_MAX_SCHEMA_FLATTEN_DEPTH", + "_MAX_SCHEMA_NESTING", + "_OPENAI_REJECTED_TOP_LEVEL_SCHEMA_KEYS", + "_REGEX_LOOKAROUND_RE", + "_SCHEMA_LIST", + "_SUBSCHEMA_KEYWORDS", + "_SUBSCHEMA_LIST_KEYWORDS", + "_SUBSCHEMA_MAP_KEYWORDS", + "_TOP_LEVEL_SCHEMA_COMBINATORS", + "_any_of", + "_combinator_required_names", + "_dropped_pattern_properties", + "_flatten_schema_against_root", + "_grammar_branches", + "_is_not_python_regex", + "_is_object_schema", + "_is_open_object", + "_is_union", + "_keyword_value_rebuilt", + "_list_at", + "_may_be_string", + "_mergeable_branch", + "_named_schemas", + "_node_without_rejected_regex", + "_optional_property_names", + "_property_schemas", + "_refs_in", + "_resolve_local_schema_ref", + "_root_definitions", + "_schema_at", + "_schema_branches", + "_schema_levels", + "_schema_nodes", + "_schema_properties", + "_schema_required_names", + "_schema_without_rejected_regex", + "_subschemas", + "_uses_regex_lookaround", + ), + ), + ( + "prompt_cache_breakpoint_utils", + ( + "_AcceptedBreakpointT", + "_BREAKPOINT_BLOCKS", + "_BREAKPOINT_BLOCK_LIST_KEYS", + "_BREAKPOINT_FIELDS", + "_CHAT_COMPLETION_PROMPT_CACHE_BREAKPOINT", + "_MarkedT", + "_PROMPT_CACHE_BREAKPOINT", + "_accepted_prompt_cache_breakpoint", + "_breakpoint_fields_or_none", + "_breakpoints_stripped_from", + "_cache_control_for_prompt_cache_breakpoint", + "_part_with_chat_completion_prompt_cache_breakpoint", + "_without_prompt_cache_breakpoint", + ), + ), + ( + "reasoning_utils", + ( + "_carries_encrypted_reasoning", + "_converse_wrapped_payload", + "_encrypted_reasoning_field", + "_provider_text_or_none", + "_readable_thinking_text", + "_reasoning_item_from_block_group", + "_reasoning_replay_group_key", + "_strip_encrypted_reasoning_from_blocks", + ), + ), + ( + "tool_call_json_repair", + ( + "_DECODED_JSON", + "_attempt_json_repair", + ), + ), + ( + "tpm_media_utils", + ( + "_BASE64_PAYLOAD", + "_TPMMediaProjection", + "_TPM_EMBEDDING_FILE_MIME_PREFIXES", + "_is_base64_data_uri", + "_is_json_array", + "_tpm_blank_fields", + "_tpm_code_output_media", + "_tpm_document_media", + "_tpm_embedding_file", + "_tpm_embedding_file_block", + "_tpm_embedding_item", + "_tpm_embedding_leaf", + "_tpm_file_media", + "_tpm_image_part", + "_tpm_input_media", + "_tpm_media_leaf", + "_tpm_media_list", + "_tpm_replace_field", + "_tpm_tool_result_media", + ), + ), +) + + +@pytest.mark.parametrize(("module_name", "names"), _MOVED_PRIVATE_NAMES_BY_MODULE) +def test_moved_private_helpers_still_import_from_common_utils(module_name: str, names: tuple[str, ...]) -> None: + new_home: Final = importlib.import_module(f"litellm.litellm_core_utils.prompt_templates.{module_name}") + unreachable: Final = [name for name in names if getattr(common_utils, name, None) is not getattr(new_home, name)] + assert unreachable == [] + + +def test_unknown_private_name_still_raises_attribute_error_on_common_utils() -> None: + missing_name: Final = "_not_a_moved_helper" + with pytest.raises(AttributeError, match=missing_name): + getattr(common_utils, missing_name) diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_file_id_utils.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_file_id_utils.py similarity index 100% rename from tests/unit/litellm_core_utils/prompt_templates/test_file_id_utils.py rename to tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_file_id_utils.py diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_json_schema_utils.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_json_schema_utils.py similarity index 100% rename from tests/unit/litellm_core_utils/prompt_templates/test_json_schema_utils.py rename to tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_json_schema_utils.py diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_prompt_cache_breakpoint_utils.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_prompt_cache_breakpoint_utils.py similarity index 100% rename from tests/unit/litellm_core_utils/prompt_templates/test_prompt_cache_breakpoint_utils.py rename to tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_prompt_cache_breakpoint_utils.py diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_reasoning_utils.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_reasoning_utils.py similarity index 100% rename from tests/unit/litellm_core_utils/prompt_templates/test_reasoning_utils.py rename to tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_reasoning_utils.py diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_tool_call_json_repair.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_tool_call_json_repair.py similarity index 100% rename from tests/unit/litellm_core_utils/prompt_templates/test_tool_call_json_repair.py rename to tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_tool_call_json_repair.py diff --git a/tests/unit/litellm_core_utils/prompt_templates/test_tpm_media_utils.py b/tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_tpm_media_utils.py similarity index 100% rename from tests/unit/litellm_core_utils/prompt_templates/test_tpm_media_utils.py rename to tests/unit/litellm_core_utils/prompt_templates/test_litellm_core_utils_prompt_templates_tpm_media_utils.py diff --git a/tests/unit/llms/test_file_content_block.py b/tests/unit/llms/test_file_content_block.py index 297b3b6f7d6..6e605eee033 100644 --- a/tests/unit/llms/test_file_content_block.py +++ b/tests/unit/llms/test_file_content_block.py @@ -6,7 +6,9 @@ Regression tests for: - litellm/llms/vertex_ai/gemini/transformation.py - litellm/llms/gemini/chat/transformation.py - litellm/litellm_core_utils/prompt_templates/common_utils.py - (migrate_file_to_image_url raises on missing `file`; file-id helpers skip non-OpenAI shapes) + (migrate_file_to_image_url raises on missing `file`) +- litellm/litellm_core_utils/prompt_templates/file_id_utils.py + (file-id helpers skip non-OpenAI shapes) - litellm/litellm_core_utils/prompt_templates/factory.py (Bedrock + Anthropic) - litellm/llms/openai/chat/gpt_transformation.py """