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

waldiez/running/environment.py

@@ -63,6 +63,7 @@ def refresh_environment() -> None:
 
 
 # pylint: disable=too-complex,too-many-try-statements,unused-import
+# noinspection TryExceptPass
 def reload_autogen() -> None:  # noqa: C901  # pragma: no cover
     """Reload the autogen package.
 

waldiez/running/exceptions.py

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+"""Custom exceptions for Waldiez runners."""
+
+
+class StopRunningException(Exception):
+    """Exception to stop the running process."""
+
+    reason: str = "Execution stopped by user"

waldiez/running/post_run.py

@@ -11,8 +11,8 @@ from pathlib import Path
 from typing import Optional, Union
 
 from .gen_seq_diagram import generate_sequence_diagram
-from .patch_io_stream import get_printer
 from .timeline_processor import TimelineProcessor
+from .utils import get_printer
 
 
 # noinspection PyUnusedLocal
@@ -52,7 +52,7 @@ def after_run(
             flow_name=flow_name,
             mmd_dir=mmd_dir,
         )
-    if skip_timeline is False:
+    if skip_timeline is False:  # pragma: no branch
         _make_timeline_json(temp_dir=temp_dir)
     if output_file:
         destination_dir = output_file.parent
@@ -103,7 +103,7 @@ def _make_timeline_json(
     events_csv_path = temp_dir / "logs" / "events.csv"
     if events_csv_path.exists():
         log_files = TimelineProcessor.get_files(temp_dir / "logs")
-        if any(log_files.values()):
+        if any(log_files.values()):  # pragma: no branch
             output_file = temp_dir / "timeline.json"
             # pylint: disable=too-many-try-statements
             try:
@@ -171,7 +171,7 @@ def copy_results(
     if output_file.is_file():
         if output_file.suffix == ".waldiez":
             output_file = output_file.with_suffix(".py")
-        if output_file.suffix == ".py":
+        if output_file.suffix == ".py":  # pragma: no branch
             src = temp_dir / output_file.name
             if src.exists():
                 dst = destination_dir / output_file.name

waldiez/running/pre_run.py

@@ -9,10 +9,53 @@ import subprocess
 import sys
 from typing import Callable
 
+from waldiez.models import Waldiez
+
 from .environment import in_virtualenv, is_root
 from .utils import strip_ansi
 
 
+class RequirementsMixin:
+    """Mixin class to handle requirements installation."""
+
+    _waldiez: Waldiez
+    _called_install_requirements: bool
+
+    def gather_requirements(self) -> set[str]:
+        """Gather extra requirements to install before running the flow.
+
+        Returns
+        -------
+        set[str]
+            A set of requirements that are not already installed and do not
+            include 'waldiez' in their name.
+        """
+        extra_requirements = {
+            req
+            for req in self._waldiez.requirements
+            if req not in sys.modules and "waldiez" not in req
+        }
+        if "python-dotenv" not in extra_requirements:  # pragma: no branch
+            extra_requirements.add("python-dotenv")
+        return extra_requirements
+
+    def install_requirements(self) -> None:
+        """Install the requirements for the flow."""
+        if not self._called_install_requirements:  # pragma: no branch
+            self._called_install_requirements = True
+            extra_requirements = self.gather_requirements()
+            if extra_requirements:  # pragma: no branch
+                install_requirements(extra_requirements)
+
+    async def a_install_requirements(self) -> None:
+        """Install the requirements for the flow asynchronously."""
+        if not self._called_install_requirements:  # pragma: no branch
+            self._called_install_requirements = True
+            extra_requirements = self.gather_requirements()
+            if extra_requirements:  # pragma: no branch
+                await a_install_requirements(extra_requirements)
+
+
 # noinspection PyUnresolvedReferences
 def install_requirements(
     extra_requirements: set[str],
@@ -34,7 +77,7 @@ def install_requirements(
     printer(f"Installing requirements: {requirements_string}")
     pip_install = [sys.executable, "-m", "pip", "install"]
     break_system_packages = ""
-    if not in_virtualenv():  # it should
+    if not in_virtualenv():  # it should  # pragma: no cover
         # if not, let's try to install as user
         # not sure if --break-system-packages is safe,
         # but it might fail if we don't
@@ -42,7 +85,7 @@ def install_requirements(
         os.environ["PIP_BREAK_SYSTEM_PACKAGES"] = "1"
         if not is_root():
             pip_install.append("--user")
-    if upgrade:
+    if upgrade:  # pragma: no cover
         pip_install.append("--upgrade")
     pip_install.extend(extra_requirements)
     # pylint: disable=too-many-try-statements
@@ -52,14 +95,14 @@ def install_requirements(
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
         ) as proc:
-            if proc.stdout:
+            if proc.stdout:  # pragma: no branch
                 for line in io.TextIOWrapper(proc.stdout, encoding="utf-8"):
                     printer(strip_ansi(line.strip()))
-            if proc.stderr:
+            if proc.stderr:  # pragma: no branch
                 for line in io.TextIOWrapper(proc.stderr, encoding="utf-8"):
                     printer(strip_ansi(line.strip()))
     finally:
-        if not in_virtualenv():
+        if not in_virtualenv():  # pragma: no cover
             # restore the old env var
             if break_system_packages:
                 os.environ["PIP_BREAK_SYSTEM_PACKAGES"] = break_system_packages
@@ -87,12 +130,12 @@ async def a_install_requirements(
     printer(f"Installing requirements: {requirements_string}")
     pip_install = [sys.executable, "-m", "pip", "install"]
     break_system_packages = ""
-    if not in_virtualenv():
+    if not in_virtualenv():  # pragma: no cover
         break_system_packages = os.environ.get("PIP_BREAK_SYSTEM_PACKAGES", "")
         os.environ["PIP_BREAK_SYSTEM_PACKAGES"] = "1"
         if not is_root():
             pip_install.extend(["--user"])
-    if upgrade:
+    if upgrade:  # pragma: no cover
         pip_install.append("--upgrade")
     pip_install.extend(extra_requirements)
     # pylint: disable=too-many-try-statements
@@ -109,40 +152,8 @@ async def a_install_requirements(
             async for line in proc.stderr:
                 printer(strip_ansi(line.decode().strip()))
     finally:
-        if not in_virtualenv():
+        if not in_virtualenv():  # pragma: no cover
             if break_system_packages:
                 os.environ["PIP_BREAK_SYSTEM_PACKAGES"] = break_system_packages
             else:
                 del os.environ["PIP_BREAK_SYSTEM_PACKAGES"]
-
-
-def install_waldiez(
-    upgrade: bool = True,
-    printer: Callable[..., None] = print,
-) -> None:
-    """Install Waldiez.
-
-    Parameters
-    ----------
-    upgrade : bool, optional
-        Whether to upgrade Waldiez, by default True.
-    printer : Callable[..., None]
-        The printer function to use, defaults to print.
-    """
-    install_requirements({"waldiez"}, upgrade, printer)
-
-
-async def a_install_waldiez(
-    upgrade: bool = True,
-    printer: Callable[..., None] = print,
-) -> None:
-    """Install Waldiez asynchronously.
-
-    Parameters
-    ----------
-    upgrade : bool, optional
-        Whether to upgrade Waldiez, by default True.
-    printer : Callable[..., None]
-        The printer function to use, defaults to print.
-    """
-    await a_install_requirements({"waldiez"}, upgrade, printer)

waldiez/running/protocol.py

@@ -51,98 +51,24 @@ class WaldiezRunnerProtocol(Protocol):
             The path to the temporary directory created for the run.
         """
 
