move supported_builtin_tools to abstract tool set type

Author: dsfaccini

pydantic_ai_slim/pydantic_ai/agent/__init__.py

@@ -1538,7 +1538,7 @@ def get_weather(city: str) -> str:
             # Then run with: uvicorn app:app --reload
             ```
         """
-        from ..ui.web import create_web_app
+        from ..ui._web import create_web_app
 
         return create_web_app(self, models=models, builtin_tools=builtin_tools)
 

pydantic_ai_slim/pydantic_ai/builtin_tools.py

@@ -18,7 +18,9 @@
     'ImageGenerationTool',
     'MemoryTool',
     'MCPServerTool',
-    'BUILTIN_TOOL_CLASSES',
+    'get_builtin_tool_ids',
+    'get_builtin_tool_types',
+    'get_builtin_tool_cls',
 )
 
 _BUILTIN_TOOL_TYPES: dict[str, type[AbstractBuiltinTool]] = {}
@@ -415,21 +417,20 @@ def _tool_discriminator(tool_data: dict[str, Any] | AbstractBuiltinTool) -> str:
         return tool_data.kind
 
 
-BUILTIN_TOOL_ID = Literal[
-    'web_search',
-    'code_execution',
-    'image_generation',
-    'web_fetch',
-    'memory',
-    'mcp_server',
-]
-
-ACTIVE_BUILTIN_TOOL_IDS: frozenset[str] = frozenset(BUILTIN_TOOL_ID.__args__)
-
-BUILTIN_TOOL_CLASSES: dict[BUILTIN_TOOL_ID, type[AbstractBuiltinTool]] = {
-    'web_search': WebSearchTool,
-    'code_execution': CodeExecutionTool,
-    'image_generation': ImageGenerationTool,
-    'web_fetch': WebFetchTool,
-    'memory': MemoryTool,
-}
+def get_builtin_tool_ids() -> frozenset[str]:
+    """Get the set of all builtin tool IDs (excluding deprecated tools like url_context)."""
+    return frozenset(_BUILTIN_TOOL_TYPES.keys() - {'url_context'})
+
+
+def get_builtin_tool_types() -> frozenset[type[AbstractBuiltinTool]]:
+    """Get the set of all builtin tool types (excluding deprecated tools like UrlContextTool)."""
+    return frozenset(cls for kind, cls in _BUILTIN_TOOL_TYPES.items() if kind != 'url_context')
+
+
+def get_builtin_tool_cls(tool_id: str) -> type[AbstractBuiltinTool] | None:
+    """Get a builtin tool class by its ID.
+
+    Args:
+        tool_id: The tool ID (e.g., 'web_search', 'code_execution')
+    """
+    return _BUILTIN_TOOL_TYPES.get(tool_id)

pydantic_ai_slim/pydantic_ai/models/__init__.py

@@ -495,8 +495,8 @@ def model_name(self) -> str:
         raise NotImplementedError()
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
-        """Return the set of builtin tool IDs this model class can handle.
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
+        """Return the set of builtin tool types this model class can handle.
 
         Subclasses should override this to reflect their actual capabilities.
         Default is empty set - subclasses must explicitly declare support.

pydantic_ai_slim/pydantic_ai/models/anthropic.py

@@ -13,7 +13,14 @@
 from .. import ModelHTTPError, UnexpectedModelBehavior, _utils, usage
 from .._run_context import RunContext
 from .._utils import guard_tool_call_id as _guard_tool_call_id
-from ..builtin_tools import CodeExecutionTool, MCPServerTool, MemoryTool, WebFetchTool, WebSearchTool
+from ..builtin_tools import (
+    AbstractBuiltinTool,
+    CodeExecutionTool,
+    MCPServerTool,
+    MemoryTool,
+    WebFetchTool,
+    WebSearchTool,
+)
 from ..exceptions import ModelAPIError, UserError
 from ..messages import (
     BinaryContent,
@@ -255,9 +262,9 @@ def system(self) -> str:
         return self._provider.name
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
-        """Return the set of builtin tool IDs this model class can handle."""
-        return frozenset({'web_search', 'code_execution', 'web_fetch', 'memory', 'mcp_server'})
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
+        """Return the set of builtin tool types this model class can handle."""
+        return frozenset({WebSearchTool, CodeExecutionTool, WebFetchTool, MemoryTool, MCPServerTool})
 
     async def request(
         self,

pydantic_ai_slim/pydantic_ai/models/function.py

@@ -14,6 +14,7 @@
 from .. import _utils, usage
 from .._run_context import RunContext
 from .._utils import PeekableAsyncStream
+from ..builtin_tools import AbstractBuiltinTool
 from ..messages import (
     BinaryContent,
     BuiltinToolCallPart,
@@ -201,11 +202,11 @@ def system(self) -> str:
         return self._system
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
         """FunctionModel supports all builtin tools for testing flexibility."""
-        from ..builtin_tools import ACTIVE_BUILTIN_TOOL_IDS
+        from ..builtin_tools import get_builtin_tool_types
 
-        return ACTIVE_BUILTIN_TOOL_IDS
+        return get_builtin_tool_types()
 
 
 @dataclass(frozen=True, kw_only=True)

pydantic_ai_slim/pydantic_ai/models/google.py

@@ -13,7 +13,7 @@
 from .. import UnexpectedModelBehavior, _utils, usage
 from .._output import OutputObjectDefinition
 from .._run_context import RunContext
-from ..builtin_tools import CodeExecutionTool, ImageGenerationTool, WebFetchTool, WebSearchTool
+from ..builtin_tools import AbstractBuiltinTool, CodeExecutionTool, ImageGenerationTool, WebFetchTool, WebSearchTool
 from ..exceptions import ModelAPIError, ModelHTTPError, UserError
 from ..messages import (
     BinaryContent,
@@ -230,9 +230,9 @@ def system(self) -> str:
         return self._provider.name
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
-        """Return the set of builtin tool IDs this model class can handle."""
-        return frozenset({'web_search', 'code_execution', 'web_fetch', 'image_generation'})
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
+        """Return the set of builtin tool types this model class can handle."""
+        return frozenset({WebSearchTool, CodeExecutionTool, WebFetchTool, ImageGenerationTool})
 
     def prepare_request(
         self, model_settings: ModelSettings | None, model_request_parameters: ModelRequestParameters

pydantic_ai_slim/pydantic_ai/models/groq.py

@@ -15,7 +15,7 @@
 from .._run_context import RunContext
 from .._thinking_part import split_content_into_text_and_thinking
 from .._utils import generate_tool_call_id, guard_tool_call_id as _guard_tool_call_id, number_to_datetime
-from ..builtin_tools import WebSearchTool
+from ..builtin_tools import AbstractBuiltinTool, WebSearchTool
 from ..exceptions import ModelAPIError, UserError
 from ..messages import (
     BinaryContent,
@@ -180,9 +180,9 @@ def system(self) -> str:
         return self._provider.name
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
-        """Return the set of builtin tool IDs this model class can handle."""
-        return frozenset({'web_search'})
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
+        """Return the set of builtin tool types this model class can handle."""
+        return frozenset({WebSearchTool})
 
     async def request(
         self,

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -19,7 +19,7 @@
 from .._run_context import RunContext
 from .._thinking_part import split_content_into_text_and_thinking
 from .._utils import guard_tool_call_id as _guard_tool_call_id, now_utc as _now_utc, number_to_datetime
-from ..builtin_tools import CodeExecutionTool, ImageGenerationTool, MCPServerTool, WebSearchTool
+from ..builtin_tools import AbstractBuiltinTool, CodeExecutionTool, ImageGenerationTool, MCPServerTool, WebSearchTool
 from ..exceptions import UserError
 from ..messages import (
     AudioUrl,
@@ -425,9 +425,9 @@ def system(self) -> str:
         return self._provider.name
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
-        """Return the set of builtin tool IDs this model class can handle."""
-        return frozenset({'web_search'})
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
+        """Return the set of builtin tool types this model class can handle."""
+        return frozenset({WebSearchTool})
 
     @property
     @deprecated('Set the `system_prompt_role` in the `OpenAIModelProfile` instead.')
@@ -1097,9 +1097,9 @@ def system(self) -> str:
         return self._provider.name
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
-        """Return the set of builtin tool IDs this model class can handle."""
-        return frozenset({'web_search', 'code_execution', 'mcp_server', 'image_generation'})
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
+        """Return the set of builtin tool types this model class can handle."""
+        return frozenset({WebSearchTool, CodeExecutionTool, MCPServerTool, ImageGenerationTool})
 
     async def request(
         self,

pydantic_ai_slim/pydantic_ai/models/test.py

@@ -13,6 +13,7 @@
 
 from .. import _utils
 from .._run_context import RunContext
+from ..builtin_tools import AbstractBuiltinTool
 from ..exceptions import UserError
 from ..messages import (
     BuiltinToolCallPart,
@@ -157,11 +158,11 @@ def system(self) -> str:
         return self._system
 
     @classmethod
-    def supported_builtin_tools(cls) -> frozenset[str]:
+    def supported_builtin_tools(cls) -> frozenset[type[AbstractBuiltinTool]]:
         """TestModel supports all builtin tools for testing flexibility."""
-        from ..builtin_tools import ACTIVE_BUILTIN_TOOL_IDS
+        from ..builtin_tools import get_builtin_tool_types
 
-        return ACTIVE_BUILTIN_TOOL_IDS
+        return get_builtin_tool_types()
 
     def gen_tool_args(self, tool_def: ToolDefinition) -> Any:
         return _JsonSchemaTestData(tool_def.parameters_json_schema, self.seed).generate()

pydantic_ai_slim/pydantic_ai/profiles/__init__.py

@@ -7,6 +7,7 @@
 from typing_extensions import Self
 
 from .._json_schema import InlineDefsJsonSchemaTransformer, JsonSchemaTransformer
+from ..builtin_tools import AbstractBuiltinTool, get_builtin_tool_types
 from ..output import StructuredOutputMode
 
 __all__ = [
@@ -65,11 +66,11 @@ class ModelProfile:
     This is currently only used by `OpenAIChatModel`, `HuggingFaceModel`, and `GroqModel`.
     """
 
-    supported_builtin_tools: frozenset[str] = field(default_factory=lambda: frozenset[str]())
-    """The set of builtin tool IDs that this model/profile supports.
+    supported_builtin_tools: frozenset[type[AbstractBuiltinTool]] = field(default_factory=get_builtin_tool_types)
+    """The set of builtin tool types that this model/profile supports.
 
-    Defaults to empty (no builtin tools). Profile functions should explicitly
-    set this based on model capabilities.
+    Defaults to ALL builtin tools. Profile functions should explicitly
+    restrict this based on model capabilities.
     """
 
     @classmethod