waldiez 0.4.7__py3-none-any.whl → 0.4.9__py3-none-any.whl

waldiez/exporting/core/extras/chat_extras.py

@@ -0,0 +1,118 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+# pylint: disable=too-few-public-methods
+"""Chat specific extras module."""
+
+from dataclasses import dataclass
+
+from ..enums import AgentPosition, ContentOrder, ExportPosition
+from ..result import ExportResult
+from .base import BaseExtras
+
+
+@dataclass
+class ChatExtras(BaseExtras):
+    """Extras for chat exporters.
+
+    Attributes
+    ----------
+    chat_definition : str
+        The chat definition content.
+    chat_initiation : str
+        The chat initiation content.
+    """
+
+    chat_prerequisites: str = ""
+    chat_initiation: str = ""
+    chat_registration: str = ""
+
+    def set_chat_prerequisites(self, prerequisites: str) -> None:
+        """Set the chat prerequisites.
+
+        Parameters
+        ----------
+        prerequisites : str
+            The chat prerequisites content.
+        """
+        self.chat_prerequisites = prerequisites
+
+    def set_chat_initiation(self, initiation: str) -> None:
+        """Set the chat initiation.
+
+        Parameters
+        ----------
+        initiation : str
+            The chat initiation content.
+        """
+        self.chat_initiation = initiation
+
+    def set_chat_registration(self, registration: str) -> None:
+        """Set the chat registration.
+
+        Parameters
+        ----------
+        registration : str
+            The chat registration content.
+        """
+        self.chat_registration = registration
+
+    def add_registration(self, registration: str) -> None:
+        """Add chat registration content.
+
+        Parameters
+        ----------
+        registration : str
+            The chat registration content.
+        """
+        if registration and registration.strip():
+            self.chat_registration += "\n" + registration.strip() + "\n"
+
+    def has_specific_content(self) -> bool:
+        """Check for chat specific content.
+
+        Returns
+        -------
+        bool
+            True if there's chat specific content.
+        """
+        return bool(
+            self.chat_initiation.strip()
+            or self.chat_prerequisites.strip()
+            or self.chat_registration.strip()
+        )
+
+    def _contribute_specific_content(self, result: ExportResult) -> None:
+        """Contribute chat specific content.
+
+        Parameters
+        ----------
+        result : ExportResult
+            The export result to contribute to.
+        """
+        # Chat prerequisites go before the chat definition
+        if self.chat_prerequisites:
+            result.add_content(
+                self.chat_prerequisites,
+                ExportPosition.AGENTS,
+                order=ContentOrder.LATE_CLEANUP,
+                skip_strip=True,
+            )
+
+        # Chat initiation goes inside "def main()"
+        if self.chat_initiation:  # pragma: no branch
+            result.add_content(
+                self.chat_initiation,
+                ExportPosition.CHATS,
+                order=ContentOrder.MAIN_CONTENT,
+                skip_strip=True,
+            )
+
+        # Chat registration goes after all agents are defined
+        # (agent.register_nested_chat..))
+        if self.chat_registration:  # pragma: no branch
+            result.add_content(
+                self.chat_registration,
+                ExportPosition.AGENTS,
+                agent_position=AgentPosition.AFTER_ALL,
+                order=ContentOrder.POST_CONTENT,
+            )

waldiez/exporting/core/extras/flow_extras.py

@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+# pylint: disable=too-few-public-methods,too-many-instance-attributes
+# flake8: noqa: E501
+"""Flow specific extras module."""
+
+from dataclasses import dataclass, field
+from typing import Optional
+
+# pylint: disable=import-error,line-too-long
+# pyright: reportMissingImports=false
+try:
+    from waldiez._version import __version__ as waldiez_version  # type: ignore[unused-ignore, import-not-found, import-untyped]  # noqa
+except ImportError:  # pragma: no cover
+    import warnings
+
+    # .gitingored (generated by hatch)
+    warnings.warn(
+        "Importing __version__ failed. Using 'dev' as version.",
+        stacklevel=2,
+    )
+    waldiez_version = "dev"
+
+from ..result import ExportResult
+from ..types import ExportConfig
+from .base import BaseExtras
+
+
+@dataclass
+class FlowExtras(BaseExtras):
+    """Extras for flow exporter."""
+
+    # Flow metadata
+    flow_name: str = ""
+    description: str = ""
+    config: ExportConfig = field(default_factory=ExportConfig)
+    version: str = waldiez_version  # pyright: ignore
+
+    # Sub-exporter results
+    tools_result: Optional[ExportResult] = None
+    models_result: Optional[ExportResult] = None
+    agents_result: Optional[ExportResult] = None
+    chats_result: Optional[ExportResult] = None
+
+    # Generated script parts
+    header_content: str = ""
+    main_function: str = ""
+    after_run: str = ""
+    execution_code: str = ""
+
+    def has_specific_content(self) -> bool:
+        """Check if the flow extras contain specific content.
+
+        Returns
+        -------
+        bool
+            True if any specific content is present, False otherwise.
+        """
+        return bool(
+            self.flow_name
+            or self.description
+            or self.version
+            or self.tools_result
+            or self.models_result
+            or self.agents_result
+            or self.chats_result
+            or self.header_content
+            or self.main_function
+            or self.execution_code
+        )

