waldiez 0.4.3__py3-none-any.whl → 0.4.5__py3-none-any.whl

waldiez/__init__.py

@@ -2,15 +2,35 @@
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """Waldiez package."""
 
-from ._version import __version__
 from .exporter import WaldiezExporter
 from .models import Waldiez
 from .runner import WaldiezRunner
 from .utils import check_conflicts, check_flaml_warnings
 
+# flake8: noqa: F401
+# pylint: disable=import-error,line-too-long
+# pyright: reportMissingImports=false
+try:
+    from ._version import (  # type: ignore[unused-ignore, unused-import, import-not-found, import-untyped]  # noqa
+        __version__,
+    )
+except ImportError:  # pragma: no cover
+    # Fallback when using the package in dev mode without installing
+    # in editable mode with pip. It is highly recommended to install
+    # the package from a stable release or in editable mode:
+    # https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
+    import warnings
+
+    warnings.warn(
+        "Importing __version__ failed. Using 'dev' as version.", stacklevel=2
+    )
+    __version__ = "dev"
+
+
 __WALDIEZ_INITIALIZED = False
 
 if not __WALDIEZ_INITIALIZED:
+    __WALDIEZ_INITIALIZED = True
     check_conflicts()
     check_flaml_warnings()
     # let's skip the one below
@@ -20,7 +40,6 @@ if not __WALDIEZ_INITIALIZED:
     #   before calling pip install pyautogen[captainagent]
     #   we should have pysqlite3 installed (at least on windows)
     # before running a flow
-    __WALDIEZ_INITIALIZED = True
 
 __all__ = [
     "Waldiez",

waldiez/_version.py

@@ -1,5 +1,8 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
-"""Version information for Waldiez."""
+"""Version information for waldiez.
 
-__version__ = "0.4.3"
+This file is automatically generated by Hatchling.
+Do not edit this file directly.
+"""
+__version__ = VERSION = "0.4.5"

waldiez/cli.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
-# pylint: disable=missing-function-docstring,missing-param-doc,missing-raises-doc  # noqa: E501
+# flake8: noqa: E501
+# pylint: disable=missing-function-docstring,missing-param-doc,missing-raises-doc
 """Command line interface to convert or run a waldiez file."""
 
 import json
@@ -14,7 +15,21 @@ import anyio
 import typer
 from typing_extensions import Annotated
 
-from ._version import __version__
+# pylint: disable=import-error,line-too-long
+# pyright: reportMissingImports=false
+try:  # pragma: no cover
+    from ._version import (  # type: ignore[unused-ignore, unused-import, import-not-found, import-untyped]  # noqa
+        __version__,
+    )
+except ImportError:  # pragma: no cover
+    import warnings
+
+    warnings.warn(
+        "Importing __version__ failed. Using 'dev' as version.", stacklevel=2
+    )
+    __version__ = "dev"
+
+
 from .exporter import WaldiezExporter
 from .models import Waldiez
 from .runner import WaldiezRunner
@@ -70,7 +85,7 @@ def run(
             resolve_path=True,
         ),
     ],
