waldiez 0.5.6__py3-none-any.whl → 0.5.8__py3-none-any.whl

waldiez/models/common/naming.py

@@ -41,6 +41,7 @@ def get_valid_python_variable_name(
     # \W matches any non-word character, but in Python's re module,
     # \w includes Unicode letters by default, so we need to be more explicit
     # to replace Unicode letters with underscores for valid Python identifiers
+    # noinspection RegExpSimplifiable
     possible = re.sub(r"[^\w]", "_", possible)  # Replace non-word chars
     possible = re.sub(r"[^\x00-\x7F]", "_", possible)  # Replace non-ASCII chars
 

waldiez/models/flow/flow.py

@@ -4,7 +4,6 @@
 """Waldiez flow model."""
 
 from functools import cached_property
-from typing import Optional
 
 from pydantic import Field, model_validator
 from typing_extensions import Annotated, Literal, Self
@@ -133,7 +132,7 @@ class WaldiezFlow(WaldiezBase):
             description="The date and time when the flow was last updated.",
         ),
     ]
-    _ordered_flow: Optional[list[WaldiezAgentConnection]] = None
+    _ordered_flow: list[WaldiezAgentConnection] | None = None
     _single_agent_mode: bool = False
     _is_group_chat: bool = False
 
@@ -160,7 +159,7 @@ class WaldiezFlow(WaldiezBase):
         return self._is_group_chat
 
     @property
-    def cache_seed(self) -> Optional[int]:
+    def cache_seed(self) -> int | None:
         """Check if the flow has caching disabled.
 
         Returns
@@ -351,6 +350,7 @@ class WaldiezFlow(WaldiezBase):
     ) -> list[WaldiezAgentConnection]:
         """Get the ordered flow."""
         if self._is_group_chat:
+            # noinspection PyTypeChecker
             return self._get_group_chat_flow()
         # in the chats, there is the 'order' field, we use this,
         # we only keep the ones with order >=0
@@ -408,7 +408,7 @@ class WaldiezFlow(WaldiezBase):
 
         Returns
         -------
-        list[tuple[WaldiezChat, WaldiezAgent, WaldiezAgent]]
+        list[WaldiezAgentConnection]
             The ordered flow for group chat.
         """
         # in a group chat there is no "order", the group manager
@@ -427,8 +427,8 @@ class WaldiezFlow(WaldiezBase):
         # )
         # in the second case, the chat would be:
         # user.run(manager, ...)
-        user_agent: Optional[WaldiezAgent] = None
-        to_root_manager: Optional[WaldiezChat] = None
+        user_agent: WaldiezAgent | None = None
+        to_root_manager: WaldiezChat | None = None
         root_manager: WaldiezGroupManager = self.get_root_group_manager()
         for chat in self.data.chats:
             if chat.target == root_manager.id:
@@ -438,7 +438,9 @@ class WaldiezFlow(WaldiezBase):
                     user_agent = source
                     to_root_manager = chat
                     break
