uipath 2.0.64__py3-none-any.whl → 2.0.66__py3-none-any.whl

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/_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/_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

{uipath-2.0.64.dist-info → uipath-2.0.66.dist-info}/METADATA

@@ -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.dist-info → uipath-2.0.66.dist-info}/RECORD

@@ -13,7 +13,7 @@ uipath/_cli/cli_invoke.py,sha256=IjndcDWBpvAqGCRanQU1vfmxaBF8FhyZ7gWuZqwjHrU,381
 uipath/_cli/cli_new.py,sha256=9378NYUBc9j-qKVXV7oja-jahfJhXBg8zKVyaon7ctY,2102
 uipath/_cli/cli_pack.py,sha256=8Ahk0vr_8eqMsq9ehhYWNfeII0VIiZVBXMpRF7Dbvtg,15018
 uipath/_cli/cli_publish.py,sha256=Ba0TJ1TSfuQbLU2AIgtM8QWkLHgr4tsAP1CaX12113U,6010
-uipath/_cli/cli_run.py,sha256=0q_DqM2QNfD8yOqUZB_5BTg96pCLzbHE1enD_XAj6CE,5215
+uipath/_cli/cli_run.py,sha256=zYg-9U6mkofdGsE0IGjYi1dOMlG8CdBxiVGxfFiLq5Y,5882
 uipath/_cli/middlewares.py,sha256=IiJgjsqrJVKSXx4RcIKHWoH-SqWqpHPbhzkQEybmAos,3937
 uipath/_cli/spinner.py,sha256=bS-U_HA5yne11ejUERu7CQoXmWdabUD2bm62EfEdV8M,1107
 uipath/_cli/_auth/_auth_server.py,sha256=p93_EvJpdoLLkiVmLygHRKo9ru1-PZOEAaEhNFN3j6c,6424
@@ -27,7 +27,7 @@ uipath/_cli/_auth/localhost.crt,sha256=oGl9oLLOiouHubAt39B4zEfylFvKEtbtr_43SIliX
 uipath/_cli/_auth/localhost.key,sha256=X31VYXD8scZtmGA837dGX5l6G-LXHLo5ItWJhZXaz3c,1679
 uipath/_cli/_runtime/_contracts.py,sha256=Rxs-uEOA490fLPNimB8LqZW7KI-72O0BLY4Jm7Fa1ms,14316
 uipath/_cli/_runtime/_escalation.py,sha256=x3vI98qsfRA-fL_tNkRVTFXioM5Gv2w0GFcXJJ5eQtg,7981
-uipath/_cli/_runtime/_hitl.py,sha256=zcyQmU-lTMklMpAPY8ifAbyo9Dv6ZDp6iCOoVFZxE0c,8331
+uipath/_cli/_runtime/_hitl.py,sha256=aexwe0dIXvh6SlVS1jVnO_aGZc6e3gLsmGkCyha5AHo,11300
 uipath/_cli/_runtime/_logging.py,sha256=lA2LsakOrcSLnJWgo80-BYzIQBUWfqzzJGI1M61Gu0s,7874
 uipath/_cli/_runtime/_runtime.py,sha256=-ZA7MZctX3e_YX_SN9XFjtsQKaCZCdBL3YRYFmsacN4,10162
 uipath/_cli/_templates/.psmdcp.template,sha256=C7pBJPt98ovEljcBvGtEUGoWjjQhu9jls1bpYjeLOKA,611
@@ -38,6 +38,7 @@ uipath/_cli/_templates/package.nuspec.template,sha256=YZyLc-u_EsmIoKf42JsLQ55OGe
 uipath/_cli/_utils/_common.py,sha256=wQ0a_lGj0bsuNvwxUfnLwg6T3IdatdfkrPcZMoufJNU,2058
 uipath/_cli/_utils/_console.py,sha256=rj4V3yeR1wnJzFTHnaE6wcY9OoJV-PiIQnLg_p62ClQ,6664
 uipath/_cli/_utils/_constants.py,sha256=mCeSWLURgw_dOMXjzyYBAvxKN3Vcd1vf7XKHgbdrOds,25
+uipath/_cli/_utils/_debug.py,sha256=XlMkjtXT6hqyn7huioLDaVSYqo9fyWCvTkqEJh_ZEGw,1598
 uipath/_cli/_utils/_folders.py,sha256=usjLNOMdhvelEv0wsJ-v6q-qiUR1tbwXJL4Sd_SOocI,970
 uipath/_cli/_utils/_input_args.py,sha256=pyQhEcQXHdFHYTVNzvfWp439aii5StojoptnmCv5lfs,4094
 uipath/_cli/_utils/_parse_ast.py,sha256=A-QToBIf-oP7yP2DQTHO6blkk6ik5z_IeaIwtEWO4e0,19516
@@ -90,8 +91,8 @@ uipath/tracing/__init__.py,sha256=GKRINyWdHVrDsI-8mrZDLdf0oey6GHGlNZTOADK-kgc,22
 uipath/tracing/_otel_exporters.py,sha256=x0PDPmDKJcxashsuehVsSsqBCzRr6WsNFaq_3_HS5F0,3014
 uipath/tracing/_traced.py,sha256=qeVDrds2OUnpdUIA0RhtF0kg2dlAZhyC1RRkI-qivTM,18528
 uipath/tracing/_utils.py,sha256=ZeensQexnw69jVcsVrGyED7mPlAU-L1agDGm6_1A3oc,10388
-uipath-2.0.64.dist-info/METADATA,sha256=3wKXRRMa7h8XVtGrCXXr6S9YUkHwsr_C-MYQ2eSqn_k,6304
-uipath-2.0.64.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-uipath-2.0.64.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
-uipath-2.0.64.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
-uipath-2.0.64.dist-info/RECORD,,
+uipath-2.0.66.dist-info/METADATA,sha256=YvHAH6jQRsjeveGyJ8_IarkNOYgTQ4v9fHY_04rtw4E,6304
+uipath-2.0.66.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.0.66.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.0.66.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
+uipath-2.0.66.dist-info/RECORD,,