-    def start(
-        self,
-        output_path: str | Path | None,
-        uploads_root: str | Path | None,
-        structured_io: bool | None = None,
-        skip_mmd: bool = False,
-        skip_timeline: bool = False,
-        dot_env: str | Path | None = None,
-        **kwargs: Any,
-    ) -> None:
-        """Start running the Waldiez flow in a non-blocking way.
-
-        To allow "stoping" it later.
-
-        Parameters
-        ----------
-        output_path : str | Path | None
-            The output path.
-        uploads_root : str | Path | None
-            The runtime uploads root.
-        structured_io : bool
-            Whether to use structured IO instead of the default 'input/print'.
-        skip_mmd : bool
-            Whether to skip generating the mermaid diagram.
-        skip_timeline : bool
-            Whether to skip generating the timeline JSON.
-        dot_env : str | Path | None
-            The path to the .env file, if any.
-        **kwargs : Any
-            Additional keyword arguments for the start method.
-
-        Raises
-        ------
-        RuntimeError
-            If the runner is already running.
-        """
-
-    async def a_start(
-        self,
-        output_path: str | Path | None,
-        uploads_root: str | Path | None,
-        structured_io: bool | None = None,
-        skip_mmd: bool = False,
-        skip_timeline: bool = False,
-        dot_env: str | Path | None = None,
-        **kwargs: Any,
-    ) -> None:
-        """Asynchronously start running the Waldiez flow in a non-blocking way.
-
-        To allow "stoping" it later.
-
-        Parameters
-        ----------
-        output_path :  str | Path | None
-            The output path.
-        uploads_root : str | Path | None
-            The runtime uploads root.
-        structured_io : bool
-            Whether to use structured IO instead of the default 'input/print'.
-        skip_mmd : bool
-            Whether to skip generating the mermaid diagram.
-        skip_timeline : bool
-            Whether to skip generating the timeline JSON.
-        dot_env : str | Path | None
-            The path to the .env file, if any.
-        **kwargs : Any
-            Additional keyword arguments for the start method.
-
-        Raises
-        ------
-        RuntimeError
-            If the runner is already running.
-        """
-
     def run(
         self,
-        output_path: str | Path | None,
-        uploads_root: str | Path | None,
+        output_path: str | Path | None = None,
+        uploads_root: str | Path | None = None,
         structured_io: bool | None = None,
         skip_mmd: bool = False,
         skip_timeline: bool = False,
         dot_env: str | Path | None = None,
         **kwargs: Any,
     ) -> list[dict[str, Any]]:
-        """Run the Waldiez flow in a blocking way.
+        """Run the Waldiez flow.
 
         Parameters
         ----------
         output_path : str | Path | None
             The output path, by default None.
         uploads_root : str | Path | None
-            The runtime uploads root.
+            The runtime uploads root, by default None.
         structured_io : bool
             Whether to use structured IO instead of the default 'input/print'.
         skip_mmd : bool
@@ -157,20 +83,26 @@ class WaldiezRunnerProtocol(Protocol):
         Returns
         -------
         list[dict[str, Any]]
-            The result of the run.
+            The results of the run.
+
+        Raises
+        ------
+        RuntimeError
+            If the runner is already running
+            or an error occurs during the run.
         """
 
     async def a_run(
         self,
-        output_path: str | Path | None,
-        uploads_root: str | Path | None,
+        output_path: str | Path | None = None,
+        uploads_root: str | Path | None = None,
         structured_io: bool | None = None,
         skip_mmd: bool = False,
         skip_timeline: bool = False,
         dot_env: str | Path | None = None,
         **kwargs: Any,
     ) -> list[dict[str, Any]]:
-        """Run the Waldiez flow.
+        """Run the Waldiez flow asynchronously.
 
         Parameters
         ----------
@@ -192,7 +124,13 @@ class WaldiezRunnerProtocol(Protocol):
         Returns
         -------
         list[dict[str, Any]]
-            The result of the run.
+            The results of the run.
+
+        Raises
+        ------
+        RuntimeError
+            If the runner is already running, the workflow is not async
+            or an error occurs during the run.
         """
 
     def after_run(
@@ -257,21 +195,3 @@ class WaldiezRunnerProtocol(Protocol):
         bool
             True if the runner is running, False otherwise.
         """
-
-    def stop(self) -> None:
-        """Stop the runner if it is running.
-
-        Raises
-        ------
-        RuntimeError
-            If the runner is not running.
-        """
-
-    async def a_stop(self) -> None:
-        """Asynchronously stop the runner if it is running.
-
-        Raises
-        ------
-        RuntimeError
-            If the runner is not running.
-        """

waldiez/running/run_results.py

@@ -10,5 +10,5 @@ class WaldiezRunResults(TypedDict):
     """Results of the Waldiez run."""
 
     results: list[dict[str, Any]]
-    exception: Exception | None
+    exception: BaseException | None
     completed: bool