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

waldiez/models/agents/doc_agent/doc_agent_data.py

@@ -5,7 +5,6 @@
 from pathlib import Path
 from typing import Optional, Union
 
-from platformdirs import user_data_dir
 from pydantic import Field, model_validator
 from typing_extensions import Annotated, Self
 
@@ -78,19 +77,10 @@ class WaldiezDocAgentData(WaldiezAgentData):
             The instance with validated `parsed_docs_path`.
         """
         if not self.parsed_docs_path:
-            data_dir = user_data_dir(
-                appname="waldiez",
-                appauthor="waldiez",
-            )
-            parsed_docs_path = Path(data_dir) / "parsed_docs"
-            parsed_docs_path.mkdir(parents=True, exist_ok=True)
-            self.parsed_docs_path = str(parsed_docs_path.resolve())
-        resolved = Path(self.parsed_docs_path).resolve()
-        if not resolved.is_absolute():
-            self.parsed_docs_path = str(Path.cwd() / self.parsed_docs_path)
-        if not Path(self.parsed_docs_path).is_dir():
-            Path(self.parsed_docs_path).mkdir(parents=True, exist_ok=True)
-        self.parsed_docs_path = str(Path(self.parsed_docs_path).resolve())
+            self.parsed_docs_path = get_parsed_docs_path()
+        parsed_docs_path = Path(self.parsed_docs_path).resolve()
+        parsed_docs_path.mkdir(parents=True, exist_ok=True)
+        self.parsed_docs_path = str(parsed_docs_path)
         return self
 
     def get_query_engine(self) -> WaldiezDocAgentQueryEngine:
@@ -134,16 +124,33 @@ class WaldiezDocAgentData(WaldiezAgentData):
             The parsed documents path for the document agent.
         """
         if not self.parsed_docs_path:
-            data_dir = user_data_dir(
-                appname="waldiez",
-                appauthor="waldiez",
-            )
-            parsed_docs_path = Path(data_dir) / "parsed_docs"
-            parsed_docs_path.mkdir(parents=True, exist_ok=True)
-            self.parsed_docs_path = str(parsed_docs_path.resolve())
-        resolved = Path(self.parsed_docs_path).resolve()
-        if not resolved.is_absolute():
-            self.parsed_docs_path = str(Path.cwd() / self.parsed_docs_path)
-        if not Path(self.parsed_docs_path).is_dir():
-            Path(self.parsed_docs_path).mkdir(parents=True, exist_ok=True)
+            self.parsed_docs_path = get_parsed_docs_path(self.parsed_docs_path)
         return str(self.parsed_docs_path)
+
+
+def get_parsed_docs_path(
+    parsed_docs_path: Optional[Union[str, Path]] = None,
+) -> str:
+    """Get the parsed documents path for the document agent.
+
+    Parameters
+    ----------
+    parsed_docs_path : Optional[Union[str, Path]]
+        The path to the parsed documents.
+
+    Returns
+    -------
+    str
+        The parsed documents path for the document agent.
+    """
+    if not parsed_docs_path:
+        parsed_docs_path_str = str(Path.cwd() / "parsed_docs")
+    else:
+        parsed_docs_path_str = str(parsed_docs_path)
+    if not Path(parsed_docs_path_str).is_absolute():
+        parsed_docs_path_str = str(Path.cwd() / parsed_docs_path_str)
+    resolved_path = Path(parsed_docs_path_str).resolve()
+    if resolved_path.is_file():
+        resolved_path = resolved_path.parent
+    resolved_path.mkdir(parents=True, exist_ok=True)
+    return str(resolved_path)

waldiez/models/agents/doc_agent/rag_query_engine.py

@@ -93,7 +93,7 @@ def ensure_db_path(db_path: str | Path | None) -> str:
 
     Parameters
     ----------
-    db_path : Optional[str]
+    db_path : str | Path | None
         The database path to validate.
 
     Returns

waldiez/models/agents/extra_requirements.py

@@ -1,17 +1,17 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """Extra requirements for agents."""
-
 # pylint: disable=line-too-long
-from typing import Iterator, Set
+
+from typing import Set
 
 from .agent import WaldiezAgent
 from .rag_user_proxy import WaldiezRagUserProxy
 
 
 def get_retrievechat_extra_requirements(
-    agents: Iterator[WaldiezAgent],
-) -> Set[str]:
+    agents: list[WaldiezAgent],
+) -> set[str]:
     """Get the retrievechat extra requirements.
 
     Parameters
@@ -21,7 +21,7 @@ def get_retrievechat_extra_requirements(
 
     Returns
     -------
-    Set[str]
+    set[str]
         The retrievechat extra requirements.
     """
     # https://github.com/ag2ai/ag2/blob/main/pyproject.toml