-    output: Optional[Path] = typer.Option(
+    output: Optional[Path] = typer.Option(  # noqa: B008
         None,
         help=(
             "Path to the output (.py) file. "
@@ -80,7 +95,7 @@ def run(
         dir_okay=False,
         resolve_path=True,
     ),
-    force: bool = typer.Option(
+    force: bool = typer.Option(  # noqa: B008
         False,
         help="Override the output file if it already exists.",
     ),

waldiez/exporter.py

@@ -1,6 +1,8 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """
+Waldiez exporter class.
+
 The role of the exporter is to export the model's data
 to an autogen's flow with one or more chats.
 
@@ -20,18 +22,20 @@ from .models import Waldiez
 class WaldiezExporter:
     """Waldiez exporter.
 
-    Attributes:
+    Attributes
+    ----------
         waldiez (Waldiez): The Waldiez instance.
     """
 
     def __init__(self, waldiez: Waldiez) -> None:
         """Initialize the Waldiez exporter.
 
-        Parameters:
-            waldiez (Waldiez): The Waldiez instance.
+        Parameters
+        ----------
+        waldiez: Waldiez
+            The Waldiez instance.
         """
         self.waldiez = waldiez
-        # self._initialize()
 
     @classmethod
     def load(cls, file_path: Path) -> "WaldiezExporter":

waldiez/exporting/agent/utils/captain_agent.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
-""" "Extras for exporting a captain agent."""
+"""Extras for exporting a captain agent."""
 
 import json
 import os
@@ -37,6 +37,7 @@ def get_captain_agent_extras(
         The serializer to use.
     output_dir : Optional[Union[str, Path]]
         The output directory to save the agent lib and nested config.
+
     Returns
     -------
     str
@@ -90,6 +91,7 @@ def generate_nested_config(
         All the models in the flow.
     save_path : str
         The path to save the nested config.
+
     Returns
     -------
     Dict[str, Any]
@@ -131,6 +133,7 @@ def get_llm_config(
         The agent.
     all_models : List[WaldiezModel]
         All the models in the flow.
+
     Returns
     -------
     Dict[str, str]

waldiez/exporting/agent/utils/group_manager.py

@@ -31,7 +31,6 @@ def get_group_manager_extras(
     Tuple[str, str]
         The content before the agent string and the group chat argument.
     """
-
     group_chat_arg = ""
     before_agent_string = ""
     custom_speaker_selection: Optional[str] = None

waldiez/exporting/agent/utils/rag_user/rag_user.py

@@ -83,6 +83,7 @@ def get_rag_user_retrieve_config_str(
         The path resolver function.
     serializer : Callable[..., str]
         The serializer function.
+
     Returns
     -------
     Tuple[str, str, Set[str]]

waldiez/exporting/agent/utils/swarm_agent.py

@@ -55,6 +55,7 @@ def get_swarm_extras(
         The serializer to get the string representation of an object.
     string_escape : Callable[[str], str]
         The function to escape the string quotes and newlines.
+
     Returns
     -------
     Tuple[str, str, str]

waldiez/exporting/base/base_exporter.py

@@ -10,7 +10,7 @@ from .export_position import ExportPosition
 from .import_position import ImportPosition
 
 
-# flake8: noqa: E501
+# flake8: noqa: E501,B027
 # pylint: disable=line-too-long
 class ExporterReturnType(TypedDict):
     """Exporter Return Type.
@@ -66,7 +66,7 @@ class BaseExporter(abc.ABC):
         """
 
     def get_imports(self) -> Optional[List[Tuple[str, ImportPosition]]]:
-        """ "Generate the imports string for the exporter.
+        """Generate the imports string for the exporter.
 
         Returns
         -------

waldiez/exporting/base/mixin.py

@@ -28,6 +28,7 @@ class ExporterMixin:
             The item.
         tabs : int, optional
             The number of tabs for indentation, by default 1.
+
         Returns
         -------
         str
@@ -77,6 +78,7 @@ class ExporterMixin:
             The comment key.
         for_notebook : bool
             Whether the comment is for a notebook or not.
+
         Returns
         -------
         str
@@ -121,6 +123,7 @@ class ExporterMixin:
             The prefix for the instance name, by default "w".
         max_length : int, optional
             The maximum length of the variable name, by default 64
+
         Returns
         -------
         Dict[str, str]

waldiez/exporting/base/utils/comments.py

@@ -1,6 +1,8 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """Utilities for comments.
+
+Functions
 ---------
 comment
     Get a comment string.

waldiez/exporting/chats/utils/sequential.py

@@ -23,7 +23,7 @@ def export_sequential_chat(
     tabs: int,
     is_async: bool,
 ) -> Tuple[str, str]:
-    """Get the chats content, when there are more than one chats in the flow.
+    r"""Get the chats content, when there are more than one chats in the flow.
 
     Parameters
     ----------

waldiez/exporting/chats/utils/single_chat.py

@@ -49,6 +49,7 @@ def export_single_chat(
         The number of tabs to use for indentation.
     is_async : bool
         Whether the chat is asynchronous.
+
     Returns
     -------
     Tuple[str, str]
@@ -154,6 +155,7 @@ def get_simple_chat_string(
         The number of tabs to use for indentation.
     is_async : bool
         Whether the chat is asynchronous.
+
     Returns
     -------
     Tuple[str, str]
@@ -218,6 +220,7 @@ def get_empty_simple_chat_string(
         The tab string.
     is_async : bool
         Whether the chat is asynchronous.
+
     Returns
     -------
     Tuple[str, str]

waldiez/exporting/chats/utils/swarm.py

@@ -47,6 +47,7 @@ def export_swarm_chat(
         The number of tabs to use for indentation.
     is_async : bool
         Whether the chat is asynchronous.
+
     Returns
     -------
     Tuple[str, str]
@@ -124,6 +125,7 @@ def get_swarm_agents_strings(
         A mapping of agent id to agent name.
     user_agent : Optional[WaldiezAgent]
         The user agent.
+
     Returns
     -------
     Tuple[str, str]
@@ -190,6 +192,7 @@ def get_swarm_after_work_string(
         A mapping of agent id to agent name.
     name_suffix : str
         The suffix to use for the function name.
+
     Returns
     -------
     Tuple[str, str]

waldiez/exporting/flow/flow_exporter.py

@@ -197,6 +197,7 @@ class FlowExporter(BaseExporter, ExporterMixin):
         chats_content : str
             The chats content.
         before_chats : str
+
         Returns
         -------
         str
@@ -412,6 +413,7 @@ class FlowExporter(BaseExporter, ExporterMixin):
             The before export.
         after_export : List[Tuple[str, Union[ExportPosition, AgentPosition]]]
             The after export.
+
         Returns
         -------
         str

waldiez/exporting/flow/utils/def_main.py

@@ -28,6 +28,7 @@ def get_def_main(
         Whether the main function is asynchronous.
     cache_seed : Optional[int]
         The seed for the cache. If None, cache should be disabled.
+
     Returns
     -------
     str

waldiez/exporting/flow/utils/flow_content.py

@@ -16,6 +16,7 @@ def get_py_content_start(waldiez: Waldiez) -> str:
     ----------
     waldiez : Waldiez
         The waldiez object.
+
     Returns
     -------
     str
@@ -46,6 +47,7 @@ def get_ipynb_content_start(
         The waldiez object.
     comment : Callable[[bool, int], str]
         The function to create a comment.
+
     Returns
     -------
     str
@@ -130,6 +132,7 @@ def get_after_run_content(
         The dictionary of agent names and their corresponding ids
     tabs : int
         The number of tabs to add before the content.
+
     Returns
     -------
     str

waldiez/exporting/flow/utils/flow_names.py

@@ -46,6 +46,7 @@ def ensure_unique_names(
         The maximum length of the name, by default 64
     flow_name_max_length : int, optional
         The maximum length of the flow name, by default 20
+
     Returns
     -------
     ResultType

waldiez/exporting/flow/utils/importing_utils.py

@@ -102,6 +102,7 @@ def get_the_imports_string(
         All the imports.
     is_async : bool
         If the flow is async.
+
     Returns
     -------
     str

waldiez/exporting/flow/utils/logging_utils.py

@@ -17,7 +17,7 @@ get_sqlite_to_csv_call_string
 
 
 def get_start_logging(is_async: bool, tabs: int = 0) -> str:
-    """Get the logging start call string.
+    r"""Get the logging start call string.
 
     Parameters
     ----------
@@ -70,7 +70,7 @@ def get_start_logging(is_async: bool, tabs: int = 0) -> str:
 
 # pylint: disable=differing-param-doc,differing-type-doc
 def get_sync_sqlite_out() -> str:
-    """Get the sqlite to csv and json conversion code string.
+    r"""Get the sqlite to csv and json conversion code string.
 
     Returns
     -------
@@ -84,8 +84,8 @@ def get_sync_sqlite_out() -> str:
     def get_sqlite_out(dbname: str, table: str, csv_file: str) -> None:
         \"\"\"Convert a sqlite table to csv and json files.
 
-        Parameters
-        ----------
+    Parameters
+    ----------
         dbname : str
             The sqlite database name.
         table : str
@@ -152,7 +152,7 @@ def get_sync_sqlite_out() -> str:
 
 # pylint: disable=differing-param-doc,differing-type-doc,line-too-long
 def get_async_sqlite_out() -> str:
-    """Get the sqlite to csv and json conversion code string.
+    r"""Get the sqlite to csv and json conversion code string.
 
     Returns
     -------
@@ -166,8 +166,8 @@ def get_async_sqlite_out() -> str:
     async def get_sqlite_out(dbname: str, table: str, csv_file: str) -> None:
         \"\"\"Convert a sqlite table to csv and json files.
 
-        Parameters
-        ----------
+    Parameters
+    ----------
         dbname : str
             The sqlite database name.
         table : str
@@ -313,7 +313,7 @@ def get_sqlite_out_call(tabs: int, is_async: bool) -> str:
 
 
 def get_stop_logging(tabs: int, is_async: bool) -> str:
-    """Get the function to stop logging and gather logs.
+    r"""Get the function to stop logging and gather logs.
 
     Parameters
     ----------

waldiez/exporting/skills/skills_exporter.py

@@ -82,7 +82,7 @@ class SkillsExporter(BaseExporter, ExporterMixin):
         return self.skill_secrets
 
     def get_imports(self) -> List[Tuple[str, ImportPosition]]:
-        """ "Generate the imports string.
+        """Generate the imports string.
 
         Returns
         -------

waldiez/exporting/skills/utils.py

@@ -23,7 +23,7 @@ def get_agent_skill_registration(
     skill_description: str,
     string_escape: Callable[[str], str],
 ) -> str:
-    """Get the agent skill string and secrets.
+    r"""Get the agent skill string and secrets.
 
     Parameters
     ----------
@@ -37,6 +37,7 @@ def get_agent_skill_registration(
         The skill description.
     string_escape : Callable[[str], str]
         The string escape function.
+
     Returns
     -------
     str
@@ -220,7 +221,6 @@ def _sort_imports(
     Tuple[List[str], List[str], List[str]]
         The sorted skill imports.
     """
-
     # "from x import y" and "import z"
     # the "import a" should be first (and sorted)
     # then the "from b import c" (and sorted)
@@ -254,6 +254,7 @@ def get_skill_secrets_import(flow_name: str, skill: WaldiezSkill) -> str:
         The name of the flow.
     skill : WaldiezSkill
         The skill.
+
     Returns
     -------
     str
@@ -274,7 +275,7 @@ def get_agent_skill_registrations(
     skill_names: Dict[str, str],
     string_escape: Callable[[str], str],
 ) -> str:
-    """Get the agent skill registrations.
+    r"""Get the agent skill registrations.
 
     example output:
 
@@ -333,6 +334,7 @@ def get_agent_skill_registrations(
         A mapping of skill id to skill name.
     string_escape : Callable[[str], str]
         The string escape function.
+
     Returns
     -------
     str

waldiez/models/__init__.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
 """Waldiez models.
+
 - Agents (Users, Assistants, Group Managers, etc.).
 - Chat (Messages, Summaries, etc.).
 - Model (LLM config, API type, etc.).

waldiez/models/agents/agent/agent.py

@@ -148,7 +148,7 @@ class WaldiezAgent(WaldiezBase):
     def ag2_imports(self) -> Set[str]:
         """Return the AG2 imports of the agent."""
         agent_class = self.ag2_class
-        imports = set(["import autogen"])
+        imports = {"import autogen"}
         if agent_class == "AssistantAgent":
             imports.add("from autogen import AssistantAgent")
         elif agent_class == "UserProxyAgent":

waldiez/models/agents/agent/termination_message.py

@@ -192,6 +192,7 @@ class WaldiezAgentTerminationMessage(WaldiezBase):
         ------
         ValueError
             If the configuration is invalid.
+
         Returns
         -------
         WaldiezAgentTerminationMessage

waldiez/models/agents/group_manager/speakers.py

@@ -31,7 +31,7 @@ CUSTOM_SPEAKER_SELECTION_TYPES = (
 
 
 class WaldiezGroupManagerSpeakers(WaldiezBase):
-    """Group chat speakers.
+    r"""Group chat speakers.
 
     If the method for the speaker selection is `custom`
     the `selection_custom_method` contents (source code) will be used.

waldiez/models/agents/rag_user/retrieve_config.py

@@ -844,6 +844,7 @@ def resolve_path(path: str, is_raw: bool, must_exist: bool) -> str:
         If the path is a raw string.
     must_exist : bool
         If the path must exist.
+
     Returns
     -------
     Path

waldiez/models/agents/swarm_agent/after_work.py

@@ -35,7 +35,6 @@ CUSTOM_AFTER_WORK_TYPES = (
 class WaldiezSwarmAfterWork(WaldiezBase):
     """Swarm after work.
 
-
     Attributes
     ----------
     recipient : str

waldiez/models/agents/swarm_agent/on_condition.py

@@ -93,6 +93,7 @@ class WaldiezSwarmOnCondition(WaldiezBase):
             The prefix to add to the function name. Default is None.
         name_suffix : str, optional
             The suffix to add to the function name. Default is None.
+
         Returns
         -------
         Tuple[str, str]

waldiez/models/agents/swarm_agent/on_condition_available.py

@@ -84,6 +84,7 @@ class WaldiezSwarmOnConditionAvailable(WaldiezBase):
             The prefix to add to the function name. Default is None.
         name_suffix : str, optional
             The suffix to add to the function name. Default is None.
+
         Returns
         -------
         Tuple[str, str]

waldiez/models/chat/chat.py

@@ -318,6 +318,7 @@ class WaldiezChat(WaldiezBase):
             Whether to get the chat arguments for a chat queue.
         sender : WaldiezAgent, optional
             The sender agent, to check if it's a RAG user.
+
         Returns
         -------
         dict
@@ -342,6 +343,7 @@ class WaldiezChat(WaldiezBase):
         ----------
         kwargs : Any
             The keyword arguments.
+
         Returns
         -------
         Dict[str, Any]

waldiez/models/chat/chat_message.py

@@ -204,6 +204,7 @@ def get_last_carryover_method_content(text_content: str) -> str:
     ----------
     text_content : str
         Text content before the carryover.
+
     Returns
     -------
     str

waldiez/models/common/method_utils.py

@@ -151,6 +151,7 @@ def check_function(
         The expected method name.
     function_args : List[str]
         The expected method arguments.
+
     Returns
     -------
     Tuple[bool, str]
@@ -186,6 +187,7 @@ def _validate_function_body(
         The expected method name.
     function_args : List[str]
         The expected method arguments.
+
     Returns
     -------
     Tuple[bool, str]
@@ -205,7 +207,11 @@ def _validate_function_body(
                         f" got: {len(node.args.args)} :("
                     ),
                 )
-            for arg, expected_arg in zip(node.args.args, function_args):
+            for arg, expected_arg in zip(
+                node.args.args,
+                function_args,
+                strict=False,
+            ):
                 if arg.arg != expected_arg:
                     return (
                         False,
@@ -315,6 +321,7 @@ def generate_function(
     types_as_comments : bool, optional
         Include the type hints as comments (or in the function signature)
         (default is False).
+
     Returns
     -------
     str
@@ -327,7 +334,9 @@ def generate_function(
         function_string += ")"
     else:
         function_string += "\n"
-        for arg, arg_type in zip(function_args, function_types[0]):
+        for arg, arg_type in zip(
+            function_args, function_types[0], strict=False
+        ):
             if types_as_comments:
                 function_string += f"    {arg},  # type: {arg_type}" + "\n"
             else:

waldiez/models/flow/flow.py

@@ -514,6 +514,7 @@ class WaldiezFlow(WaldiezBase):
         ----------
         member : WaldiezAgent
             The only agent in the flow
+
         Returns
         -------
         WaldiezFlow

waldiez/models/skill/extra_requirements.py

@@ -19,6 +19,7 @@ def get_skills_extra_requirements(
         The skills.
     autogen_version : str
         The ag2 version.
+
     Returns
     -------
     List[str]