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

waldiez/ws/cli.py

@@ -1,20 +1,46 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
-# pylint: disable=too-many-locals
+
+# pylint: disable=too-many-locals,unused-import,invalid-name
+# pyright: reportUnusedImport=false,reportConstantRedefinition=false
+# pyright: reportUnusedParameter=false, reportCallInDefaultInitializer=false
+
 """CLI interface for Waldiez WebSocket server."""
 
 import asyncio
 import logging
+import os
 import re
 import sys
+import traceback
 from pathlib import Path
-from typing import Annotated, Any, Optional, Set
+from typing import Annotated, Any
 
 import typer
 
-from .server import run_server
+HAS_WATCHDOG = False
+try:
+    from .reloader import FileWatcher  # noqa: F401
+
+    HAS_WATCHDOG = True
+except ImportError:
+    pass
+
+HAS_WEBSOCKETS = False
+try:
+    from .server import run_server
+
+    HAS_WEBSOCKETS = True
+except ImportError:
+    # pylint: disable=missing-param-doc,missing-raises-doc
+    # noinspection PyUnusedLocal
+    async def run_server(*args: Any, **kwargs: Any) -> None:  # type: ignore
+        """No WebSocket server available."""
+        raise NotImplementedError("WebSocket server is not available.")
+
 
 DEFAULT_WORKSPACE_DIR = Path.cwd()
+DEFAULT_WS_PORT = 8765
 
 
 def setup_logging(verbose: bool = False) -> None:
@@ -50,12 +76,27 @@ app = typer.Typer(
 )
 
 