waldiez/models/agents/group_manager/group_manager.py

@@ -13,6 +13,7 @@ from .group_manager_data import WaldiezGroupManagerData
 from .speakers import WaldiezGroupManagerSpeakers
 
 
+# noinspection PyNestedDecorators
 class WaldiezGroupManager(WaldiezAgent):
     """Group chat manager agent.
 
@@ -26,11 +27,6 @@ class WaldiezGroupManager(WaldiezAgent):
         The agent type: 'group_manager' for a group manager agent
     data : WaldiezGroupManagerData
         The group manager agent's data.
-
-    Functions
-    ---------
-    validate_transitions(agent_ids: list[str])
-        Validate the transitions.
     """
 
     agent_type: Annotated[  # pyright: ignore
@@ -174,6 +170,6 @@ class WaldiezGroupManager(WaldiezAgent):
         ) in speakers.allowed_or_disallowed_transitions.items():
             if agent_id not in agent_ids:
                 raise ValueError(f"Invalid agent id: {agent_id}")
-            for agent_id in transitions:
-                if agent_id not in agent_ids:
+            for target_agent_id in transitions:
+                if target_agent_id not in agent_ids:
                     raise ValueError(f"Invalid agent id: {agent_id}")

waldiez/models/agents/group_manager/speakers.py

@@ -75,13 +75,6 @@ class WaldiezGroupManagerSpeakers(WaldiezBase):
         The type of transition rules to use if
         if a mapping (agent => list[agents]) is used:
         `allowed` (default) or `disallowed`
