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

waldiez/io/redis.py

@@ -32,6 +32,7 @@ except ImportError as error:  # pragma: no cover
     ) from error
 from autogen.events import BaseEvent  # type: ignore
 from autogen.io import IOStream  # type: ignore
+from autogen.messages import BaseMessage  # type: ignore
 
 from .models import (
     PrintMessage,
@@ -52,6 +53,7 @@ else:
 LOG = logging.getLogger(__name__)
 
 
+# noinspection PyBroadException
 class RedisIOStream(IOStream):
     """Redis I/O stream."""
 
@@ -158,10 +160,8 @@ class RedisIOStream(IOStream):
 
         Parameters
         ----------
-        message : str
+        payload : dict[str, Any]
             The message to print.
-        message_type : str
-            The message type.
         """
         LOG.debug("Sending print message: %s", payload)
         RedisIOStream.try_do(
@@ -177,10 +177,8 @@ class RedisIOStream(IOStream):
 
         Parameters
         ----------
-        message : str
+        payload : dict[str, Any]
             The message to print.
-        message_type : str
-            The message type.
         """
         LOG.debug("Sending print message: %s", payload)
         RedisIOStream.try_do(
@@ -289,12 +287,12 @@ class RedisIOStream(IOStream):
         self._print(payload)
         return user_input
 
-    def send(self, message: BaseEvent) -> None:
+    def send(self, message: BaseEvent | BaseMessage) -> None:
         """Send a structured message to Redis.
 
         Parameters
         ----------
-        message : dict[str, Any]
+        message : BaseEvent | BaseMessage
             The message to send.
         """
         message_dump = get_message_dump(message)
@@ -549,7 +547,7 @@ class RedisIOStream(IOStream):
 
         Parameters
         ----------
-        func : Awaitable[Any]
+        func : Callable[..., Awaitable[Any]]
             The async function to call.
         args : Any
             The positional arguments.

waldiez/io/structured.py

@@ -14,6 +14,7 @@ from uuid import uuid4
 
 from autogen.events import BaseEvent  # type: ignore
 from autogen.io import IOStream  # type: ignore
+from autogen.messages import BaseMessage  # type: ignore
 
 from .models import (
     PrintMessage,
@@ -135,12 +136,12 @@ class StructuredIOStream(IOStream):
 
     # noinspection PyMethodMayBeStatic
     # pylint: disable=no-self-use,broad-exception-caught
-    def send(self, message: BaseEvent) -> None:
-        """Structured sending of a BaseEvent.
+    def send(self, message: BaseEvent | BaseMessage) -> None:
+        """Structured sending of a BaseEvent or BaseMessage.
 
         Parameters
         ----------
-        message : BaseEvent
+        message : BaseEvent | BaseMessage
             The message to send.
         """
         message_dump = get_message_dump(message)
@@ -251,7 +252,7 @@ class StructuredIOStream(IOStream):
         str | dict[str, Any]
             The loaded user input, either as a string or a dictionary.
         """
-        response: str | dict[str, Any] = user_input_raw
+        response: str | dict[str, Any]
         try:
             # Attempt to parse the input as JSON
             response = json.loads(user_input_raw)
@@ -283,8 +284,8 @@ class StructuredIOStream(IOStream):
 
         Parameters
         ----------
-        user_input : str
-            The raw user input string.
+        user_input : dict[str, Any]
+            The user input dictionary containing the response data.
         request_id : str
             The request ID to match against.
 
@@ -341,6 +342,7 @@ class StructuredIOStream(IOStream):
             data="",
         )
 
+    # noinspection PyMethodMayBeStatic
     def _handle_list_response(
         self,
         data: list[dict[str, Any]],

waldiez/io/utils.py

@@ -12,6 +12,7 @@ from typing import Any, Literal, Union
 
 from autogen.agentchat.contrib.img_utils import get_pil_image  # type: ignore
 from autogen.events import BaseEvent  # type: ignore
+from autogen.messages import BaseMessage  # type: ignore
 
 MessageType = Literal[
     "input_request",
@@ -169,6 +170,7 @@ def try_parse_maybe_serialized(value: str) -> Any:
     """
     for parser in (json.loads, ast.literal_eval):
         # pylint: disable=broad-exception-caught, too-many-try-statements
+        # noinspection PyBroadException
         try:
             parsed: dict[str, Any] | list[Any] | str = parser(value)
             # Normalize: if it's a single-item list of a string
@@ -185,14 +187,12 @@ def try_parse_maybe_serialized(value: str) -> Any:
     return value  # Return original if all parsing fails
 
 
-def get_message_dump(
-    message: BaseEvent,
-) -> dict[str, Any]:
+def get_message_dump(message: BaseEvent | BaseMessage) -> dict[str, Any]:
     """Get the message dump.
 
     Parameters
     ----------
-    message : BaseEvent
+    message : BaseEvent | BaseMessage
         The message to dump.
 
     Returns
@@ -200,7 +200,14 @@ def get_message_dump(
     dict[str, Any]
         The dumped message.
     """
+    if not hasattr(message, "model_dump"):  # pragma: no cover
+        return {
+            "error": "Message does not have model_dump method.",
+            "type": message.__class__.__name__,
+        }
+
     # pylint: disable=broad-exception-caught
+    # noinspection PyBroadException
     try:
         message_dump = message.model_dump(mode="json")
     except Exception:

waldiez/io/ws.py

@@ -12,6 +12,7 @@ from typing import Any
 
 from autogen.events import BaseEvent  # type: ignore
 from autogen.io import IOStream  # type: ignore
+from autogen.messages import BaseMessage  # type: ignore
 
 from ._ws import (
     WebSocketConnection,
@@ -110,7 +111,7 @@ class AsyncWebsocketsIOStream(IOStream):
         ----------
         args : tuple
             The arguments to print.
-        kwargs : dict
+        kwargs : Any
             The keyword arguments to print.
         """
         sep = kwargs.get("sep", " ")
@@ -134,12 +135,12 @@ class AsyncWebsocketsIOStream(IOStream):
             LOG.info(json_dump)
         self._try_send(json_dump)
 
-    def send(self, message: BaseEvent) -> None:
+    def send(self, message: BaseEvent | BaseMessage) -> None:
         """Send a message to the WebSocket connection.
 
         Parameters
         ----------
-        message : BaseEvent
+        message : BaseEvent | BaseMessage
             The message to send.
         """
         message_dump = get_message_dump(message)

waldiez/logger.py

@@ -6,6 +6,7 @@
 import inspect
 import os
 import re
+import string
 import threading
 import traceback
 from datetime import datetime
@@ -323,6 +324,7 @@ class WaldiezLogger:
     def _get_caller_info(cls) -> str:
         """Get caller information (filename and line number) from the stack."""
         frame = inspect.currentframe()
+        # noinspection PyBroadException
         try:
             if frame is None:  # pragma: no cover
                 return ""
@@ -377,7 +379,15 @@ class WaldiezLogger:
     @staticmethod
     def _has_format_braces(msg_str: str) -> bool:
         """Check if the message contains .format() style placeholders."""
-        return bool(re.search(r"\{[^}]*\}", msg_str))
+        # noinspection PyBroadException
+        try:
+            formatter = string.Formatter()
+            for _, field_name, _, _ in formatter.parse(msg_str):
+                if field_name is not None:
+                    return True
+            return False
+        except Exception:  # pylint: disable=broad-exception-caught
+            return False
 
     @staticmethod
     def _has_percent_placeholders(msg_str: str) -> bool:

waldiez/models/agents/agent/agent.py

@@ -24,6 +24,7 @@ if TYPE_CHECKING:
     from ...chat import WaldiezChat
 
 
+# noinspection PyUnresolvedReferences
 class WaldiezAgent(WaldiezBase):
     """Waldiez Agent to be inherited by all other agents.
 

waldiez/models/agents/agent/agent_data.py

@@ -146,7 +146,7 @@ class WaldiezAgentData(WaldiezBase):
         Field(
             default_factory=list,
             title="Tools",
-            description=("A list of tools (id and executor) to register."),
+            description="A list of tools (id and executor) to register.",
         ),
     ] = []
     nested_chats: Annotated[
@@ -194,7 +194,7 @@ class WaldiezAgentData(WaldiezBase):
         Field(
             default_factory=list,
             title="Handoffs",
-            description=("A list of handoffs (target ids) to register."),
+            description="A list of handoffs (target ids) to register.",
         ),
     ] = []
     after_work: Annotated[

waldiez/models/agents/agent/nested_chat.py

@@ -50,16 +50,13 @@ class WaldiezAgentNestedChat(WaldiezBase):
     messages : list[WaldiezAgentNestedChatMessage]
         The list of messages (chat ids and 'is_reply'z)
         to include the in the nested chat registration.
-    order : int
-        The order of the nested chat (if used as a handoff).
-        Defaults to 0.
     """
 
     triggered_by: Annotated[
         list[str],
         Field(
             title="Triggered By",
-            description=("A list of agent ids that trigger the nested chat."),
+            description="A list of agent ids that trigger the nested chat.",
             alias="triggeredBy",
             default_factory=list,
         ),

waldiez/models/agents/agent/termination_message.py

@@ -33,13 +33,6 @@ class WaldiezAgentTerminationMessage(WaldiezBase):
         The method must be called `is_termination_message`,
         have one argument (`message`) which is a dict, and
         return a bool (whether the message is a termination message or not.)
-    string : str
-        The value of the termination message.
-
-    Functions
-    ---------
-    validate_termination_message() -> Self
-        Validate the termination message configuration.
     """
 
     type: Annotated[

waldiez/models/agents/agent/update_system_message.py

@@ -27,9 +27,9 @@ class WaldiezAgentUpdateSystemMessage(WaldiezBase):
 
     Attributes
     ----------
-    update_function_type : Literal["string", "callable"]
+    type : Literal["string", "callable"]
         The type of the update function. Can be either a string or a callable.
-    update_function : str
+    content : str
         The string template or function definition to update
         the agent's system message. Can be a string or a Callable.
         If the `function_type` is 'string' it will be used as a

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,