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

waldiez/_version.py

@@ -5,4 +5,4 @@
 This file is automatically generated by Hatchling.
 Do not edit this file directly.
 """
-__version__ = VERSION = "0.5.7"
+__version__ = VERSION = "0.5.8"

waldiez/cli.py

@@ -100,6 +100,19 @@ def run(
         False,
         help="Override the output file if it already exists.",
     ),
+    env_file: Optional[Path] = typer.Option(  # noqa: B008
+        None,
+        "--env-file",
+        "-e",
+        help=(
+            "Path to a .env file containing additional environment variables. "
+            "These variables will be set before running the flow."
+        ),
+        file_okay=True,
+        dir_okay=False,
+        readable=True,
+        resolve_path=True,
+    ),
 ) -> None:
     """Run a Waldiez flow."""
     os.environ["AUTOGEN_USE_DOCKER"] = "0"
@@ -126,6 +139,7 @@ def run(
             structured,  # structured_io
             False,  # skip_mmd
             False,  # skip_timeline
+            env_file,
         )
     else:
         runner.run(
@@ -134,6 +148,7 @@ def run(
             structured_io=structured,
             skip_mmd=False,
             skip_timeline=False,
+            dot_env=env_file,
         )
 
 
@@ -157,7 +172,7 @@ def convert(
             "Path to the output file. "
             "The file extension determines the output format: "
             "`.py` for Python script, `.ipynb` for Jupyter notebook."
-            " If not provided, the output will be saved in the same directory as the input file."
+            " If not provided, the output (.py) will be saved in the same directory as the input file."
             " If the file already exists, it will not be overwritten unless --force is used."
         ),
         file_okay=True,

waldiez/exporting/chats/utils/common.py

@@ -1,5 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
+# pylint: disable=line-too-long
+# flake8: noqa: E501
 """Common utilities for exporting chats."""
 
 import json
@@ -99,14 +101,56 @@ def get_event_handler_string(
         f"{tab}                should_continue = False\n"
         f"{tab}            if not should_continue:\n"
         f"{tab}                break\n"
+    )
+    content += get_result_dicts_string(tab, is_async)
+    content += (
         f"{tab}else:\n"
         f"{tab}    if not isinstance(results, list):\n"
         f"{tab}        results = [results]\n"
-        f"{tab}    for result in results:\n"
+        f"{tab}    for index, result in enumerate(results):\n"
     )
     if is_async:
         content += f"{tab}        await result.process()\n"
     else:
         content += f"{tab}        result.process()\n"
+    content += get_result_dicts_string(tab, is_async)
 
     return content
+
+
+def get_result_dicts_string(tab: str, is_async: bool) -> str:
+    """Get the result dicts string.
+
+    Parameters
+    ----------
+    tab : str
+        The space string to use for indentation.
+    is_async : bool
+        Whether the function is asynchronous.
+
+    Returns
+    -------
+    str
+        The result dicts string.
+    """
+    space = f"{tab}        "
+    flow_content = f"{space}result_dict = {{\n"
+    flow_content += f"{space}    'index': index,\n"
+    if is_async:
+        flow_content += f"{space}    'messages': await result.messages,\n"
+        flow_content += f"{space}    'summary': await result.summary,\n"
+        flow_content += f"{space}    'cost': (await result.cost).model_dump(mode='json', fallback=str) if await result.cost else None,\n"
+        flow_content += f"{space}    'context_variables': (await result.context_variables).model_dump(mode='json', fallback=str) if await result.context_variables else None,\n"
+        flow_content += (
+            f"{space}    'last_speaker': await result.last_speaker,\n"
+        )
+    else:
+        flow_content += f"{space}    'messages': result.messages,\n"
+        flow_content += f"{space}    'summary': result.summary,\n"
+        flow_content += f"{space}    'cost': result.cost.model_dump(mode='json', fallback=str) if result.cost else None,\n"
+        flow_content += f"{space}    'context_variables': result.context_variables.model_dump(mode='json', fallback=str) if result.context_variables else None,\n"
+        flow_content += f"{space}    'last_speaker': result.last_speaker,\n"
+    flow_content += f"{space}    'uuid': str(result.uuid),\n"
+    flow_content += f"{space}}}\n"
+    flow_content += f"{space}result_dicts.append(result_dict)\n"
+    return flow_content

waldiez/exporting/chats/utils/group.py

@@ -43,7 +43,7 @@ def export_group_chats(
     tab = "    " * tabs
     run_group_chat = "run_group_chat"
     if is_async:
-        run_group_chat = "a_run_group_chat"
+        run_group_chat = "await a_run_group_chat"
     manager_name = agent_names[manager.id]
     pattern_name = f"{manager_name}_pattern"
     content = f"{tab}results = {run_group_chat}(" + "\n"

waldiez/exporting/flow/execution_generator.py

@@ -115,11 +115,14 @@ class ExecutionGenerator:
                 "Callable[[BaseEvent], Coroutine[None, None, bool]]"
                 "] = None"
             )
-        return_type_hint = (
-            "AsyncRunResponseProtocol" if is_async else "RunResponseProtocol"
-        )
+        return_type_hint = "list[dict[str, Any]]"
         flow_content += f"def main({on_event_arg}) -> {return_type_hint}:\n"
-        flow_content += f"    {main_doc_string(is_async=is_async)}\n"
+        flow_content += f"    {main_doc_string()}\n"
+        if not is_async:
+            flow_content += "    results: list[RunResponseProtocol] | RunResponseProtocol = []\n"
+        else:
+            flow_content += "    results: list[AsyncRunResponseProtocol] | AsyncRunResponseProtocol = []\n"
+        flow_content += "    result_dicts: list[dict[str, Any]] = []\n"
         space = "    "
         if cache_seed is not None:
             flow_content += (
@@ -138,7 +141,7 @@ class ExecutionGenerator:
             flow_content += after_run + "\n"
         if cache_seed is not None:
             space = space[4:]
-        flow_content += f"{space}return results\n"
+        flow_content += f"{space}return result_dicts\n"
         return flow_content
 
     @staticmethod
@@ -163,42 +166,19 @@ class ExecutionGenerator:
             if is_async:
                 return "# %%\nawait main()\n"
             return "# %%\nmain()\n"
+        return_type_hint = "list[dict[str, Any]]"
         if is_async:
             content += "async def call_main() -> None:\n"
-            return_type_hint = "list[AsyncRunResponseProtocol]"
         else:
             content += "def call_main() -> None:\n"
-            return_type_hint = "list[RunResponseProtocol]"
         content += f'{tab}"""Run the main function and print the results."""\n'
         content += f"{tab}results: {return_type_hint} = "
         if is_async:
             content += "await "
         content += "main()\n"
-        content += f"{tab}results_dicts: list[dict[str, Any]] = []\n"
-        content += f"{tab}for result in results:\n"
-        if is_async:
-            content += f"{tab}{tab}result_summary = await result.summary\n"
-            content += f"{tab}{tab}result_messages = await result.messages\n"
-            content += f"{tab}{tab}result_cost = await result.cost\n"
-        else:
-            content += f"{tab}{tab}result_summary = result.summary\n"
-            content += f"{tab}{tab}result_messages = result.messages\n"
-            content += f"{tab}{tab}result_cost = result.cost\n"
-        content += f"{tab}{tab}cost: dict[str, Any] | None = None\n"
-        content += f"{tab}{tab}if result_cost:\n"
-        content += f'{tab}{tab}{tab}cost = result_cost.model_dump(mode="json", fallback=str)\n'
-        content += f"{tab}{tab}results_dicts.append(\n"
-        content += f"{tab}{tab}{tab}{{\n"
-        content += f"{tab}{tab}{tab}{tab}'summary': result_summary,\n"
-        content += f"{tab}{tab}{tab}{tab}'messages': result_messages,\n"
-        content += f"{tab}{tab}{tab}{tab}'cost': cost,\n"
-        content += f"{tab}{tab}{tab}}}\n"
-        content += f"{tab}{tab})\n"
-        content += "\n"
-        content += f"{tab}results_dict = {{\n"
-        content += f"{tab}{tab}'results': results_dicts,\n"
-        content += f"{tab}}}\n"
-        content += f"{tab}print(json.dumps(results_dict, indent=2))\n"
+        content += (
+            f"{tab}print(json.dumps(results, indent=2, ensure_ascii=False))\n"
+        )
         return content
 
     @staticmethod
@@ -226,3 +206,45 @@ class ExecutionGenerator:
         else:
             content += "    call_main()\n"
         return content
+
+
+def get_result_dicts_string(space: str, is_async: bool) -> str:
+    """Get the result dicts string.
+
+    Parameters
+    ----------
+    space : str
+        The space string to use for indentation.
+    is_async : bool
+        Whether the function is asynchronous.
+
+    Returns
+    -------
+    str
+        The result dicts string.
+    """
+    flow_content = f"{space}for index, result in enumerate(results):\n"
+    if not is_async:
+        flow_content += f"{space}    result_dict = {{\n"
+        flow_content += f"{space}        'index': index,\n"
+        flow_content += f"{space}        'messages': result.messages,\n"
+        flow_content += f"{space}        'summary': result.summary,\n"
+        flow_content += f"{space}        'cost': result.cost.model_dump(mode='json', fallback=str) if result.cost else None,\n"
+        flow_content += f"{space}        'context_variables': result.context_variables.model_dump(mode='json', fallback=str) if result.context_variables else None,\n"
+        flow_content += f"{space}        'last_speaker': result.last_speaker,\n"
+        flow_content += f"{space}        'uuid': str(result.uuid),\n"
+        flow_content += f"{space}    }}\n"
+    else:
+        flow_content += f"{space}    result_dict = {{\n"
+        flow_content += f"{space}        'index': index,\n"
+        flow_content += f"{space}        'messages': await result.messages,\n"
+        flow_content += f"{space}        'summary': await result.summary,\n"
+        flow_content += f"{space}        'cost': (await result.cost).model_dump(mode='json', fallback=str) if await result.cost else None,\n"
+        flow_content += f"{space}        'context_variables': (await result.context_variables).model_dump(mode='json', fallback=str) if await result.context_variables else None,\n"
+        flow_content += (
+            f"{space}        'last_speaker': await result.last_speaker,\n"
+        )
+        flow_content += f"{space}        'uuid': str(result.uuid),\n"
+        flow_content += f"{space}    }}\n"
+    flow_content += f"{space}    result_dicts.append(result_dict)\n"
+    return flow_content

waldiez/exporting/flow/utils/common.py

@@ -102,29 +102,21 @@ Tags: {", ".join(tags)}
 """'''
 
 
-def main_doc_string(is_async: bool) -> str:
+def main_doc_string() -> str:
     """Generate the docstring for the main function.
 
-    Parameters
-    ----------
-    is_async : bool
-        Whether the main function is asynchronous.
-
     Returns
     -------
     str
         The docstring for the main function.
     """
-    return_type_hint = (
-        "AsyncRunResponseProtocol" if is_async else "RunResponseProtocol"
-    )
+    return_type_hint = "list[dict[str, Any]]"
     return f'''"""Start chatting.
 
     Returns
     -------
     {return_type_hint}
-        The result of the chat session, which can be a single ChatResult,
-        a list of ChatResults, or a dictionary mapping integers to ChatResults.
+        The result of the chat session.
 
     Raises
     ------
@@ -193,6 +185,7 @@ def get_common_env_var_setup() -> str:
     """
     content = """
 # Common environment variable setup for Waldiez flows
+load_dotenv(override=True)
 os.environ["AUTOGEN_USE_DOCKER"] = "0"
 os.environ["ANONYMIZED_TELEMETRY"] = "False"
 """