waldiez/exporting/core/extras/model_extras.py

@@ -0,0 +1,73 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+# pylint: disable=too-few-public-methods
+"""Agent specific extras module."""
+
+from dataclasses import dataclass
+from typing import Any, Optional
+
+from waldiez.exporting.core.result import ExportResult
+
+from ..enums import ContentOrder, ExportPosition
+from .base import BaseExtras
+
+
+@dataclass
+class ModelExtras(BaseExtras):
+    """Extras for model exporters."""
+
+    llm_config: Optional[dict[str, Any]] = None
+    config_file_path: str = ""
+
+    def set_llm_config(self, config: dict[str, Any]) -> None:
+        """Set the LLM configuration.
+
+        Parameters
+        ----------
+        config : dict[str, Any]
+            The LLM configuration.
+        """
+        self.llm_config = config
+
+    def set_config_file_path(self, path: str) -> None:
+        """Set the configuration file path.
+
+        Parameters
+        ----------
+        path : str
+            The configuration file path.
+        """
+        self.config_file_path = path
+
+    def get_content(self) -> str:
+        """Get the content of the LLM configuration.
+
+        Returns
+        -------
+        str
+            The serialized LLM configuration.
+        """
+        if self.llm_config and "content" in self.llm_config:
+            return self.llm_config["content"]
+        return ""
+
+    def has_specific_content(self) -> bool:
+        """Check for model specific content.
+
+        Returns
+        -------
+        bool
+            True if there's model specific content.
+        """
+        if self.llm_config and "content" in self.llm_config:
+            return bool(self.llm_config["content"])
+        return False
+
+    def _contribute_specific_content(self, result: ExportResult) -> None:
+        """Contribute model-specific content to the export result."""
+        if self.llm_config and "content" in self.llm_config:
+            result.add_content(
+                self.llm_config["content"],
+                ExportPosition.MODELS,
+                order=ContentOrder.MAIN_CONTENT,
+            )

waldiez/exporting/core/extras/path_resolver.py

@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+"""Default path resolver for Waldiez items."""
+
+from pathlib import Path
+from typing import Optional, Union
+
+from ..protocols import PathResolver
+
+
+# pylint: disable=too-few-public-methods
+class DefaultPathResolver(PathResolver):
+    """Default path resolver for Waldiez items."""
+
+    def resolve(self, path: str) -> str:
+        """Resolve a path to a local file system path.
+
+        Parameters
+        ----------
+        path : Union[str, Path]
+            The path to resolve.
+
+        Returns
+        -------
+        Optional[Path]
+            The resolved local path or None if not found.
+        """
+        resolved = _check_local_path(path)
+        if not resolved:
+            return _get_raw_path_string(path)
+        return _get_raw_path_string(resolved)
+
+
+def _check_local_path(string: str) -> Optional[Path]:
+    """Check if a string is a local path.
+
+    Parameters
+    ----------
+    string : str
+        The string to check.
+
+    Returns
+    -------
+    bool
+        True if the path is a local path.
+    """
+    # pylint: disable=broad-exception-caught
+    try:
+        path = Path(string).resolve()
+    except BaseException:  # pragma: no cover
+        return None
+    if path.exists():
+        return path
+    return None
+
+
+def _get_raw_path_string(path: Union[str, Path]) -> str:
+    """Get the raw path string.
+
+    Parameters
+    ----------
+    path : Union[str, Path]
+        The string to check.
+
+    Returns
+    -------
+    str
+        The raw path string.
+    """
+    if not isinstance(path, str):
+        path = str(path)
+    while path.startswith('r"') and path.endswith('"'):
+        path = path[2:-1]
+    return f'r"{path}"'
+
+
+# def get_path_string(path: str) -> str:
+#     """Get the path string.
+
+#     Parameters
+#     ----------
+#     path : str
+#         The string to check.
+
+#     Returns
+#     -------
+#     str
+#         The local path string.
+#     """
+#     resolved = _check_local_path(path)
+#     if not resolved:
+#         return _get_raw_path_string(path)
+#     return _get_raw_path_string(resolved)

waldiez/exporting/core/extras/serializer.py

