chore: Update ToolsType to use Sequence

Author: maxdswain

haystack/components/generators/chat/openai_responses.py

@@ -488,7 +488,7 @@ def _prepare_api_call(  # noqa: PLR0913
             # Convert all tool objects to the correct OpenAI-compatible structure
             else:
                 # mypy can't infer that tools is ToolsType here
-                flattened_tools = flatten_tools_or_toolsets(tools)
+                flattened_tools = flatten_tools_or_toolsets(tools)  # type: ignore[arg-type]
                 _check_duplicate_tool_names(flattened_tools)
                 for t in flattened_tools:
                     function_spec = {**t.tool_spec}

haystack/tools/__init__.py

@@ -6,6 +6,7 @@
 
 # ruff: noqa: I001 (ignore import order as we need to import Tool before ComponentTool and PipelineTool)
 
+from collections.abc import Sequence
 from haystack.tools.from_function import create_tool_from_function, tool
 from haystack.tools.tool import Tool, _check_duplicate_tool_names
 from haystack.tools.toolset import Toolset
@@ -15,15 +16,11 @@
 from haystack.tools.serde_utils import deserialize_tools_or_toolset_inplace, serialize_tools_or_toolset
 from haystack.tools.utils import flatten_tools_or_toolsets, warm_up_tools
 
-# Type alias for tools parameter - allows mixing Tools and Toolsets in a list
-# Explicitly list all valid combinations due to list invariance:
-# - list[Tool]: Most common pattern - list of Tool objects
-# - list[Toolset]: Less common pattern - list of Toolset objects
-# - list[Union[Tool, Toolset]]: Mixing Tools and Toolsets in one list
-# - list[ComponentTool]: List of ComponentTool objects
-# - list[PipelineTool]: List of PipelineTool objects
-# - Toolset: Single Toolset (not in a list)
-ToolsType = list[Tool] | list[Toolset] | list[Tool | Toolset] | list[ComponentTool] | list[PipelineTool] | Toolset
+# Type alias for tools parameter - allows mixing Tools and Toolsets in a sequence
+# Accepts either:
+# - Sequence[Tool | Toolset]: Any sequence (list, tuple, etc.) containing Tools, Toolsets, or a mix of both
+# - Toolset: A single Toolset (not in a sequence)
+ToolsType = Sequence[Tool | Toolset] | Toolset
 
 __all__ = [
     "_check_duplicate_tool_names",

test/tools/test_searchable_toolset.py

@@ -102,7 +102,7 @@ def test_init_with_invalid_catalog(self):
         with pytest.raises(TypeError):
             SearchableToolset(catalog=123)  # type: ignore[arg-type]
         with pytest.raises(TypeError):
-            SearchableToolset(catalog=[123])  # type: ignore[arg-type]
+            SearchableToolset(catalog=[123])  # type: ignore[list-item]
         with pytest.raises(TypeError):
             SearchableToolset(
                 catalog=Tool(  # type: ignore[arg-type]
@@ -682,7 +682,7 @@ def warm_up(self) -> None:
             for i in range(5)
         ]
 
-        toolset = SearchableToolset(catalog=[LazyToolset()] + eager_tools)  # type: ignore[arg-type]
+        toolset = SearchableToolset(catalog=[LazyToolset(), *eager_tools])
         toolset.warm_up()
 
         # Should have 5 lazy + 5 eager = 10 tools

test/tools/test_tools_utils.py

@@ -140,13 +140,13 @@ def test_flatten_list_with_empty_toolsets(self, add_tool):
     def test_flatten_invalid_type_in_list(self):
         """Test that invalid types in the list raise TypeError."""
         with pytest.raises(TypeError, match="Items in the tools list must be Tool or Toolset instances"):
-            flatten_tools_or_toolsets(["not_a_tool"])  # type: ignore[arg-type]
+            flatten_tools_or_toolsets(["not_a_tool"])  # type: ignore[list-item]
 
         with pytest.raises(TypeError, match="Items in the tools list must be Tool or Toolset instances"):
-            flatten_tools_or_toolsets([123])  # type: ignore[arg-type]
+            flatten_tools_or_toolsets([123])  # type: ignore[list-item]
 
         with pytest.raises(TypeError, match="Items in the tools list must be Tool or Toolset instances"):
-            flatten_tools_or_toolsets([{"key": "value"}])  # type: ignore[arg-type]
+            flatten_tools_or_toolsets([{"key": "value"}])  # type: ignore[list-item]
 
     def test_flatten_invalid_type(self):
         """Test that invalid root types raise TypeError."""
@@ -215,7 +215,7 @@ def test_warm_up_tools_with_single_tool(self):
         )
 
         assert not tool.was_warmed_up
-        warm_up_tools([tool])  # type: ignore[arg-type]
+        warm_up_tools([tool])
         assert tool.was_warmed_up
 
     def test_warm_up_tools_with_single_toolset(self):
@@ -270,7 +270,7 @@ def test_warm_up_tools_with_list_containing_toolset(self):
         assert not tool1.was_warmed_up
         assert not tool2.was_warmed_up
 
-        warm_up_tools([toolset])  # type: ignore[arg-type]
+        warm_up_tools([toolset])
 
         # Both the toolset itself and individual tools should be warmed up
         assert toolset.was_warmed_up
@@ -307,7 +307,7 @@ def test_warm_up_tools_with_multiple_toolsets(self):
         assert not tool2.was_warmed_up
         assert not tool3.was_warmed_up
 
-        warm_up_tools([toolset1, toolset2])  # type: ignore[arg-type]
+        warm_up_tools([toolset1, toolset2])
 
         # Both toolsets and all individual tools should be warmed up
         assert toolset1.was_warmed_up
@@ -344,7 +344,7 @@ def test_warm_up_tools_with_mixed_tools_and_toolsets(self):
         assert not toolset_tool1.was_warmed_up
         assert not toolset_tool2.was_warmed_up
 
-        warm_up_tools([standalone_tool, toolset])  # type: ignore[arg-type]
+        warm_up_tools([standalone_tool, toolset])
 
         # All tools and the toolset should be warmed up
         assert standalone_tool.was_warmed_up