-        if not to_root_manager or not user_agent:
+        if not to_root_manager:
+            return []
+        if not user_agent:
             return []
         return [
             {

waldiez/models/model/_llm.py

@@ -104,8 +104,8 @@ def get_llm_imports(model: "WaldiezModel") -> set[str]:
 
     Returns
     -------
-    str
-        The LLM import statements for the model.
+    set[str]
+        A set of import statements needed for the model's LLM.
 
     Raises
     ------
@@ -358,6 +358,7 @@ def do_cohere_llm(model: "WaldiezModel") -> tuple[str, str]:
     return arg, before
 
 
+# noinspection DuplicatedCode
 def do_deepseek_llm(model: "WaldiezModel") -> tuple[str, str]:
     """Get the DeepSeek LLM argument and any content before it.
 
@@ -394,6 +395,7 @@ def do_google_llm(model: "WaldiezModel") -> tuple[str, str]:
     return arg, before
 
 
+# noinspection DuplicatedCode
 def do_groq_llm(model: "WaldiezModel") -> tuple[str, str]:
     """Get the Groq LLM argument and any content before it.
 

waldiez/models/model/extra_requirements.py

@@ -2,14 +2,14 @@
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """Waldiez model extra requirements."""
 
-from typing import Iterator, Set
+from typing import Set
 
 from .model import WaldiezModel
 
 
 def get_models_extra_requirements(
-    models: Iterator[WaldiezModel], autogen_version: str
-) -> Set[str]:
+    models: list[WaldiezModel], autogen_version: str
+) -> set[str]:
     """Get the models extra requirements.
 
     Parameters

waldiez/models/model/model.py

@@ -272,6 +272,7 @@ class WaldiezModel(WaldiezBase):
         return get_llm_arg(self)
 
 
+# noinspection PyTypeChecker
 def set_default_base_url(
     llm_config: dict[str, Any], api_type: WaldiezModelAPIType
 ) -> dict[str, Any]:
@@ -303,7 +304,7 @@ def set_default_base_url(
 
 def set_bedrock_aws_config(
     llm_config: dict[str, Any],
-    aws_config: Optional[WaldiezModelAWS],
+    aws_config: WaldiezModelAWS | None,
 ) -> dict[str, Any]:
     """Set the AWS config for Bedrock.
 
@@ -311,7 +312,7 @@ def set_bedrock_aws_config(
     ----------
     llm_config : dict[str, Any]
         The llm config dictionary.
-    aws_config : Optional[WaldiezModelAWS]
+    aws_config : WaldiezModelAWS | None
         The passed aws config if any.
 
     Returns
@@ -337,11 +338,11 @@ def set_bedrock_aws_config(
         value = getattr(aws_config, param, "") if aws_config else ""
 
         # If not found, try environment variable
-        if not value:  # pragma: no cover
+        if not value or value == "REPLACE_ME":  # pragma: no cover
             value = os.environ.get(env_var, "")
 
         # Add to extra_args if value exists
-        if value:  # pragma: no branch
+        if value and value != "REPLACE_ME":  # pragma: no branch
             extra_args[config_key] = value
 
     # Update llm_config with extra_args

waldiez/models/tool/extra_requirements.py

@@ -2,14 +2,14 @@
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """Waldiez tool extra requirements."""
 
-from typing import Iterator, Set
+from typing import Set
 
 from .predefined import get_predefined_tool_requirements
 from .tool import WaldiezTool
 
 
 def get_tools_extra_requirements(
-    tools: Iterator[WaldiezTool],
+    tools: list[WaldiezTool],
     autogen_version: str,
 ) -> Set[str]:
     """Get the tools extra requirements.

waldiez/models/tool/predefined/_google.py

@@ -106,10 +106,12 @@ class GoogleSearchToolImpl(PredefinedTool):
             if name not in kwargs:
                 missing.append(name)
             elif not isinstance(kwargs[name], type_of):
+                # pylint: disable=broad-exception-caught
+                # noinspection PyBroadException
                 try:
                     kwargs[name] = type_of(kwargs[name])
                     self._kwargs[name] = kwargs[name]
-                except Exception:  # pylint: disable=broad-except
+                except Exception:
                     invalid.append(name)
                 else:
                     if name in self._kwargs:
@@ -136,25 +138,15 @@ class GoogleSearchToolImpl(PredefinedTool):
         str
             The content for the tool.
         """
-        os.environ["GOOGLE_SEARCH_API_KEY"] = secrets.get(
-            "GOOGLE_SEARCH_API_KEY", ""
-        )
-        google_search_engine_id = self.google_search_engine_id
-        if not google_search_engine_id:
-            google_search_engine_id = secrets.get("GOOGLE_SEARCH_ENGINE_ID", "")
         content = f'''
 def {self.name}(
     query: str,
-    search_api_key: str,
-    search_engine_id: str,
     num_results: int = 10,
 ) -> list[dict[str, Any]]:
     """Perform a Google search and return formatted results.
 
     Args:
         query: The search query string.
-        search_api_key: The API key for the Google Search API.
-        search_engine_id: The search engine ID for the Google Search API.
         num_results: The maximum number of results to return. Defaults to 10.
     Returns:
         A list of dictionaries of the search results.
@@ -162,9 +154,12 @@ def {self.name}(
     google_search_api_key = os.environ.get("GOOGLE_SEARCH_API_KEY", "")
     if not google_search_api_key:
         raise ValueError("GOOGLE_SEARCH_API_KEY is required for Google search tool.")
+    google_search_engine_id = os.environ.get("GOOGLE_SEARCH_ENGINE_ID", "")
+    if not google_search_engine_id:
+        raise ValueError("Google Search Engine ID is required for Google search tool.")
     {self.name}_tool = GoogleSearchTool(
         search_api_key=google_search_api_key,
-        search_engine_id="{google_search_engine_id}",
+        search_engine_id=google_search_engine_id,
     )
     return {self.name}_tool(
         query=query,

waldiez/models/tool/predefined/_perplexity.py

@@ -4,7 +4,6 @@
 # flake8: noqa: E501
 """Predefined Perplexity AI search tool for Waldiez."""
 
-import os
 from typing import Any
 
 from ._config import PredefinedToolConfig
@@ -77,6 +76,7 @@ class PerplexitySearchToolImpl(PredefinedTool):
             missing_secrets.append("PERPLEXITY_API_KEY")
         return missing_secrets
 
+    # noinspection DuplicatedCode
     def validate_kwargs(self, kwargs: dict[str, Any]) -> list[str]:
         """Validate keyword arguments and return list of missing required ones.
 
@@ -93,11 +93,13 @@ class PerplexitySearchToolImpl(PredefinedTool):
         for key, value in self.kwargs.items():
             if key in kwargs:  # pragma: no branch
                 type_of = self.kwarg_types.get(key, str)
+                # pylint: disable=broad-exception-caught
+                # noinspection PyBroadException
                 try:
                     casted = type_of(value)
                     if key in self.kwargs:  # pragma: no branch
                         self.kwargs[key] = casted
-                except Exception:  # pylint: disable=broad-except
+                except Exception:
                     pass
         return []
 
@@ -117,21 +119,23 @@ class PerplexitySearchToolImpl(PredefinedTool):
         str
             Content retrieved by the tool.
         """
-        os.environ["PERPLEXITY_API_KEY"] = secrets.get("PERPLEXITY_API_KEY", "")
+        model = self.kwargs["model"]
+        max_tokens = self.kwargs["max_tokens"]
+        search_domain_filter = self.kwargs["search_domain_filter"]
         content = f'''
 def {self.name}(
     query: str,
-    model: str = "{self.kwargs["model"]}",
-    max_tokens: int = {self.kwargs["max_tokens"]},
-    search_domain_filter: Optional[list[str]] = {self.kwargs["search_domain_filter"]},
+    model: str = "{model}",
+    max_tokens: int = {max_tokens},
+    search_domain_filter: Optional[list[str]] = {search_domain_filter},
 ) -> "SearchResponse":
     """Perform a Perplexity AI search and return formatted results.
 
     Args:
         query: The search query string.
-        model: The model to use for the search. Defaults to "{self.kwargs["model"]}".
-        max_tokens: The maximum number of tokens to return. Defaults to {self.kwargs["max_tokens"]}.
-        search_domain_filter: List of domain filters for the search. Defaults to {self.kwargs["search_domain_filter"]}.
+        model: The model to use for the search. Defaults to "{model}".
+        max_tokens: The maximum number of tokens to return. Defaults to {max_tokens}.
+        search_domain_filter: List of domain filters for the search. Defaults to {search_domain_filter}.
     Returns:
         A list of dictionaries of the search results.
     """

waldiez/models/tool/predefined/_searxng.py

@@ -68,6 +68,7 @@ class SearxNGSearchToolImpl(PredefinedTool):
         """
         return []  # No secrets required for this tool.
 
+    # noinspection DuplicatedCode
     def validate_kwargs(self, kwargs: dict[str, Any]) -> list[str]:
         """Validate keyword arguments and return list of missing required ones.
 
@@ -84,11 +85,13 @@ class SearxNGSearchToolImpl(PredefinedTool):
         for key, value in self.kwargs.items():
             if key in kwargs:  # pragma: no branch
                 type_of = self.kwarg_types.get(key, str)
+                # pylint: disable=broad-exception-caught
+                # noinspection PyBroadException
                 try:
                     casted = type_of(value)
                     if key in self.kwargs:  # pragma: no branch
                         self.kwargs[key] = casted
-                except Exception:  # pylint: disable=broad-except
+                except Exception:
                     pass
         return []
 

waldiez/models/tool/predefined/_tavily.py

@@ -4,7 +4,6 @@
 # flake8: noqa: E501
 """Predefined Tavily search tool for Waldiez."""
 
-import os
 from typing import Any
 
 from ._config import PredefinedToolConfig
@@ -98,13 +97,9 @@ class TavilySearchToolImpl(PredefinedTool):
         str
             The content for the tool.
         """
-        os.environ["TAVILY_API_KEY"] = secrets.get(
-            "TAVILY_API_KEY", os.environ.get("TAVILY_API_KEY", "")
-        )
         content = f'''
 def {self.name}(
     query: str,
-    tavily_api_key: str = os.environ.get("TAVILY_API_KEY", ""),
     search_depth: str = "basic",
     topic: str = "general",
     include_answer: str = "basic",
@@ -116,7 +111,6 @@ def {self.name}(
 
             Args:
                 query: The search query string.
-                tavily_api_key: The API key for Tavily (injected dependency).
                 search_depth: The depth of the search ('basic' or 'advanced'). Defaults to "basic".
                 include_answer: Whether to include an AI-generated answer ('basic' or 'advanced'). Defaults to "basic".
                 include_raw_content: Whether to include raw content in the results. Defaults to False.

waldiez/models/tool/predefined/_wikipedia.py

@@ -73,6 +73,7 @@ class WikipediaSearchToolImpl(PredefinedTool):
         """
         return []
 
+    # noinspection DuplicatedCode
     def validate_kwargs(self, kwargs: dict[str, Any]) -> list[str]:
         """Validate keyword arguments and return list of missing required ones.
 
@@ -89,14 +90,17 @@ class WikipediaSearchToolImpl(PredefinedTool):
         for key, value in self.kwargs.items():
             if key in kwargs:
                 type_of = self.kwargs_types.get(key, str)
+                # pylint: disable=broad-exception-caught
+                # noinspection PyBroadException
                 try:
                     casted = type_of(value)
                     if key in self.kwargs:
                         self.kwargs[key] = casted
-                except Exception:  # pylint: disable=broad-except
+                except Exception:
                     pass
         return []
 
+    # pylint: disable=unused-argument
     def get_content(
         self,
         secrets: dict[str, str],

waldiez/models/tool/predefined/_youtube.py

@@ -4,7 +4,6 @@
 # flake8: noqa: E501
 """Predefined YouTube search tool for Waldiez."""
 
-import os
 from typing import Any
 
 from ._config import PredefinedToolConfig
@@ -101,11 +100,9 @@ class YouTubeSearchToolImpl(PredefinedTool):
         str
             The content for the tool.
         """
-        os.environ["YOUTUBE_API_KEY"] = secrets.get("YOUTUBE_API_KEY", "")
         content = f'''
 def {self.name}(
     query: str,
-    youtube_api_key: str = os.environ.get("YOUTUBE_API_KEY", ""),
     max_results: int = 5,
     include_video_details: bool = True,
 ) -> list[dict[str, Any]]:
@@ -113,7 +110,6 @@ def {self.name}(
 
     Args:
         query: The search query string.
-        youtube_api_key: The API key for the YouTube Data API.
         max_results: The maximum number of results to return. Defaults to 5.
         include_video_details: Whether to include detailed video information. Defaults to True.
 

waldiez/models/tool/tool.py

@@ -5,7 +5,7 @@
 import json
 import re
 from pathlib import Path
-from typing import Any, Union
+from typing import Any
 
 from pydantic import Field, model_validator
 from typing_extensions import Annotated, Literal, Self
@@ -44,9 +44,9 @@ class WaldiezTool(WaldiezBase):
         The tags of the tool.
     requirements : list[str]
         The requirements of the tool.
-    created_at : str
+    created_at : str, optional
         The date and time when the tool was created.
-    updated_at : str
+    updated_at : str, optional
         The date and time when the tool was last updated.
     data : WaldiezToolData
         The data of the tool. See `WaldiezToolData`.
@@ -81,7 +81,7 @@ class WaldiezTool(WaldiezBase):
             description="The tags of the tool.",
             default_factory=list,
         ),
-    ]
+    ] = []
     requirements: Annotated[
         list[str],
         Field(
@@ -89,7 +89,7 @@ class WaldiezTool(WaldiezBase):
             description="The requirements of the tool.",
             default_factory=list,
         ),
-    ]
+    ] = []
     data: Annotated[
         WaldiezToolData,
         Field(..., title="Data", description="The data of the tool."),
@@ -112,12 +112,12 @@ class WaldiezTool(WaldiezBase):
     ]
 
     @staticmethod
-    def load(data_or_path: Union[str, Path, dict[str, Any]]) -> "WaldiezTool":
+    def load(data_or_path: str | Path | dict[str, Any]) -> "WaldiezTool":
         """Load a tool from a read-only file.
 
         Parameters
         ----------
-        data_or_path : Union[str, Path, dict[str, Any]]
+        data_or_path : str | Path | dict[str, Any]
             The path to the read-only file or the loaded data.
 
         Returns

waldiez/models/tool/tool_data.py

@@ -4,8 +4,8 @@
 
 from typing import Any
 
-from pydantic import Field
-from typing_extensions import Annotated
+from pydantic import Field, SerializationInfo, model_serializer, model_validator
+from typing_extensions import Annotated, Self
 
 from ..common import WaldiezBase
 from .tool_type import WaldiezToolType
@@ -61,3 +61,40 @@ class WaldiezToolData(WaldiezBase):
             ),
         ),
     ] = {}
+
+    _raw_content: str = ""
+
+    @model_validator(mode="after")
+    def validate_tool_data(self) -> Self:
+        """Validate the tool data.
+
+        Returns
+        -------
+        Self
+            The validated tool data.
+        """
+        self._raw_content = self.content
+
+        return self
+
+    @model_serializer(mode="plain", when_used="always")
+    def serialize_tool_data(self, info: SerializationInfo) -> dict[str, Any]:
+        """Serialize the tool data.
+
+        Parameters
+        ----------
+        info : SerializationInfo
+            The serialization information.
+
+        Returns
+        -------
+        dict[str, Any]
+            The serialized tool data.
+        """
+        tool_type_key = "toolType" if info.by_alias else "tool_type"
+        return {
+            tool_type_key: self.tool_type,
+            "content": self._raw_content,
+            "secrets": self.secrets,
+            "kwargs": self.kwargs,
+        }

waldiez/models/waldiez.py

@@ -11,7 +11,7 @@ definitions and their optional additional tools to be used.
 import json
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Iterator, Optional
+from typing import Any, Iterator
 
 from .agents import (
     WaldiezAgent,
@@ -43,11 +43,11 @@ class Waldiez:
     def from_dict(
         cls,
         data: dict[str, Any],
-        flow_id: Optional[str] = None,
-        name: Optional[str] = None,
-        description: Optional[str] = None,
-        tags: Optional[list[str]] = None,
-        requirements: Optional[list[str]] = None,
+        flow_id: str | None = None,
+        name: str | None = None,
+        description: str | None = None,
+        tags: list[str] | None = None,
+        requirements: list[str] | None = None,
     ) -> "Waldiez":
         """Create a Waldiez from dict.
 
@@ -55,15 +55,15 @@ class Waldiez:
         ----------
         data : dict[str, Any]
             The data.
-        flow_id : Optional[str], optional
+        flow_id : str | None, optional
             The flow id, by default None (retrieved from data or generated).
-        name : Optional[str], optional
+        name: str | None, optional
             The name, by default None (retrieved from data).
-        description : Optional[str], optional
+        description : str | None, optional
             The description, by default None (retrieved from data).
-        tags : Optional[list[str]], optional
+        tags: list[str] | None, optional
             The tags, by default None (retrieved from data).
-        requirements : Optional[list[str]], optional
+        requirements: list[str] | None, optional
             The requirements, by default None (retrieved from data).
 
         Returns
@@ -86,10 +86,10 @@ class Waldiez:
     def load(
         cls,
         waldiez_file: str | Path,
-        name: Optional[str] = None,
-        description: Optional[str] = None,
-        tags: Optional[list[str]] = None,
-        requirements: Optional[list[str]] = None,
+        name: str | None = None,
+        description: str | None = None,
+        tags: list[str] | None = None,
+        requirements: list[str] | None = None,
     ) -> "Waldiez":
         """Load a Waldiez from a file.
 
@@ -97,14 +97,14 @@ class Waldiez:
         ----------
         waldiez_file : Union[str, Path]
             The Waldiez file.
-        name : Optional[str], optional
-            The name, by default None.
-        description : Optional[str], optional
-            The description, by default None.
-        tags : Optional[list[str]], optional
-            The tags, by default None.
-        requirements : Optional[list[str]], optional
-            The requirements, by default None.
+        name: str | None, optional
+            The name, by default None (retrieved from data).
+        description : str | None, optional
+            The description, by default None (retrieved from data).
+        tags: list[str] | None, optional
+            The tags, by default None (retrieved from data).
+        requirements: list[str] | None, optional
+            The requirements, by default None (retrieved from data).
 
         Returns
         -------
@@ -133,7 +133,7 @@ class Waldiez:
         )
 
     def model_dump_json(
-        self, by_alias: bool = True, indent: Optional[int] = None
+        self, by_alias: bool = True, indent: int | None = None
     ) -> str:
         """Get the model dump json.
 
@@ -143,7 +143,7 @@ class Waldiez:
         ----------
         by_alias : bool, optional
             Use alias (toCamel), by default True.
-        indent : Optional[int], optional
+        indent : int | None, optional
             The indent, by default None.
 
         Returns
@@ -250,7 +250,7 @@ class Waldiez:
         return self.flow.is_async
 
     @property
-    def cache_seed(self) -> Optional[int]:
+    def cache_seed(self) -> int | None:
         """Get the cache seed."""
         return self.flow.cache_seed
 
@@ -275,7 +275,7 @@ class Waldiez:
         requirements = set(requirements_list)
         requirements.add(f"ag2[openai]=={autogen_version}")
         if self.has_rag_agents:  # pragma: no branch
-            rag_extras = get_retrievechat_extra_requirements(self.agents)
+            rag_extras = get_retrievechat_extra_requirements(list(self.agents))
             requirements.update(rag_extras)
         if self.has_multimodal_agents:  # pragma: no branch
             requirements.add(f"ag2[lmm]=={autogen_version}")
@@ -291,13 +291,13 @@ class Waldiez:
             )
         requirements.update(
             get_models_extra_requirements(
-                self.models,
+                list(self.models),
                 autogen_version=autogen_version,
             )
         )
         requirements.update(
             get_tools_extra_requirements(
-                self.tools,
+                list(self.tools),
                 autogen_version=autogen_version,
             )
         )