waldiez 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

waldiez/running/gen_seq_diagram.py

@@ -0,0 +1,185 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+"""Generate a Mermaid sequence diagram from a file containing event data."""
+
+import json
+import re
+from pathlib import Path
+from typing import Any, Dict, Set, Union
+
+import pandas as pd
+
+MAX_LEN = 100
+SEQ_TXT = """
+%%{init: {'sequence': {'actorSpacing': 10, 'width': 150}}}%%
+sequenceDiagram
+"""
+
+
+def escape_mermaid_text(text: str) -> str:
+    """Replace newline characters with <br/> for Mermaid compatibility.
+
+    Parameters
+    ----------
+    text : str
+        The text to escape.
+
+    Returns
+    -------
+    str
+        The escaped text with newline characters replaced by <br/>.
+    """
+    if len(text) > MAX_LEN:
+        limited_text = text[:MAX_LEN] + "..."
+    else:
+        limited_text = text
+    output = limited_text.replace("\n", "<br/>")
+    output = re.sub(r"<br/>\s*<br/>", "<br/><br/>", output)
+    return output
+
+
+def get_json_state(json_state: Any) -> Dict[str, Any]:
+    """Get the JSON state of the event.
+
+    Parameters
+    ----------
+    json_state : Union[str, dict]
+        The JSON state of the event.
+
+    Returns
+    -------
+    dict
+        The JSON state of the event.
+    """
+    if isinstance(json_state, dict):
+        return json_state
+    if isinstance(json_state, str):
+        try:
+            return json.loads(json_state)
+        except json.JSONDecodeError:
+            return {}
+    return {}
+
+
+# pylint: disable=too-many-locals
+def process_events(df_events: pd.DataFrame) -> str:
+    """Process the events DataFrame and generate a Mermaid sequence diagram.
+
+    Parameters
+    ----------
+    df_events : pd.DataFrame
+        The DataFrame containing the events data.
+    Returns
+    -------
+    str
+        The Mermaid sequence diagram text.
+    """
+
+    # Set to store participants (senders and recipients)
+    participants: Set[str] = set()
+    recipient: str
+
+    # Initialize the sequence diagram text
+    seq_text = SEQ_TXT
+
+    # Loop through each event in the DataFrame
+    for i in range(len(df_events["json_state"])):
+        # Parse the JSON state of the event
+        df_j = get_json_state(df_events["json_state"][i])
+        # Skip events that are not relevant (e.g., replies or missing messages)
+        if ("message" in df_j.keys()) and (
+            df_events["event_name"][i] != "reply_func_executed"
+        ):
+            sender = df_j["sender"]
+            recipient = df_events["source_name"][i]
+
+            # Extract message content if available
+            if (
+                isinstance(df_j["message"], dict)
+                and "content" in df_j["message"]
+            ):
+                message = "Content: " + str(df_j["message"]["content"])
+            else:
+                message = str(df_j["message"])
+
+            # Escape the message for Mermaid compatibility and
+            # truncate long messages
+            message = escape_mermaid_text(message)
+
+            # Add sender and recipient to participants set
+            participants.add(recipient)
+            participants.add(sender)
+
+            # Split message into main message and context
+            # if "Content" is present
+            if "Content: " in message:
+                message_parts = message.split("Content: ")
+                main_message = message_parts[0].strip()
+                context = "Content: " + message_parts[1].strip()
+                seq_text += f"    {sender}->>{recipient}: {main_message}\n"
+                seq_text += f"    note over {recipient}: {context}\n"
+            else:
+                seq_text += f"    {sender}->>{recipient}: {message}\n"
+
+    # Add participants to the Mermaid diagram
+    participants_text = ""
+    for participant in participants:
+        participant_title = participant.replace("_", " ").title()
+        participants_text += (
+            f"    participant {participant} as {participant_title}" + "\n"
+        )
+    # Prepend the participants to the sequence diagram text
+    mermaid_text = SEQ_TXT + participants_text + seq_text[len(SEQ_TXT) :]
+    return mermaid_text
+
+
+def save_diagram(mermaid_text: str, output_path: Union[str, Path]) -> None:
+    """Save the Mermaid diagram to a .mmd file.
+
+    Parameters
+    ----------
+    mermaid_text : str
+        The Mermaid sequence diagram text.
+    output_path : Union[str, Path]
+        The path to save the Mermaid diagram.
+    """
+    with open(output_path, "w", encoding="utf-8", newline="\n") as file:
+        file.write(mermaid_text)
+
+
+def generate_sequence_diagram(
+    file_path: Union[str, Path], output_path: Union[str, Path]
+) -> None:
+    """Main function to generate the Mermaid diagram.
+
+    Parameters
+    ----------
+    file_path : Union[str, Path]
+        The path to the JSON or CSV file containing the events data.
+    output_path : Union[str, Path]
+        The path to save the Mermaid diagram.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the input file is not found.
+    ValueError
+        If the input file is not a JSON or CSV file.
+    """
+    if isinstance(file_path, str):
+        file_path = Path(file_path)
+    if not file_path.exists():
+        raise FileNotFoundError(f"File not found: {file_path}")
+    if file_path.suffix not in [".json", ".csv"]:
+        raise ValueError("Input file must be a JSON or CSV file.")
+    is_csv = file_path.suffix == ".csv"
+    if is_csv:
+        df_events = pd.read_csv(file_path)
+    else:
+        df_events = pd.read_json(file_path)
+
+    # Generate the Mermaid sequence diagram text
+    mermaid_text = process_events(df_events)
+
+    # Save the Mermaid diagram to a file
+    save_diagram(mermaid_text, output_path)