@@ -0,0 +1,138 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+# pyright: reportUnknownArgumentType=false,reportUnknownVariableType=false
+"""serializer for converting items to formatted strings."""
+
+import json
+from typing import Any, Optional
+
+from ..protocols import Serializer
+
+
+# pylint: disable=too-few-public-methods
+class DefaultSerializer(Serializer):
+    """Default serializer for Waldiez items."""
+
+    def serialize(self, obj: Any, **kwargs: Any) -> str:
+        """Serialize an item to a formatted string.
+
+        Parameters
+        ----------
+        obj : Any
+            The item to serialize.
+        **kwargs : Any
+            Additional keyword arguments, such as `tabs` for indentation level.
+
+        Returns
+        -------
+        str
+            The serialized string representation of the item.
+        """
+        tabs = kwargs.get("tabs", 1)
+        return serialize_item(obj, tabs)
+
+
+def serialize_item(
+    item: Any,
+    tabs: int = 1,
+    _visited: Optional[set[int]] = None,
+) -> str:
+    """Convert an item to a formatted string with given indentation.
+
+    Parameters
+    ----------
+    item : Any
+        The item to convert.
+    tabs : int, optional
+        The number of tabs, by default 1.
+
+    Returns
+    -------
+    str
+        The formatted string.
+
+    Example
+    -------
+    ```python
+    >>> obj = {"a": 1, "b": [1, 2, 3]}
+    >>> serialize_item(obj)
+    {
+        "a": 1,
+        "b": [
+            1,
+            2,
+            3
+        ]
+    }
+    >>> obj = {"a": 1, "b": [1, 2, 3], "c": {"d": 4}}
+    >>> serialize_item(obj, 2)
+    {
+            "a": 1,
+            "b": [
+                1,
+                2,
+                3
+            ],
+            "c": {
+                "d": 4
+            }
+    }
+    ```
+    """
+    if _visited is None:
+        _visited = set()
+
+    if callable(item):
+        return item.__name__
+
+    # Handle primitives and preformatted literals
+    if isinstance(item, (str, int, float, bool)) or item is None:
+        return _format_primitive(item)
+
+    # Handle circular references in containers
+    if isinstance(item, (dict, list)) and id(item) in _visited:
+        return '"<circular reference>"'
+
+    next_indent = " " * 4 * (tabs + 1)
+    _visited.add(id(item))
+
+    if isinstance(item, dict):
+        items: list[str] = []
+        for key, value in item.items():
+            key_str = f'{next_indent}"{key}"'
+            value_str = serialize_item(value, tabs + 1, _visited)
+            items.append(f"{key_str}: {value_str}")
+        return _format_container(items, "{", "}", tabs)
+
+    if isinstance(item, list):
+        items = [
+            f"{next_indent}{serialize_item(sub_item, tabs + 1, _visited)}"
+            for sub_item in item
+        ]
+        return _format_container(items, "[", "]", tabs)
+
+    # Fallback for unknown object types
+    return repr(item)
+
+
+def _format_primitive(item: Any) -> str:
+    """Format a primitive or formatted literal for code-safe output."""
+    if isinstance(item, str):
+        if item.startswith("r'") or item.startswith('r"'):
+            return item
+        return json.dumps(item, ensure_ascii=False)
+    return str(item)
+
+
+def _format_container(
+    items_list: list[str],
+    open_char: str,
+    close_char: str,
+    tabs: int,
+) -> str:
+    """Format containers consistently with indentation."""
+    indent = " " * 4 * tabs
+    if not items_list:
+        return f"{open_char}{close_char}"
+    items_string = ",\n".join(items_list)
+    return f"{open_char}\n{items_string}\n{indent}{close_char}"

waldiez/exporting/core/extras/tool_extras.py

@@ -0,0 +1,82 @@
+# SPDX-License-Identifier: Apache-2.0.
+# Copyright (c) 2024 - 2025 Waldiez and contributors.
+"""Agent specific extras module."""
+# pylint: disable=too-few-public-methods
+
+from dataclasses import dataclass
+
+from ..enums import ContentOrder, ExportPosition
+from ..result import ExportResult
+from .base import BaseExtras
+
+
+@dataclass
+class ToolExtras(BaseExtras):
+    """Extras for tool exporters."""
+
+    function_content: str = ""
+    registration_content: str = ""
+
+    def add_function_content(self, content: str) -> None:
+        """Add function definition content.
+
+        Parameters
+        ----------
+        content : str
+            The function content to add.
+        """
+        if content and content.strip():  # pragma: no branch
+            if self.function_content:
+                self.function_content += "\n\n" + content.rstrip()
+            else:
+                self.function_content = content.rstrip()
+            while not self.function_content.endswith("\n\n"):
+                self.function_content += "\n\n"
+
+    def add_registration_content(self, content: str) -> None:
+        """Add function registration content.
+
+        Parameters
+        ----------
+        content : str
+            The registration content to add.
+        """
+        if content and content.strip():  # pragma: no branch
+            self.registration_content += "\n" + content.rstrip() + "\n"
+
+    def has_specific_content(self) -> bool:
+        """Check for tool specific content.
+
+        Returns
+        -------
+        bool
+            True if there's tool specific content.
+        """
+        return bool(
+            self.function_content.strip() or self.registration_content.strip()
+        )
+
+    def _contribute_specific_content(self, result: ExportResult) -> None:
+        """Contribute tool specific content.
+
+        Parameters
+        ----------
+        result : ExportResult
+            The export result to contribute to.
+        """
+        # Function definitions go in TOOLS section
+        if self.function_content:
+            result.add_content(
+                self.function_content,
+                ExportPosition.TOOLS,
+                order=ContentOrder.PRE_CONTENT,
+            )
+
+        # Registration content goes after agents
+        if self.registration_content:
+            result.add_content(
+                self.registration_content,
+                ExportPosition.AGENTS,
+                # After agents but before handoffs
+                order=ContentOrder.CLEANUP,
+            )