uipath 2.0.65__tar.gz → 2.0.67__tar.gz

uipath-2.0.67/.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.65 → uipath-2.0.67}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.65
+Version: 2.0.67
 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.65 → uipath-2.0.67}/docs/cli/index.md

@@ -46,6 +46,28 @@ 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:
+1. add the [debug configuration](https://github.com/UiPath/uipath-python/blob/main/.vscode/launch.json) in your `.vscode/launch.json` file.
+2. Place breakpoints in your code where needed.
+3. 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:
 
@@ -85,6 +107,38 @@ uipath run agent '{\"topic\":\"uipath\"}'
 
 Packages your project into a `.nupkg` file that can be deployed to UiPath.
 
+/// info
+### Default Files Included in `.nupkg`
+
+By default, the following file types are included in the `.nupkg` file:
+
+- `.py`
+- `.mermaid`
+- `.json`
+- `.yaml`
+- `.yml`
+
+---
+
+### Including Extra Files
+
+To include additional files, update the `uipath.json` file by adding a `settings` section. Use the following configuration format:
+
+```json
+{
+    "settings": {
+        "filesIncluded": [
+            "<file here>"
+        ],
+        "fileExtensionsIncluded": [
+            "<new file extension to include (e.g., 'go')>"
+        ]
+    }
+}
+```
+
+///
+
 /// warning
 Your `pyproject.toml` must include:
 
@@ -162,4 +216,4 @@ Selected feed: Orchestrator Tenant Processes Feed
 ⠴ Starting job ...
 ✨ Job started successfully!
 🔗 Monitor your job here: [LINK]
-```
+```

{uipath-2.0.65 → uipath-2.0.67}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.65"
+version = "2.0.67"
 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.67/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.65 → uipath-2.0.67}/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

{uipath-2.0.65 → uipath-2.0.67}/src/uipath/_services/context_grounding_service.py

@@ -673,7 +673,7 @@ class ContextGroundingService(FolderContext, BaseService):
             )
 
         if folder_key is None:
-            raise ValueError("Folder key or folder path is required")
+            raise ValueError("ContextGrounding: Failed to resolve folder key")
 
         return folder_key
 
@@ -681,4 +681,6 @@ class ContextGroundingService(FolderContext, BaseService):
         try:
             return index.data_source.bucketName, index.data_source.folder  # type: ignore
         except AttributeError as e:
-            raise Exception("Cannot extract bucket data from index") from e
+            raise Exception(
+                "ContextGrounding: Cannot extract bucket data from index"
+            ) from e

{uipath-2.0.65 → uipath-2.0.67}/src/uipath/_services/folder_service.py

@@ -34,25 +34,19 @@ class FolderService(BaseService):
             url=spec.endpoint,
             params=spec.params,
         ).json()
-
-        return next(
-            (
-                item["Key"]
-                for item in response["PageItems"]
-                if item["FullyQualifiedName"] == folder_path
-            ),
-            None,
-        )
+        try:
+            return response["value"][0]["Key"]
+        except KeyError:
+            return None
 
     def _retrieve_spec(self, folder_path: str) -> RequestSpec:
         folder_name = folder_path.split("/")[-1]
         return RequestSpec(
             method="GET",
-            endpoint=Endpoint(
-                "orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser"
-            ),
+            endpoint=Endpoint("orchestrator_/odata/Folders"),
             params={
-                "searchText": folder_name,
-                "take": 1,
+                "$filter": f"DisplayName eq '{folder_name}'",
+                "$top": 1,
+                "$select": "Key",
             },
         )

{uipath-2.0.65 → uipath-2.0.67}/tests/sdk/services/test_context_grounding_service.py

@@ -38,13 +38,12 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -68,13 +67,12 @@ class TestContextGroundingService:
         )
 
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -132,13 +130,12 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -162,13 +159,12 @@ class TestContextGroundingService:
         )
 
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -225,13 +221,12 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -285,13 +280,12 @@ class TestContextGroundingService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },

{uipath-2.0.65 → uipath-2.0.67}/tests/sdk/services/test_folder_service.py

@@ -28,20 +28,19 @@ class TestFolderService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test_folder_path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
         )
 
         with pytest.warns(DeprecationWarning, match="Use retrieve_key instead"):
-            folder_key = service.retrieve_key_by_folder_path("test-folder-path")
+            folder_key = service.retrieve_key_by_folder_path("test_folder_path")
 
         assert folder_key == "test-folder-key"
 
@@ -52,7 +51,7 @@ class TestFolderService:
         assert sent_request.method == "GET"
         assert (
             sent_request.url
-            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1"
+            == f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test_folder_path%27&%24top=1&%24select=Key"
         )
 
         assert HEADER_USER_AGENT in sent_request.headers
@@ -71,9 +70,9 @@ class TestFolderService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key",
             status_code=200,
-            json={"PageItems": []},
+            json={},
         )
 
         with pytest.warns(DeprecationWarning, match="Use retrieve_key instead"):
@@ -88,7 +87,7 @@ class TestFolderService:
         assert sent_request.method == "GET"
         assert (
             sent_request.url
-            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1"
+            == f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key"
         )
 
         assert HEADER_USER_AGENT in sent_request.headers
@@ -107,13 +106,12 @@ class TestFolderService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key",
             status_code=200,
             json={
-                "PageItems": [
+                "value": [
                     {
                         "Key": "test-folder-key",
-                        "FullyQualifiedName": "test-folder-path",
                     }
                 ]
             },
@@ -130,7 +128,7 @@ class TestFolderService:
         assert sent_request.method == "GET"
         assert (
             sent_request.url
-            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=test-folder-path&take=1"
+            == f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27test-folder-path%27&%24top=1&%24select=Key"
         )
 
         assert HEADER_USER_AGENT in sent_request.headers
@@ -149,9 +147,9 @@ class TestFolderService:
         version: str,
     ) -> None:
         httpx_mock.add_response(
-            url=f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1",
+            url=f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key",
             status_code=200,
-            json={"PageItems": []},
+            json={},
         )
 
         folder_key = service.retrieve_key_by_folder_path("non-existent-folder")
@@ -165,7 +163,7 @@ class TestFolderService:
         assert sent_request.method == "GET"
         assert (
             sent_request.url
-            == f"{base_url}{org}{tenant}/orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser?searchText=non-existent-folder&take=1"
+            == f"{base_url}{org}{tenant}/orchestrator_/odata/Folders?%24filter=DisplayName+eq+%27non-existent-folder%27&%24top=1&%24select=Key"
         )
 
         assert HEADER_USER_AGENT in sent_request.headers

{uipath-2.0.65 → uipath-2.0.67}/uv.lock

@@ -3111,7 +3111,7 @@ wheels = [
 
 [[package]]
 name = "uipath"
-version = "2.0.65"
+version = "2.0.67"
 source = { editable = "." }
 dependencies = [
     { name = "azure-monitor-opentelemetry" },