waldiez/running/running.py

@@ -0,0 +1,300 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+"""Utilities for running code."""
+
+import asyncio
+import datetime
+import io
+import os
+import shutil
+import subprocess
+import sys
+import tempfile
+from contextlib import asynccontextmanager, contextmanager
+from pathlib import Path
+from typing import (
+    AsyncIterator,
+    Callable,
+    Iterator,
+    Optional,
+    Set,
+    Tuple,
+    Union,
+)
+
+from .environment import in_virtualenv
+from .gen_seq_diagram import generate_sequence_diagram
+
+# pylint: disable=import-outside-toplevel
+
+
+@contextmanager
+def chdir(to: Union[str, Path]) -> Iterator[None]:
+    """Change the current working directory in a context.
+
+    Parameters
+    ----------
+    to : Union[str, Path]
+        The directory to change to.
+
+    Yields
+    ------
+    Iterator[None]
+        The context manager.
+    """
+    old_cwd = str(os.getcwd())
+    os.chdir(to)
+    try:
+        yield
+    finally:
+        os.chdir(old_cwd)
+
+
+@asynccontextmanager
+async def a_chdir(to: Union[str, Path]) -> AsyncIterator[None]:
+    """Asynchronously change the current working directory in a context.
+
+    Parameters
+    ----------
+    to : Union[str, Path]
+        The directory to change to.
+
+    Yields
+    ------
+    AsyncIterator[None]
+        The async context manager.
+    """
+    old_cwd = str(os.getcwd())
+    os.chdir(to)
+    try:
+        yield
+    finally:
+        os.chdir(old_cwd)
+
+
+def before_run(
+    output_path: Optional[Union[str, Path]],
+    uploads_root: Optional[Union[str, Path]],
+) -> str:
+    """Actions to perform before running the flow.
+
+    Parameters
+    ----------
+    output_path : Optional[Union[str, Path]]
+        The output path.
+    uploads_root : Optional[Union[str, Path]]
+        The runtime uploads root.
+
+    Returns
+    -------
+    str
+        The file name.
+    """
+    printer = get_printer()
+    printer(
+        "Requirements installed.\n"
+        "NOTE: If new packages were added and you are using Jupyter, "
+        "you might need to restart the kernel."
+    )
+    if not uploads_root:
+        uploads_root = Path(tempfile.mkdtemp())
+    else:
+        uploads_root = Path(uploads_root)
+    if not uploads_root.exists():
+        uploads_root.mkdir(parents=True)
+    file_name = "waldiez_flow.py" if not output_path else Path(output_path).name
+    if file_name.endswith((".json", ".waldiez")):
+        file_name = file_name.replace(".json", ".py").replace(".waldiez", ".py")
+    if not file_name.endswith(".py"):
+        file_name += ".py"
+    return file_name
+
+
+def install_requirements(
+    extra_requirements: Set[str], printer: Callable[..., None]
+) -> None:
+    """Install the requirements.
+
+    Parameters
+    ----------
+    extra_requirements : Set[str]
+        The extra requirements.
+    printer : Callable[..., None]
+        The printer function.
+    """
+    requirements_string = ", ".join(extra_requirements)
+    printer(f"Installing requirements: {requirements_string}")
+    pip_install = [sys.executable, "-m", "pip", "install"]
+    if not in_virtualenv():
+        pip_install.append("--user")
+    pip_install.extend(extra_requirements)
+    with subprocess.Popen(
+        pip_install,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    ) as proc:
+        if proc.stdout:
+            for line in io.TextIOWrapper(proc.stdout, encoding="utf-8"):
+                printer(line.strip())
+        if proc.stderr:
+            for line in io.TextIOWrapper(proc.stderr, encoding="utf-8"):
+                printer(line.strip())
+
+
+async def a_install_requirements(
+    extra_requirements: Set[str], printer: Callable[..., None]
+) -> None:
+    """Install the requirements asynchronously.
+
+    Parameters
+    ----------
+    extra_requirements : Set[str]
+        The extra requirements.
+    printer : Callable[..., None]
+        The printer function.
+    """
+    requirements_string = ", ".join(extra_requirements)
+    printer(f"Installing requirements: {requirements_string}")
+    pip_install = [sys.executable, "-m", "pip", "install"]
+    if not in_virtualenv():
+        pip_install.append("--user")
+    pip_install.extend(extra_requirements)
+    proc = await asyncio.create_subprocess_exec(
+        *pip_install,
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE,
+    )
+    if proc.stdout:
+        async for line in proc.stdout:
+            printer(line.decode().strip())
+    if proc.stderr:
+        async for line in proc.stderr:
+            printer(line.decode().strip())
+
+
+def after_run(
+    temp_dir: Path,
+    output_path: Optional[Union[str, Path]],
+    printer: Callable[..., None],
+    flow_name: str,
+    skip_mmd: bool = False,
+) -> None:
+    """Actions to perform after running the flow.
+
+    Parameters
+    ----------
+    temp_dir : Path
+        The temporary directory.
+    output_path : Optional[Union[str, Path]]
+        The output path.
+    printer : Callable[..., None]
+        The printer function.
+    flow_name : str
+        The flow name.
+    skip_mmd : bool, optional
+        Whether to skip the mermaid sequence diagram generation,
+        by default False
+    """
+    if isinstance(output_path, str):
+        output_path = Path(output_path)
+    output_dir = output_path.parent if output_path else Path.cwd()
+    if output_dir.is_file():
+        output_dir = output_dir.parent
+    if skip_mmd is False:
+        events_csv_path = temp_dir / "logs" / "events.csv"
+        if events_csv_path.exists():
+            printer("Generating mermaid sequence diagram...")
+            mmd_path = temp_dir / f"{flow_name}.mmd"
+            generate_sequence_diagram(events_csv_path, mmd_path)
+            shutil.copyfile(mmd_path, output_dir / f"{flow_name}.mmd")
+    if output_path:
+        destination_dir = output_path.parent
+        destination_dir = (
+            destination_dir
+            / "waldiez_out"
+            / datetime.datetime.now().strftime("%Y%m%d%H%M%S")
+        )
+        destination_dir.mkdir(parents=True, exist_ok=True)
+        # copy the contents of the temp dir to the destination dir
+        printer(f"Copying the results to {destination_dir}")
+        for item in temp_dir.iterdir():
+            # skip cache files
+            if (
+                item.name.startswith("__pycache__")
+                or item.name.endswith(".pyc")
+                or item.name.endswith(".pyo")
+                or item.name.endswith(".pyd")
+                or item.name == ".cache"
+            ):
+                continue
+            if item.is_file():
+                shutil.copy(item, destination_dir)
+            else:
+                shutil.copytree(item, destination_dir / item.name)
+    shutil.rmtree(temp_dir)
+
+
+def get_printer() -> Callable[..., None]:
+    """Get the printer function.
+
+    Returns
+    -------
+    Callable[..., None]
+        The printer function.
+    """
+    from autogen.io import IOStream  # type: ignore
+
+    printer = IOStream.get_default().print
+
+    def safe_printer(*args: object, **kwargs: object) -> None:
+        try:
+            printer(*args, **kwargs)
+        except UnicodeEncodeError:
+            # pylint: disable=too-many-try-statements
+            try:
+                msg, flush = get_what_to_print(*args, **kwargs)
+                printer(msg, end="", flush=flush)
+            except UnicodeEncodeError:
+                sys.stdout = io.TextIOWrapper(
+                    sys.stdout.buffer, encoding="utf-8"
+                )
+                sys.stderr = io.TextIOWrapper(
+                    sys.stderr.buffer, encoding="utf-8"
+                )
+                try:
+                    printer(*args, **kwargs)
+                except UnicodeEncodeError:
+                    sys.stderr.write(
+                        "Could not print the message due to encoding issues.\n"
+                    )
+
+    return safe_printer
+
+
+def get_what_to_print(*args: object, **kwargs: object) -> Tuple[str, bool]:
+    """Get what to print.
+
+    Parameters
+    ----------
+    args : object
+        The arguments.
+    kwargs : object
+        The keyword arguments.
+
+    Returns
+    -------
+    Tuple[str, bool]
+        The message and whether to flush.
+    """
+    sep = kwargs.get("sep", " ")
+    if not isinstance(sep, str):
+        sep = " "
+    end = kwargs.get("end", "\n")
+    if not isinstance(end, str):
+        end = "\n"
+    flush = kwargs.get("flush", False)
+    if not isinstance(flush, bool):
+        flush = False
+    msg = sep.join(str(arg) for arg in args) + end
+    utf8_msg = msg.encode("utf-8", errors="replace").decode("utf-8")
+    return utf8_msg, flush