-    custom_method_string : Optional[str]
-        The custom method string.
-
-    Functions
-    ---------
-    validate_group_speakers_config()
-        Validate the speakers config.
     """
 
     selection_method: Annotated[

waldiez/models/agents/rag_user_proxy/rag_user_proxy.py

@@ -25,8 +25,6 @@ class WaldiezRagUserProxy(WaldiezAgent):
     data : WaldiezRagUserProxyData
         The RAG user agent's data.
         See `WaldiezRagUserProxyData` for more info.
-    retrieve_config : WaldiezRagUserProxyRetrieveConfig
-        The RAG user agent's retrieve config.
     """
 
     agent_type: Annotated[  # pyright: ignore

waldiez/models/agents/rag_user_proxy/rag_user_proxy_data.py

@@ -16,8 +16,6 @@ class WaldiezRagUserProxyData(WaldiezUserProxyData):
 
     Attributes
     ----------
-    use_message_generator: bool
-        Whether to use the message generator in user's chats. Defaults to False.
     retrieve_config : WaldiezRagUserProxyRetrieveConfig
         The RAG user agent's retrieve config.
 

waldiez/models/agents/rag_user_proxy/retrieve_config.py

@@ -50,6 +50,7 @@ CUSTOM_TEXT_SPLIT_FUNCTION_TYPES = (
     ["str", "int", "str", "bool", "int"],
     "list[str]",
 )
+# noinspection HttpUrlsUsage
 NOT_LOCAL = (
     "http://",
     "https://",
@@ -162,25 +163,8 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
     distance_threshold : float
         The threshold for the distance score, only distance smaller than it
         will be returned. Will be ignored if < 0. Default is -1.
-    embedding_function_string : Optional[str]
-        The embedding function string (if use_custom_embedding is True).
-    token_count_function_string : Optional[str]
-        The token count function string (if use_custom_token_count is True).
-    text_split_function_string : Optional[str]
-        The text split function string (if use_custom_text_split is True).
     n_results: Optional[int]
         The number of results to return. Default is None, which will return all
-
-    Functions
-    ---------
-    validate_custom_embedding_function
-        Validate the custom embedding function.
-    validate_custom_token_count_function
-        Validate the custom token count function.
-    validate_custom_text_split_function
-        Validate the custom text split function.
-    validate_rag_user_data
-        Validate the RAG user data.
     """
 
     task: Annotated[

waldiez/models/agents/rag_user_proxy/vector_db_config.py

@@ -39,11 +39,6 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
     metadata : Optional[dict[str, Any]]
         The metadata to use for the vector db.
         Example: {"hnsw:space": "ip", "hnsw:construction_ef": 30, "hnsw:M": 32}
-
-    Functions
-    ---------
-    validate_vector_db_config()
-        Validate the vector db config.
     """
 
     model_config = ConfigDict(

waldiez/models/chat/chat_data.py

@@ -57,8 +57,6 @@ class WaldiezChatData(WaldiezBase):
         Whether to run the chat silently, by default False (not silent).
     summary_args : Optional[dict[str, Any]]
         The summary args to use in autogen.
-    handoff_condition : Optional[WaldiezHandoffCondition], optional
-        The handoff condition to use, by default None (for group chat).
     real_source : Optional[str]
         The real source of the chat (overrides the source).
     real_target : Optional[str]

waldiez/models/chat/chat_summary.py

@@ -66,7 +66,7 @@ class WaldiezChatSummary(WaldiezBase):
     @classmethod
     def validate_summary_method(
         cls, value: Optional[WaldiezChatSummaryMethod]
-    ) -> Optional[WaldiezChatSummaryMethod]:
+    ) -> WaldiezChatSummaryMethod | None:
         """Validate the summary method.
 
         Parameters
@@ -76,7 +76,7 @@ class WaldiezChatSummary(WaldiezBase):
 
         Returns
         -------
-        Optional[WaldiezChatSummaryMethod]
+        WaldiezChatSummaryMethod | None
             The validated message summary method
         """
         if str(value).lower() == "none":
@@ -85,6 +85,8 @@ class WaldiezChatSummary(WaldiezBase):
             return "last_msg"
         if value == "reflectionWithLlm":
             return "reflection_with_llm"
+        if value not in ("last_msg", "reflection_with_llm"):
+            return None
         return value
 
     # noinspection PyNestedDecorators
@@ -107,7 +109,7 @@ class WaldiezChatSummary(WaldiezBase):
         Any
             The serialized value.
         """
-        if info.by_alias is True:
+        if info.by_alias:
             if value == "reflection_with_llm":
                 return "reflectionWithLlm"
             if value == "last_msg":

waldiez/models/common/handoff.py

@@ -27,6 +27,7 @@ __all__ = [
     "WaldiezHandoffTransition",
     "WaldiezLLMBasedCondition",
     "WaldiezContextBasedCondition",
+    "WaldiezDefaultCondition",
 ]
 
 
@@ -39,9 +40,6 @@ class WaldiezAgentTarget(WaldiezBase):
         The type of the transition target.
     value : str
         The agent id to transfer control to.
-    order : int
-        The order of the target in the list of targets.
-        If -1, the order is automatically determined by the json data.
     """
 
     target_type: Annotated[
@@ -67,9 +65,6 @@ class WaldiezRandomAgentTarget(WaldiezBase):
         The type of the transition target.
     value : list[str]
         A list of agent ids to randomly select from.
-    order : int
-        The order of the target in the list of targets.
-        If -1, the order is automatically determined by the json data.
     """
 
     target_type: Annotated[
@@ -104,11 +99,9 @@ class WaldiezSimpleTarget(WaldiezBase):
         "TerminateTarget"
     ]
         The type of the transition target.
-    order : int
-        The order of the target in the list of targets.
-        If -1, the order is automatically determined by the json data.
-    target : str
-        The id of the group or nested chat to transfer control to.
+    value : list[str]
+        A list of values for the target, not actually used
+        (just for consistency with other targets).
     """
 
     target_type: Annotated[
@@ -140,8 +133,6 @@ class WaldiezGroupOrNestedTarget(WaldiezBase):
         The type of the transition target.
     value : str
         The id of the group or nested chat to transfer control to.
-    order : int
-        The order of the target in the list of targets.
     """
 
     target_type: Annotated[
@@ -338,10 +329,14 @@ class WaldiezTransitionAvailability(WaldiezBase):
 
     Attributes
     ----------
-    available : bool
-        Whether the transition is available.
-    data : dict[str, Any]
-        Additional data for the availability condition.
+    type : Literal["string", "expression", "none"]
+        The type of the availability condition.
+        Can be "string", "expression", or "none".
+    value : str
+        The value of the availability condition.
+        If type is "none", this value is ignored.
+        If type is "string", this is a string condition.
+        If type is "expression", this is an expression condition.
     """
 
     type: Literal["string", "expression", "none"] = "none"
@@ -371,7 +366,20 @@ WaldiezHandoffTransition = Union[
 
 
 class WaldiezHandoff(WaldiezBase):
-    """Handoff class for Waldiez agents and chats."""
+    """Handoff class for Waldiez agents and chats.
+
+    Attributes
+    ----------
+    target : WaldiezTransitionTarget
+        The target to transfer control to.
+        Can be an agent, group, nested chat, or simple target.
+    condition : WaldiezHandoffCondition
+        The condition to use for the handoff.
+        If not provided, the handoff will always be available.
+    available : WaldiezTransitionAvailability
+        The availability of the handoff.
+        If not provided, the handoff will always be available.
+    """
 
     target: Annotated[
         WaldiezTransitionTarget,

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

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:

waldiez/models/tool/predefined/_perplexity.py

@@ -77,6 +77,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 +94,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 []
 

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/_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],