waldiez/exporting/flow/utils/importing.py

@@ -100,7 +100,8 @@ def sort_imports(
             third_party_imports.append(import_string)
         elif position == ImportPosition.LOCAL:  # pragma: no branch
             local_imports.append(import_string)
-
+    if "from dotenv import load_dotenv" not in third_party_imports:
+        third_party_imports.append("from dotenv import load_dotenv")
     autogen_imports = clean_and_group_autogen_imports(autogen_imports)
     third_party_imports = ensure_np_import(third_party_imports)
     sorted_builtins = get_sorted_imports(builtin_imports)

waldiez/exporting/models/exporter.py

@@ -186,7 +186,8 @@ class ModelsExporter(Exporter[ModelExtras]):
             for_notebook=self.config.for_notebook,
         )
         loader_script = f'''{comment}# NOTE:
-# This section assumes that a file named "{self.flow_name}_api_keys"
+# This section assumes that a file named:
+# "{self.flow_name}_api_keys.py"
 # exists in the same directory as this file.
 # This file contains the API keys for the models used in this flow.
 # It should be .gitignored and not shared publicly.

waldiez/exporting/tools/exporter.py

@@ -176,7 +176,8 @@ class ToolsExporter(Exporter[ToolExtras]):
             for_notebook=self.config.for_notebook,
         )
         loader_script = f'''{comment}# NOTE:
-# This section assumes that a file named "{self.flow_name}_{tool_name}_secrets"
+# This section assumes that a file named:
+# "{self.flow_name}_{tool_name}_secrets.py"
 # exists in the same directory as this file.
 # This file contains the secrets for the tool used in this flow.
 # It should be .gitignored and not shared publicly.

waldiez/exporting/tools/processor.py

@@ -192,7 +192,12 @@ ag2_{tool_name} = ag2_{tool_name}_interop.convert_tool(
                 )
                 f.write("import os\n\n")
                 for key, value in tool.secrets.items():
-                    f.write(f'os.environ["{key}"] = "{value}"\n')
+                    # f.write(f'os.environ["{key}"] = "{value}"\n')
+                    # check first if the key already exists in os.environ
+                    f.write(
+                        f'os.environ["{key}"] = '
+                        f'os.environ.get("{key}", "{value}")\n'
+                    )
         except Exception as exc:  # pragma: no cover
             raise ExporterContentError(
                 f"Failed to write secrets file for tool '{tool_name}': {exc}"

waldiez/models/model/model.py

@@ -338,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/predefined/_google.py

@@ -138,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.
@@ -164,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
@@ -120,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/_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/_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/runner.py

@@ -14,7 +14,7 @@ variables specified in the waldiez file are set.
 """
 
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Union
+from typing import Any
 
 from typing_extensions import Literal
 
@@ -24,12 +24,6 @@ from .running import (
     WaldiezStandardRunner,
 )
 
-if TYPE_CHECKING:
-    from autogen.io.run_response import (  # type: ignore[import-untyped]
-        AsyncRunResponseProtocol,
-        RunResponseProtocol,
-    )
-
 
 def create_runner(
     waldiez: Waldiez,
@@ -38,6 +32,7 @@ def create_runner(
     output_path: str | Path | None = None,
     uploads_root: str | Path | None = None,
     structured_io: bool = False,
+    dot_env: str | Path | None = None,
     **kwargs: Any,
 ) -> WaldiezBaseRunner:
     """Create a Waldiez runner of the specified type.
@@ -54,6 +49,8 @@ def create_runner(
         Uploads root directory, by default None
     structured_io : bool, optional
         Use structured I/O, by default False
+    dot_env : str | Path | None, optional
+        Path to a .env file for environment variables, by default None
     **kwargs
         Additional arguments for specific runner types
 
@@ -84,6 +81,7 @@ def create_runner(
         output_path=output_path,
         uploads_root=uploads_root,
         structured_io=structured_io,
+        dot_env=dot_env,
         **kwargs,
     )
 
@@ -101,6 +99,7 @@ class WaldiezRunner(WaldiezBaseRunner):
         output_path: str | Path | None = None,
         uploads_root: str | Path | None = None,
         structured_io: bool = False,
+        dot_env: str | Path | None = None,
         **kwargs: Any,
     ):
         """Create a runner instance.
@@ -117,9 +116,10 @@ class WaldiezRunner(WaldiezBaseRunner):
             Uploads root directory, by default None
         structured_io : bool, optional
             Use structured I/O, by default False
+        dot_env : str | Path | None, optional
+            Path to a .env file for environment variables, by default None
         **kwargs
             Additional arguments for specific runner types
-
         """
         self._runner = create_runner(
             waldiez=waldiez,
@@ -127,6 +127,7 @@ class WaldiezRunner(WaldiezBaseRunner):
             output_path=output_path,
             uploads_root=uploads_root,
             structured_io=structured_io,
+            dot_env=dot_env,
             **kwargs,
         )
 
@@ -165,10 +166,7 @@ class WaldiezRunner(WaldiezBaseRunner):
         skip_mmd: bool,
         skip_timeline: bool,
         **kwargs: Any,
-    ) -> Union[
-        list["RunResponseProtocol"],
-        list["AsyncRunResponseProtocol"],
-    ]:
+    ) -> list[dict[str, Any]]:
         return self._runner._run(
             temp_dir=temp_dir,
             output_file=output_file,
@@ -205,14 +203,16 @@ class WaldiezRunner(WaldiezBaseRunner):
         uploads_root: Path | None,
         skip_mmd: bool,
         skip_timeline: bool,
+        dot_env: str | Path | None = None,
         **kwargs: Any,
-    ) -> Union[list["RunResponseProtocol"], list["AsyncRunResponseProtocol"]]:
+    ) -> list[dict[str, Any]]:
         return await self._runner._a_run(
             temp_dir=temp_dir,
             output_file=output_file,
             uploads_root=uploads_root,
             skip_mmd=skip_mmd,
             skip_timeline=skip_timeline,
+            dot_env=dot_env,
             **kwargs,
         )
 
@@ -246,6 +246,7 @@ class WaldiezRunner(WaldiezBaseRunner):
         output_path: str | Path | None = None,
         uploads_root: str | Path | None = None,
         structured_io: bool = False,
+        dot_env: str | Path | None = None,
         **kwargs: Any,
     ) -> "WaldiezRunner":
         """Load a waldiez flow and create a runner.
@@ -268,6 +269,8 @@ class WaldiezRunner(WaldiezBaseRunner):
             Uploads root directory, by default None
         structured_io : bool, optional
             Use structured I/O, by default False
+        dot_env : str | Path | None, optional
+            Path to a .env file for environment variables, by default None
         **kwargs
             Additional arguments for specific runner types
 
@@ -295,5 +298,6 @@ class WaldiezRunner(WaldiezBaseRunner):
             output_path=output_path,
             uploads_root=uploads_root,
             structured_io=structured_io,
+            dot_env=dot_env,
             **kwargs,
         )