{waldiez-0.2.1.dist-info → waldiez-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: waldiez
-Version: 0.2.1
+Version: 0.3.0
 Summary: waldiez
 Project-URL: homepage, https://waldiez.github.io/waldiez/python
 Project-URL: repository, https://github.com/waldiez/python.git
@@ -9,7 +9,7 @@ License-File: LICENSE
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -17,43 +17,47 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: <3.13,>=3.10
+Requires-Dist: asyncer==0.0.8
 Requires-Dist: jupytext
-Requires-Dist: pyautogen==0.6.0
+Requires-Dist: pandas>=2
+Requires-Dist: parso==0.8.4
+Requires-Dist: pyautogen==0.7.1
 Requires-Dist: pydantic>=2.0
 Requires-Dist: typer<0.13,>=0.9
 Provides-Extra: ag2-extras
-Requires-Dist: autogen[captainagent]==0.6.0; (platform_system == 'Linux') and extra == 'ag2-extras'
+Requires-Dist: autogen[captainagent]==0.7.1; (platform_system == 'Linux') and extra == 'ag2-extras'
 Requires-Dist: pgvector>=0.3.6; extra == 'ag2-extras'
 Requires-Dist: psycopg[binary]>=3.2.3; extra == 'ag2-extras'
-Requires-Dist: pyautogen[anthropic]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[bedrock]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[gemini]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[groq]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[lmm]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[mistral]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[neo4j]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[retrievechat-mongodb]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[retrievechat-pgvector]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[retrievechat-qdrant]==0.6.0; (python_version < '3.13') and extra == 'ag2-extras'
-Requires-Dist: pyautogen[retrievechat]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[together]==0.6.0; extra == 'ag2-extras'
-Requires-Dist: pyautogen[websurfer]==0.6.0; extra == 'ag2-extras'
+Requires-Dist: pyautogen[anthropic]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[bedrock]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[gemini]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[groq]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[lmm]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[mistral]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[neo4j]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[retrievechat-mongodb]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[retrievechat-pgvector]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[retrievechat-qdrant]==0.7.1; (python_version < '3.13') and extra == 'ag2-extras'
+Requires-Dist: pyautogen[retrievechat]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[together]==0.7.1; extra == 'ag2-extras'
+Requires-Dist: pyautogen[websurfer]==0.7.1; extra == 'ag2-extras'
 Requires-Dist: pymongo==4.10.1; extra == 'ag2-extras'
 Requires-Dist: qdrant-client[fastembed]; (python_version >= '3.13') and extra == 'ag2-extras'
 Provides-Extra: dev
 Requires-Dist: autoflake==2.3.1; extra == 'dev'
-Requires-Dist: bandit==1.8.0; extra == 'dev'
+Requires-Dist: bandit==1.8.2; extra == 'dev'
 Requires-Dist: black[jupyter]==24.10.0; extra == 'dev'
 Requires-Dist: flake8==7.1.1; extra == 'dev'
 Requires-Dist: isort==5.13.2; extra == 'dev'
-Requires-Dist: mypy==1.14.0; extra == 'dev'
+Requires-Dist: mypy==1.14.1; extra == 'dev'
+Requires-Dist: pandas-stubs; extra == 'dev'
 Requires-Dist: pre-commit==4.0.1; extra == 'dev'
 Requires-Dist: pydocstyle==6.3.0; extra == 'dev'
 Requires-Dist: pylint==3.3.3; extra == 'dev'
 Requires-Dist: python-dotenv==1.0.1; extra == 'dev'
-Requires-Dist: ruff==0.8.4; extra == 'dev'
+Requires-Dist: ruff==0.9.2; extra == 'dev'
 Requires-Dist: toml; (python_version <= '3.10') and extra == 'dev'
-Requires-Dist: types-pyyaml==6.0.12.20240917; extra == 'dev'
+Requires-Dist: types-pyyaml==6.0.12.20241230; extra == 'dev'
 Requires-Dist: types-toml==0.10.8.20240310; extra == 'dev'
 Requires-Dist: yamllint==1.35.1; extra == 'dev'
 Provides-Extra: docs
@@ -61,17 +65,18 @@ Requires-Dist: mdx-include==1.4.2; extra == 'docs'
 Requires-Dist: mdx-truly-sane-lists==1.3; extra == 'docs'
 Requires-Dist: mkdocs-jupyter==0.25.1; extra == 'docs'
 Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == 'docs'
-Requires-Dist: mkdocs-material==9.5.49; extra == 'docs'
+Requires-Dist: mkdocs-material==9.5.50; extra == 'docs'
 Requires-Dist: mkdocs-minify-html-plugin==0.2.3; extra == 'docs'
 Requires-Dist: mkdocs==1.6.1; extra == 'docs'
-Requires-Dist: mkdocstrings-python==1.12.2; extra == 'docs'
+Requires-Dist: mkdocstrings-python==1.13.0; extra == 'docs'
 Requires-Dist: mkdocstrings[crystal,python]==0.27.0; extra == 'docs'
 Provides-Extra: jupyter
 Requires-Dist: jupyterlab>=4.3.0; extra == 'jupyter'
-Requires-Dist: waldiez-jupyter==0.2.1; extra == 'jupyter'
+Requires-Dist: waldiez-jupyter==0.3.0; extra == 'jupyter'
 Provides-Extra: studio
-Requires-Dist: waldiez-studio==0.2.1; extra == 'studio'
+Requires-Dist: waldiez-studio==0.3.0; extra == 'studio'
 Provides-Extra: test
+Requires-Dist: pytest-asyncio==0.25.2; extra == 'test'
 Requires-Dist: pytest-cov==6.0.0; extra == 'test'
 Requires-Dist: pytest-html==4.1.1; extra == 'test'
 Requires-Dist: pytest-sugar==1.0.0; extra == 'test'
@@ -120,17 +125,17 @@ The repo for the js library is [here](https://github.com/waldiez/react).
 - You also can use the vscode extension:
   - [repo](https://github.com/waldiez/vscode)
   - [marketplace](https://marketplace.visualstudio.com/items?itemName=Waldiez.waldiez-vscode)
-- Finally, you can use [waldiez-studio](https://github.com/waldiez/studio)
+- Finally, you can use [waldiez-studio](https://github.com/waldiez/studio), which includes a FastAPI app to handle the conversion and running of waldiez flows.
 
-<!--
-The jupyterlab extension and studio also provided as extras in the main package.
+The jupyterlab extension and waldiez studio are also provided as extras in the main package.
 
 ```shell
 pip install waldiez[studio]  # or pip install waldiez_studio
 pip install waldiez[jupyter]  # or pip install waldiez_jupyter
 # or both
 pip install waldiez[studio,jupyter]
-``` -->
+```
+
 ### CLI
 
 ```bash
@@ -202,6 +207,7 @@ runner.run(output_path=output_path)
 - [juptytext](https://github.com/mwouts/jupytext)
 - [pydantic](https://github.com/pydantic/pydantic)
 - [typer](https://github.com/fastapi/typer)
+- [asyncer](https://github.com/fastapi/asyncer)
 
 ## Known Conflicts
 
@@ -219,4 +225,4 @@ runner.run(output_path=output_path)
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/waldiez/python/blob/main/LICENSE) file for details.
+This project is licensed under the [Apache License, Version 2.0 (Apache-2.0)](https://github.com/waldiez/python/blob/main/LICENSE).