uipath 2.0.64__tar.gz → 2.0.66__tar.gz

uipath-2.0.66/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python Debugger: Attach",
+      "type": "debugpy",
+      "request": "attach",
+      "connect": {
+        "host": "localhost",
+        "port": 5678
+      }
+    }
+  ]
+}

{uipath-2.0.64 → uipath-2.0.66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.64
+Version: 2.0.66
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python

{uipath-2.0.64 → uipath-2.0.66}/docs/cli/index.md

@@ -46,6 +46,27 @@ The `uipath init` command executes your `main.py` file to analyze its structure
     :depth: 1
     :style: table
 
+/// tip
+For step-by-step debugging with breakpoints and variable inspection (supported from `2.0.66` onward):
+```console
+# Install debugpy package
+[uv] pip install debugpy
+# Run agent with debugging enabled
+uipath run [ENTRYPOINT] [INPUT] --debug
+```
+For vscode: add the [debug configuration](https://github.com/UiPath/uipath-python/blob/main/.vscode/launch.json) in your .vscode/launch.json file.
+Place breakpoints in your code where needed.
+Use the shortcut `F5`, or navigate to Run -> Start Debugging -> Python Debugger: Attach
+
+Upon starting the debugging process, one should see the following logs in terminal:
+```console
+🐛 Debug server started on port 5678
+📌 Waiting for debugger to attach...
+  - VS Code: Run -> Start Debugging -> Python Debugger: Attach
+✓  Debugger attached successfully!
+```
+///
+
 /// warning
 Depending on the shell you are using, it may be necessary to escape the input json:
 
@@ -162,4 +183,4 @@ Selected feed: Orchestrator Tenant Processes Feed
 ⠴ Starting job ...
 ✨ Job started successfully!
 🔗 Monitor your job here: [LINK]
-```
+```

{uipath-2.0.64 → uipath-2.0.66}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.64"
+version = "2.0.66"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

{uipath-2.0.64 → uipath-2.0.66}/src/uipath/_cli/_runtime/_hitl.py

@@ -19,20 +19,47 @@ from .._utils._common import serialize_object
 from ._escalation import Escalation
 
 
-def _try_convert_to_json_format(value: str) -> str:
+def _try_convert_to_json_format(value: str | None) -> str | None:
+    """Attempts to parse a string as JSON and returns the parsed object or original string.
+
+    Args:
+        value: The string value to attempt JSON parsing on.
+
+    Returns:
+        The parsed JSON object if successful, otherwise the original string value.
+    """
     try:
+        if not value:
+            return None
         return json.loads(value)
     except json.decoder.JSONDecodeError:
         return value
 
 
-default_escalation = Escalation()
-
-
 class HitlReader:
+    """Handles reading and retrieving Human-In-The-Loop (HITL) data from UiPath services."""
+
     @classmethod
     async def read(cls, resume_trigger: UiPathResumeTrigger) -> Optional[str]:
+        """Reads data from a UiPath resume trigger based on its type.
+
+        This method handles different types of resume triggers (ACTION, JOB, API) and retrieves
+        the appropriate data from UiPath services. For actions, it retrieves action data with
+        optional escalation processing. For jobs, it retrieves job output and validates success.
+        For API triggers, it retrieves the API payload.
+
+        Args:
+            resume_trigger: The UiPath resume trigger containing the trigger type and metadata.
+
+        Returns:
+            The retrieved data as a string, or None if no data is available.
+
+        Raises:
+            UiPathRuntimeError: If the job failed, API connection failed, trigger type is unknown,
+                or HITL feedback retrieval failed.
+        """
         uipath = UiPath()
+        default_escalation = Escalation()
         match resume_trigger.trigger_type:
             case UiPathResumeTriggerType.ACTION:
                 if resume_trigger.item_key:
@@ -62,9 +89,10 @@ class HitlReader:
                         raise UiPathRuntimeError(
                             "INVOKED_PROCESS_FAILURE",
                             "Invoked process did not finish successfully.",
-                            _try_convert_to_json_format(str(job.job_error or job.info)),
+                            _try_convert_to_json_format(str(job.job_error or job.info))
+                            or "Job error unavailable.",
                         )
-                    return job.output_arguments
+                    return _try_convert_to_json_format(job.output_arguments)
 
             case UiPathResumeTriggerType.API:
                 if resume_trigger.api_resume and resume_trigger.api_resume.inbox_id:
@@ -97,13 +125,30 @@ class HitlReader:
 
 @dataclass
 class HitlProcessor:
-    """Processes events in a Human-(Robot/Agent)-In-The-Loop scenario."""
+    """Processes events in a Human-(Robot/Agent)-In-The-Loop scenario.
+
+    This class handles the creation and processing of HITL resume triggers for different
+    types of UiPath operations including actions, jobs, and API calls. It determines the
+    appropriate trigger type based on the input value and creates the corresponding
+    resume trigger with proper configuration.
+
+    Attributes:
+        value: The input value to be processed, can be various UiPath model types or strings.
+    """
 
     value: Any
 
     @cached_property
     def type(self) -> UiPathResumeTriggerType:
-        """Returns the type of the interrupt value."""
+        """Determines the resume trigger type based on the input value.
+
+        Analyzes the input value type and returns the corresponding UiPath resume trigger type.
+        Actions (CreateAction, WaitAction) map to ACTION type, jobs (InvokeProcess, WaitJob)
+        map to JOB type, and all other values default to API type.
+
+        Returns:
+            The appropriate UiPathResumeTriggerType based on the input value type.
+        """
         if isinstance(self.value, CreateAction) or isinstance(self.value, WaitAction):
             return UiPathResumeTriggerType.ACTION
         if isinstance(self.value, InvokeProcess) or isinstance(self.value, WaitJob):
@@ -112,8 +157,26 @@ class HitlProcessor:
         return UiPathResumeTriggerType.API
 
     async def create_resume_trigger(self) -> UiPathResumeTrigger:
-        """Returns the resume trigger."""
+        """Creates a UiPath resume trigger based on the input value and its type.
+
+        This method processes the input value and creates an appropriate resume trigger
+        for HITL scenarios. It handles different input types:
+        - Actions: Creates or references UiPath actions with folder information
+        - Jobs: Invokes processes or references existing jobs with folder information
+        - API: Creates API triggers with generated inbox IDs
+        - String with escalation: Creates escalated actions
+
+        Returns:
+            A configured UiPathResumeTrigger ready for HITL processing.
+
+        Raises:
+            UiPathRuntimeError: If action/job creation fails, escalation fails, or an
+                unknown model type is encountered.
+            Exception: If any underlying UiPath service calls fail.
+        """
         uipath = UiPath()
+        default_escalation = Escalation()
+
         try:
             hitl_input = self.value
             resume_trigger = UiPathResumeTrigger(

uipath-2.0.66/src/uipath/_cli/_utils/_debug.py

@@ -0,0 +1,52 @@
+"""Debug utilities for UiPath CLI."""
+
+import os
+
+from ._console import ConsoleLogger
+
+console = ConsoleLogger()
+
+
+def setup_debugging(debug: bool, debug_port: int = 5678) -> bool:
+    """Setup debugging with debugpy if requested.
+
+    Args:
+        debug: Whether to enable debugging
+        debug_port: Port for the debug server (default: 5678)
+
+    Returns:
+        bool: True if debugging was setup successfully or not requested, False on error
+    """
+    if not debug:
+        return True
+
+    # Set environment variables to improve debugging
+    os.environ["PYDEVD_DISABLE_FILE_VALIDATION"] = "1"
+    os.environ["PYDEVD_USE_FRAME_EVAL"] = "NO"
+
+    # Try to import debugpy, log warning if not available
+    try:
+        import debugpy  # type: ignore[import-not-found]
+    except ImportError:
+        console.warning(
+            "debugpy not found, please install it and retry: '[uv] pip install debugpy'"
+        )
+        return False
+
+    # Configure debugpy for better breakpoint handling
+    try:
+        # Clear any existing listeners
+        debugpy.configure(subProcess=False)
+
+        debugpy.listen(debug_port)
+        console.info(f"🐛 Debug server started on port {debug_port}")
+        console.info("📌 Waiting for debugger to attach...")
+        console.info("  - VS Code: Run -> Start Debugging -> Python: Remote Attach")
+
+        debugpy.wait_for_client()
+        console.success("Debugger attached successfully!")
+
+        return True
+    except Exception as e:
+        console.error(f"Failed to start debug server on port {debug_port}: {str(e)}")
+        return False

{uipath-2.0.64 → uipath-2.0.66}/src/uipath/_cli/cli_run.py

@@ -9,6 +9,8 @@ from uuid import uuid4
 import click
 from dotenv import load_dotenv
 
+from uipath._cli._utils._debug import setup_debugging
+
 from .._utils.constants import (
     ENV_JOB_ID,
 )
@@ -27,7 +29,9 @@ load_dotenv(override=True)
 
 
 def python_run_middleware(
-    entrypoint: Optional[str], input: Optional[str], resume: bool
+    entrypoint: Optional[str],
+    input: Optional[str],
+    resume: bool,
 ) -> MiddlewareResult:
     """Middleware to handle Python script execution.
 
@@ -35,6 +39,8 @@ def python_run_middleware(
         entrypoint: Path to the Python script to execute
         input: JSON string with input data
         resume: Flag indicating if this is a resume execution
+        debug: Enable debugging with debugpy
+        debug_port: Port for debug server (default: 5678)
 
     Returns:
         MiddlewareResult with execution status and messages
@@ -112,9 +118,25 @@ Usage: `uipath run <entrypoint_path> <input_arguments> [-f <input_json_file_path
     type=click.Path(exists=True),
     help="File path for the .json input",
 )
+@click.option(
+    "--debug",
+    is_flag=True,
+    help="Enable debugging with debugpy. The process will wait for a debugger to attach.",
+)
+@click.option(
+    "--debug-port",
+    type=int,
+    default=5678,
+    help="Port for the debug server (default: 5678)",
+)
 @track(when=lambda *_a, **_kw: env.get(ENV_JOB_ID) is None)
 def run(
-    entrypoint: Optional[str], input: Optional[str], resume: bool, file: Optional[str]
+    entrypoint: Optional[str],
+    input: Optional[str],
+    resume: bool,
+    file: Optional[str],
+    debug: bool,
+    debug_port: int,
 ) -> None:
     """Execute the project."""
     if file:
@@ -123,12 +145,19 @@ def run(
             console.error("Input file extension must be '.json'.")
         with open(file) as f:
             input = f.read()
+    # Setup debugging if requested
+
+    if not setup_debugging(debug, debug_port):
+        console.error(f"Failed to start debug server on port {debug_port}")
+
     # Process through middleware chain
     result = Middlewares.next("run", entrypoint, input, resume)
 
     if result.should_continue:
         result = python_run_middleware(
-            entrypoint=entrypoint, input=input, resume=resume
+            entrypoint=entrypoint,
+            input=input,
+            resume=resume,
         )
 
     # Handle result from middleware