+def _get_ws_port() -> int:
+    """Get the default ws server port to use."""
+    vite_ws_config = os.environ.get("VITE_DEV_WS_URL", "")
+    if not vite_ws_config:
+        return DEFAULT_WS_PORT
+    # VITE_DEV_WS_URL=ws://localhost:8765
+    server_parts = vite_ws_config.rsplit(":", maxsplit=1)
+    if not server_parts:
+        return DEFAULT_WS_PORT
+    try:
+        return int(server_parts[-1])
+    except Exception:  # pylint: disable=broad-exception-caught
+        return DEFAULT_WS_PORT
+
+
 @app.command()
 def serve(
     host: Annotated[
         str, typer.Option(help="Server host address")
     ] = "localhost",
-    port: Annotated[int, typer.Option(help="Server port")] = 8765,
+    port: Annotated[int, typer.Option(help="Server port")] = _get_ws_port(),
     max_clients: Annotated[
         int,
         typer.Option(
@@ -63,7 +104,7 @@ def serve(
         ),
     ] = 1,
     allowed_origins: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         typer.Option(
             "--allowed-origin",
             help=(
@@ -84,7 +125,7 @@ def serve(
         ),
     ] = False,
     watch_dir: Annotated[
-        Optional[list[Path]],
+        list[Path] | None,
         typer.Option(
             "--watch-dir",
             help=(
@@ -154,7 +195,7 @@ def serve(
     logger = logging.getLogger(__name__)
 
     # Convert watch directories to set
-    watch_dirs: Optional[Set[Path]] = None
+    watch_dirs: set[Path] | None = None
     if watch_dir:
         watch_dirs = set(watch_dir)
 
@@ -176,7 +217,13 @@ def serve(
         "ping_timeout": ping_timeout,
         "max_size": max_size,
     }
-
+    if not HAS_WATCHDOG and auto_reload:
+        msg = (
+            "Auto-reload requires the 'watchdog' package. "
+            "Please install it with: pip install watchdog"
+        )
+        typer.echo(msg)
+        auto_reload = False
     logger.info("Starting Waldiez WebSocket server...")
     logger.info("Configuration:")
     logger.info("  Host: %s", host)
@@ -202,8 +249,9 @@ def serve(
         )
     except KeyboardInterrupt:
         logger.info("Server stopped by user")
-    except Exception as e:  # pylint: disable=broad-exception-caught
-        logger.error("Server error: %s", e)
+    except Exception:  # pylint: disable=broad-exception-caught
+        tb = traceback.format_exc()
+        logger.error("Server error: %s", tb)
         sys.exit(1)
 
 

waldiez/ws/client_manager.py

@@ -1,10 +1,11 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
-# pylint: disable=too-many-try-statements,broad-exception-caught
-# pylint: disable=too-complex,too-many-return-statements
+# pylint: disable=too-many-try-statements,broad-exception-caught,line-too-long
+# pylint: disable=too-complex,too-many-return-statements,import-error
 # pyright: reportUnknownMemberType=false,reportAttributeAccessIssue=false
 # pyright: reportUnknownVariableType=false,reportUnknownArgumentType=false
-# pyright: reportAssignmentType=false
+# pyright: reportAssignmentType=false,reportUnknownParameterType=false
+# pyright: reportArgumentType=false
 # flake8: noqa: C901
 """WebSocket client manager: bridges WS <-> subprocess runner."""
 
@@ -15,7 +16,11 @@ import time
 from pathlib import Path
 from typing import Any, Callable, Literal
 
-import websockets
+try:
+    import websockets  # type: ignore[unused-ignore, unused-import, import-not-found, import-untyped] # noqa
+except ImportError:  # pragma: no cover
+    from ._mock import websockets  # type: ignore[no-redef,unused-ignore]
+
 
 from waldiez.models import Waldiez
 from waldiez.running.subprocess_runner.runner import WaldiezSubprocessRunner
@@ -141,7 +146,10 @@ class ClientManager:
                 data = json.loads(json.dumps(payload, default=str))
             await self.websocket.send(json.dumps(data))
             return True
-        except (websockets.ConnectionClosed, ConnectionResetError) as e:
+        except (
+            websockets.ConnectionClosed,
+            ConnectionResetError,
+        ) as e:
             self.logger.info("Client %s disconnected: %s", self.client_id, e)
             await self.cleanup()
             return False
@@ -273,8 +281,8 @@ class ClientManager:
             server_status = await self.session_manager.get_status()
             wf_status = None
             if msg.session_id:
-                sess = await self.session_manager.get_session(msg.session_id)
-                wf_status = sess.status if sess else None
+                session = await self.session_manager.get_session(msg.session_id)
+                wf_status = session.status if session else None
             return StatusResponse.ok(
                 server_status=server_status,
                 workflow_status=wf_status,
@@ -282,7 +290,7 @@ class ClientManager:
             ).model_dump(mode="json")
 
         if isinstance(msg, SaveFlowRequest):
-            return FileRequestHandler.handle_save_flow_request(
+            return FileRequestHandler.handle_save_request(
                 msg=msg,
                 workspace_dir=self.workspace_dir,
                 client_id=self.client_id,
@@ -290,7 +298,7 @@ class ClientManager:
             )
 
         if isinstance(msg, ConvertWorkflowRequest):
-            return FileRequestHandler.handle_convert_workflow_request(
+            return FileRequestHandler.handle_convert_request(
                 msg=msg,
                 client_id=self.client_id,
                 workspace_dir=self.workspace_dir,
@@ -299,11 +307,11 @@ class ClientManager:
 
         # Start workflow (STANDARD)
         if isinstance(msg, RunWorkflowRequest):
-            return await self._handle_run_workflow(msg)
+            return await self._handle_run(msg)
 
         # Start workflow (STEP-BY-STEP / DEBUG)
         if isinstance(msg, StepRunWorkflowRequest):
-            return await self._handle_step_run_workflow(msg)
+            return await self._handle_step_run(msg)
 
         # Step controls
         if isinstance(msg, StepControlRequest):
@@ -318,24 +326,21 @@ class ClientManager:
             return await self._handle_user_input(msg)
 
         # Stop workflow
-        if hasattr(msg, "type") and msg.type == "stop_workflow":
-            return await self._handle_stop_workflow(msg)
+        if hasattr(msg, "type") and msg.type == "stop":
+            return await self.handle_stop(msg)
 
         # Unknown
         return self._error_to_response(
             UnsupportedActionError(getattr(msg, "type", "unknown"))
         )
 
-    async def _handle_run_workflow(
-        self, msg: RunWorkflowRequest
-    ) -> dict[str, Any]:
+    async def _handle_run(self, msg: RunWorkflowRequest) -> dict[str, Any]:
         try:
-            data_dict = json.loads(msg.flow_data)
+            data_dict = json.loads(msg.data)
             waldiez = Waldiez.from_dict(data_dict)
         except Exception as e:
             return RunWorkflowResponse.fail(
                 error=f"Invalid flow_data: {e}",
-                execution_mode=msg.execution_mode,
                 session_id="",
             ).model_dump(mode="json")
         # structured path preferred
@@ -354,20 +359,19 @@ class ClientManager:
         asyncio.create_task(self._run_runner(session_id, runner))
 
         return RunWorkflowResponse.ok(
-            session_id=session_id, execution_mode=ExecutionMode.STANDARD
+            session_id=session_id, mode=ExecutionMode.STANDARD
         ).model_dump(mode="json")
 
-    async def _handle_step_run_workflow(
+    async def _handle_step_run(
         self, msg: StepRunWorkflowRequest
     ) -> dict[str, Any]:
         try:
-            data_dict = json.loads(msg.flow_data)
+            data_dict = json.loads(msg.data)
             waldiez = Waldiez.from_dict(data_dict)
         except Exception as e:
             return StepRunWorkflowResponse.fail(
                 error=f"Invalid flow_data: {e}",
                 session_id="",
-                auto_continue=msg.auto_continue,
                 breakpoints=msg.breakpoints,
             ).model_dump(mode="json")
         session_id = self._next_session_id()
@@ -376,6 +380,7 @@ class ClientManager:
             on_output=self._mk_on_output(session_id),
             on_input_request=self._mk_on_input_request(session_id),
             mode="debug",  # step-by-step via CLI
+            breakpoints=msg.breakpoints,
         )
 
         await self._create_session_for_runner(
@@ -383,13 +388,10 @@ class ClientManager:
             ExecutionMode.STEP_BY_STEP,
             session_id=session_id,
         )
-
-        # Persist desired flags (optional)
-        sess = await self.session_manager.get_session(session_id)
-        if sess:
-            sess.state.metadata.update(
+        session = await self.session_manager.get_session(session_id)
+        if session:
+            session.state.metadata.update(
                 {
-                    "auto_continue": msg.auto_continue,
                     "breakpoints": list(msg.breakpoints),
                 }
             )
@@ -398,7 +400,6 @@ class ClientManager:
 
         return StepRunWorkflowResponse.ok(
             session_id=session_id,
-            auto_continue=msg.auto_continue,
             breakpoints=list(msg.breakpoints),
         ).model_dump(mode="json")
 
@@ -411,7 +412,7 @@ class ClientManager:
         await self.session_manager.create_session(
             session_id=session_id,
             client_id=self.client_id,
-            execution_mode=mode,
+            mode=mode,
             runner=runner,
             temp_file=None,
             metadata={},
@@ -474,17 +475,20 @@ class ClientManager:
                 result="",
                 session_id=msg.session_id,
             ).model_dump(mode="json")
-
-        code = {
-            "": "c",
-            "continue": "c",
-            "step": "s",
-            "run": "r",
-            "quit": "q",
-            "info": "i",
-            "help": "h",
-            "stats": "st",
-        }.get(msg.action)
+        code: str | None
+        if msg.action in {"", "c", "s", "r", "q", "i", "h", "st"}:
+            code = msg.action if msg.action else "c"
+        else:
+            code = {
+                "": "c",
+                "continue": "c",
+                "step": "s",
+                "run": "r",
+                "quit": "q",
+                "info": "i",
+                "help": "h",
+                "stats": "st",
+            }.get(msg.action)
 
         if not code:
             return StepControlResponse.fail(
@@ -552,7 +556,19 @@ class ClientManager:
         runner.provide_user_input(msg.data)
         return {"type": "ok", "success": True}
 
-    async def _handle_stop_workflow(self, msg: Any) -> dict[str, Any]:
+    async def handle_stop(self, msg: Any) -> dict[str, Any]:
+        """Handle stop request.
+
+        Parameters
+        ----------
+        msg : Any
+            The stop request.
+
+        Returns
+        -------
+        dict[str, Any]
+            The processing result to respond with.
+        """
         session_id = getattr(msg, "session_id", "")
         runner = self._runners.get(session_id)
         if not runner:
@@ -566,7 +582,7 @@ class ClientManager:
                 session_id, WorkflowStatus.STOPPING
             )
             return {
-                "type": "stop_workflow_response",
+                "type": "stop_response",
                 "session_id": session_id,
                 "success": True,
                 "forced": getattr(msg, "force", False),
@@ -596,6 +612,7 @@ class ClientManager:
           - anything else
             -> fallback stdout SubprocessOutputNotification
         """
+        # self.logger.debug("Handling runner output: %s", data)
         try:
             msg_type = str(data.get("type", "")).lower()
             session_id_raw = data.get("session_id")
@@ -606,7 +623,9 @@ class ClientManager:
             )
 
             if msg_type in ("input_request", "debug_input_request"):
-                await self._handle_runner_input_request(session_id, data)
+                await self._handle_runner_input_request(
+                    session_id, data, is_debug=msg_type == "debug_input_request"
+                )
                 return
 
             if msg_type.startswith("debug_"):
@@ -646,7 +665,10 @@ class ClientManager:
             )
 
     async def _handle_runner_input_request(
-        self, session_id: str, data: dict[str, Any]
+        self,
+        session_id: str,
+        data: dict[str, Any],
+        is_debug: bool,
     ) -> None:
         """Handle an input request from the runner."""
         request_id = str(data.get("request_id", ""))
@@ -657,15 +679,17 @@ class ClientManager:
             await self.session_manager.update_session_status(
                 session_id, WorkflowStatus.INPUT_WAITING
             )
-            await self.send_message(
-                UserInputRequestNotification(
-                    session_id=session_id,
-                    request_id=request_id,
-                    prompt=prompt,
-                    password=bool(data.get("password", False)),
-                    timeout=float(data.get("timeout", 120.0)),
-                )
+            notification = UserInputRequestNotification(
+                session_id=session_id,
+                request_id=request_id,
+                prompt=prompt,
+                password=bool(data.get("password", False)),
+                timeout=float(data.get("timeout", 120.0)),
             )
+            msg_dump = notification.model_dump(mode="json", fallback=str)
+            if is_debug:
+                msg_dump["type"] = "debug_input_request"
+            await self.send_message(msg_dump)
 
     # pylint: disable=line-too-long
     async def _handle_runner_debug(

waldiez/ws/errors.py

@@ -1,6 +1,9 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
+
 # pylint: disable=unused-argument
+# pyright: reportUnusedParameter=false
+
 """Error handling and exceptions for Waldiez WebSocket server."""
 
 import logging

waldiez/ws/models.py

@@ -1,7 +1,8 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
-# pylint: disable=broad-exception-caught,no-member
-# pyright: reportUnknownVariableType=false
+# pylint: disable=broad-exception-caught,no-member,invalid-name
+# pyright: reportUnknownVariableType=false,reportAny=false
+# pyright: reportDeprecated=false, reportUnannotatedClassAttribute=false
 """Session management models for WebSocket workflow execution."""
 
 import json
@@ -119,42 +120,51 @@ class BaseNotification(BaseWaldiezMessage):
 class SaveFlowRequest(BaseRequest):
     """Request to save a workflow."""
 
-    type: Literal["save_flow"] = "save_flow"
-    flow_data: str  # JSON string of workflow
-    filename: str | None = None
-    force_overwrite: bool = False
+    type: Literal["save"] = "save"
+    data: str  # JSON string of workflow
+    path: str | None = None
+    force: bool = False
 
 
 class RunWorkflowRequest(BaseRequest):
     """Request to run a workflow in standard mode."""
 
-    type: Literal["run_workflow"] = "run_workflow"
-    flow_data: str  # JSON string of workflow
-    execution_mode: ExecutionMode = ExecutionMode.STANDARD
-    structured_io: bool = True
-    uploads_root: str | None = None
-    dot_env_path: str | None = None
-    output_path: str | None = None
+    type: Literal["run"] = "run"
+    data: str  # JSON string of workflow
+    path: str | None = None
 
 
 class StepRunWorkflowRequest(BaseRequest):
     """Request to run a workflow in step-by-step mode."""
 
-    type: Literal["step_run_workflow"] = "step_run_workflow"
-    flow_data: str  # JSON string of workflow
-    auto_continue: bool = False
+    type: Literal["step_run"] = "step_run"
+    data: str  # JSON string of workflow
     breakpoints: list[str] = Field(default_factory=list)
-    structured_io: bool = True
-    uploads_root: str | None = None
-    dot_env_path: str | None = None
-    output_path: str | None = None
+    path: str | None = None
 
 
 class StepControlRequest(BaseRequest):
     """Request to control step-by-step execution."""
 
     type: Literal["step_control"] = "step_control"
-    action: Literal["continue", "step", "run", "quit", "info", "help", "stats"]
+    action: Literal[
+        "continue",
+        "step",
+        "run",
+        "quit",
+        "info",
+        "help",
+        "stats",
+        "",
+        "c",
+        "s",
+        "r",
+        "q",
+        "i",
+        "h",
+        "?",
+        "st",
+    ]
     session_id: str
 
 
@@ -190,7 +200,7 @@ class UserInputResponse(BaseRequest):
 class StopWorkflowRequest(BaseRequest):
     """Request to stop workflow execution."""
 
-    type: Literal["stop_workflow"] = "stop_workflow"
+    type: Literal["stop"] = "stop"
     session_id: str
     force: bool = False
 
@@ -199,7 +209,7 @@ class StopWorkflowResponse(BaseResponse):
     """Response to stop workflow request."""
 
     session_id: str
-    type: Literal["stop_workflow_response"] = "stop_workflow_response"
+    type: Literal["stop_response"] = "stop_response"
     error: str | None = None
     forced: bool = False
 
@@ -207,10 +217,10 @@ class StopWorkflowResponse(BaseResponse):
 class ConvertWorkflowRequest(BaseRequest):
     """Request to convert workflow to different format."""
 
-    type: Literal["convert_workflow"] = "convert_workflow"
-    flow_data: str
-    target_format: Literal["py", "ipynb"]
-    output_path: str | None = None
+    type: Literal["convert"] = "convert"
+    data: str
+    format: Literal["py", "ipynb"]
+    path: str | None = None
 
 
 class UploadFileRequest(BaseRequest):
@@ -245,26 +255,24 @@ class GetStatusRequest(BaseRequest):
 class SaveFlowResponse(BaseResponse):
     """Response to save flow request."""
 
-    type: Literal["save_flow_response"] = "save_flow_response"
-    file_path: str | None = None
+    type: Literal["save_response"] = "save_response"
+    path: str | None = None
     error: str | None = None
 
 
 class RunWorkflowResponse(BaseResponse):
     """Response to run workflow request."""
 
-    type: Literal["run_workflow_response"] = "run_workflow_response"
+    type: Literal["run_response"] = "run_response"
     session_id: str
-    execution_mode: ExecutionMode
     error: str | None = None
 
 
 class StepRunWorkflowResponse(BaseResponse):
     """Response to step run workflow request."""
 
-    type: Literal["step_run_workflow_response"] = "step_run_workflow_response"
+    type: Literal["step_run_response"] = "step_run_response"
     session_id: str
-    auto_continue: bool
     breakpoints: list[str]
     error: str | None = None
 
@@ -291,9 +299,9 @@ class BreakpointResponse(BaseResponse):
 class ConvertWorkflowResponse(BaseResponse):
     """Response to convert workflow request."""
 
-    type: Literal["convert_workflow_response"] = "convert_workflow_response"
-    target_format: str
-    output_path: str | None = None
+    type: Literal["convert_response"] = "convert_response"
+    format: str
+    path: str | None = None
     error: str | None = None
 
 
@@ -301,8 +309,8 @@ class UploadFileResponse(BaseResponse):
     """Response to file upload."""
 
     type: Literal["upload_file_response"] = "upload_file_response"
-    file_path: str | None = None
-    file_size: int | None = None
+    path: str | None = None
+    size: int | None = None
     error: str | None = None
 
 
@@ -344,7 +352,7 @@ class WorkflowStatusNotification(BaseNotification):
     type: Literal["workflow_status"] = "workflow_status"
     session_id: str
     status: WorkflowStatus
-    execution_mode: ExecutionMode
+    mode: ExecutionMode
     details: str | None = None
 
     @classmethod
@@ -376,7 +384,7 @@ class WorkflowStatusNotification(BaseNotification):
         return cls(
             session_id=session_id,
             status=status,
-            execution_mode=mode,
+            mode=mode,
             details=details,
         )
 
@@ -721,14 +729,14 @@ def create_session_id() -> str:
 # ========================================
 
 CLIENT_MESSAGE_TYPES = {
-    "save_flow",
-    "run_workflow",
-    "step_run_workflow",
+    "save",
+    "run",
+    "step_run",
     "step_control",
     "breakpoint_control",
     "user_input",
-    "stop_workflow",
-    "convert_workflow",
+    "stop",
+    "convert",
     "upload_file",
     "ping",
     "get_status",
@@ -736,12 +744,12 @@ CLIENT_MESSAGE_TYPES = {
 
 SERVER_MESSAGE_TYPES = {
     # Responses
-    "save_flow_response",
-    "run_workflow_response",
-    "step_run_workflow_response",
+    "save_response",
+    "run_response",
+    "step_run_response",
     "step_control_response",
     "breakpoint_response",
-    "convert_workflow_response",
+    "convert_response",
     "upload_file_response",
     "pong",
     "status_response",
@@ -769,7 +777,7 @@ class SessionState(BaseModel):
     session_id: str
     client_id: str
     status: WorkflowStatus
-    execution_mode: ExecutionMode
+    mode: ExecutionMode
     start_time: int = Field(default_factory=time.monotonic_ns)
     end_time: int | None = None
     metadata: dict[str, Any] = Field(default_factory=dict)
@@ -828,7 +836,7 @@ class SessionState(BaseModel):
             "session_id": self.session_id,
             "client_id": self.client_id,
             "status": self.status.value,
-            "execution_mode": self.execution_mode.value,
+            "mode": self.mode.value,
             "duration_seconds": self.duration,
             "start_time": self.start_time,
             "end_time": self.end_time,
@@ -898,9 +906,9 @@ class WorkflowSession:
         return self._state.status
 
     @property
-    def execution_mode(self) -> ExecutionMode:
+    def mode(self) -> ExecutionMode:
         """Get execution mode."""
-        return self._state.execution_mode
+        return self._state.mode
 
     @property
     def temp_file(self) -> Path | None: