uipath 2.0.57__tar.gz → 2.0.59__tar.gz

{uipath-2.0.57 → uipath-2.0.59}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.57
+Version: 2.0.59
 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.59/docs/core/attachments.md

@@ -0,0 +1 @@
+::: uipath._services.attachments_service

{uipath-2.0.57 → uipath-2.0.59}/docs/core/traced.md

@@ -9,7 +9,7 @@ You can view the traces of an Orchestrator job by going to the Jobs page, click
 Apply the `@traced()` decorator to any function (sync, async, generator, or async generator) to automatically record its execution as a trace span.
 
 ```python hl_lines="3 7"
-from uipath.tracing._traced import traced
+from uipath.tracing import traced
 
 @traced()
 def my_function(x, y):

uipath-2.0.59/docs/overrides/partials/actions.html

@@ -0,0 +1,11 @@
+{% set title = ("[" + (page.title or config.site_name) + "] Your title here") | urlencode %}
+{% set body = ("Page link:: " + config.site_url + page.url + "\n\n ## My Issue/Suggestion") | urlencode %}
+<a href="https://github.com/UiPath/uipath-python/issues/new?title={{ title }}&body={{ body }}"
+    class="md-content__button skip-link-icon report-issue-link">
+    <svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+        <path fill-rule="evenodd" clip-rule="evenodd"
+            d="M17.19 8H20V10H17.91C17.96 10.33 18 10.66 18 11V12H20V14H18V15C18 15.34 17.96 15.67 17.91 16H20V18H17.19C16.15 19.79 14.22 21 12 21C9.78 21 7.85 19.79 6.81 18H4V16H6.09C6.04 15.67 6 15.34 6 15V14H4V12H6V11C6 10.66 6.04 10.33 6.09 10H4V8H6.81C7.26 7.22 7.88 6.55 8.62 6.04L7 4.41L8.41 3L10.59 5.17C11.04 5.06 11.51 5 12 5C12.49 5 12.96 5.06 13.42 5.17L15.59 3L17 4.41L15.37 6.04C16.12 6.55 16.74 7.22 17.19 8ZM16 15V12V11C16 10.78 15.97 10.53 15.93 10.31L15.83 9.66L15.45 9.01C15.15 8.48 14.74 8.04 14.24 7.7L13.63 7.28L12.95 7.12C12.63 7.04 12.32 7 12 7C11.69 7 11.37 7.04 11.06 7.12L10.32 7.3L9.75 7.69C9.26 8.03 8.84 8.48 8.54 9L8.17 9.65L8.07 10.3C8.03 10.52 8 10.77 8 11V15C8 15.23 8.03 15.48 8.07 15.71L8.17 16.36L8.54 17C9.26 18.23 10.58 19 12 19C13.42 19 14.74 18.24 15.46 17L15.83 16.35L15.93 15.7C15.97 15.47 16 15.22 16 15ZM10 14H14V16H10V14ZM14 10H10V12H14V10Z" />
+    </svg>
+
+    Report an issue
+</a>

{uipath-2.0.57 → uipath-2.0.59}/docs/stylesheets/extra.css

@@ -150,6 +150,15 @@ a[href^="https://"]:not(.md-source):not(.skip-link-icon) {
 }
 
 .report-issue-link {
-    text-decoration: underline;
-    text-decoration-style: wavy;
+    margin-block: 0.8rem;
+    font-size: 0.7rem;
+    line-height: 1;
+    display: flex;
+    align-items: center;
+
+    svg {
+        margin-top: -0.1rem;
+        width: 0.7rem;
+        height: 0.7rem;
+    }
 }

{uipath-2.0.57 → uipath-2.0.59}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.57"
+version = "2.0.59"
 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.57 → uipath-2.0.59}/src/uipath/_cli/_runtime/_runtime.py

@@ -8,6 +8,12 @@ import os
 from dataclasses import asdict, is_dataclass
 from typing import Any, Dict, Optional, Type, TypeVar, cast, get_type_hints
 
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+from uipath.tracing import LlmOpsHttpExporter
+
 from ._contracts import (
     UiPathBaseRuntime,
     UiPathErrorCategory,
@@ -36,6 +42,11 @@ class UiPathRuntime(UiPathBaseRuntime):
         await self.validate()
 
         try:
+            trace.set_tracer_provider(TracerProvider())
+            trace.get_tracer_provider().add_span_processor(  # type: ignore
+                BatchSpanProcessor(LlmOpsHttpExporter())
+            )
+
             if self.context.entrypoint is None:
                 return None
 
@@ -62,6 +73,8 @@ class UiPathRuntime(UiPathBaseRuntime):
                 f"Error: {str(e)}",
                 UiPathErrorCategory.SYSTEM,
             ) from e
+        finally:
+            trace.get_tracer_provider().shutdown()  # type: ignore
 
     async def validate(self) -> None:
         """Validate runtime inputs."""

{uipath-2.0.57 → uipath-2.0.59}/src/uipath/_services/attachments_service.py

@@ -1,12 +1,17 @@
+import os
+import shutil
+import tempfile
 import uuid
+from pathlib import Path
 from typing import Any, Dict, Optional, Union, overload
 
-from httpx import request
+import httpx
 
 from .._config import Config
 from .._execution_context import ExecutionContext
 from .._folder_context import FolderContext
 from .._utils import Endpoint, RequestSpec, header_folder
+from .._utils.constants import TEMP_ATTACHMENTS_FOLDER
 from ..tracing._traced import traced
 from ._base_service import BaseService
 
@@ -35,6 +40,7 @@ class AttachmentsService(FolderContext, BaseService):
 
     def __init__(self, config: Config, execution_context: ExecutionContext) -> None:
         super().__init__(config=config, execution_context=execution_context)
+        self._temp_dir = os.path.join(tempfile.gettempdir(), TEMP_ATTACHMENTS_FOLDER)
 
     @traced(name="attachments_download", run_type="uipath")
     def download(
@@ -48,6 +54,12 @@ class AttachmentsService(FolderContext, BaseService):
         """Download an attachment.
 
         This method downloads an attachment from UiPath to a local file.
+        If the attachment is not found in UiPath (404 error), it will check
+        for a local file in the temporary directory that matches the UUID.
+
+        Note:
+            The local file fallback functionality is intended for local development
+            and debugging purposes only.
 
         Args:
             key (uuid.UUID): The key of the attachment to download.
@@ -59,7 +71,7 @@ class AttachmentsService(FolderContext, BaseService):
             str: The name of the downloaded attachment.
 
         Raises:
-            Exception: If the download fails.
+            Exception: If the download fails and no local file is found.
 
         Examples:
             ```python
@@ -74,42 +86,75 @@ class AttachmentsService(FolderContext, BaseService):
             print(f"Downloaded attachment: {attachment_name}")
             ```
         """
-        spec = self._retrieve_download_uri_spec(
-            key=key,
-            folder_key=folder_key,
-            folder_path=folder_path,
-        )
-
-        result = self.request(
-            spec.method,
-            url=spec.endpoint,
-            params=spec.params,
-            headers=spec.headers,
-        ).json()
-
-        # Get the attachment name
-        attachment_name = result["Name"]
-
-        download_uri = result["BlobFileAccess"]["Uri"]
-        headers = {
-            key: value
-            for key, value in zip(
-                result["BlobFileAccess"]["Headers"]["Keys"],
-                result["BlobFileAccess"]["Headers"]["Values"],
-                strict=False,
+        try:
+            spec = self._retrieve_download_uri_spec(
+                key=key,
+                folder_key=folder_key,
+                folder_path=folder_path,
             )
-        }
 
-        with open(destination_path, "wb") as file:
-            if result["BlobFileAccess"]["RequiresAuth"]:
-                file_content = self.request(
-                    "GET", download_uri, headers=headers
-                ).content
-            else:
-                file_content = request("GET", download_uri, headers=headers).content
-            file.write(file_content)
+            result = self.request(
+                spec.method,
+                url=spec.endpoint,
+                params=spec.params,
+                headers=spec.headers,
+            ).json()
+
+            # Get the attachment name
+            attachment_name = result["Name"]
+
+            download_uri = result["BlobFileAccess"]["Uri"]
+            headers = {
+                key: value
+                for key, value in zip(
+                    result["BlobFileAccess"]["Headers"]["Keys"],
+                    result["BlobFileAccess"]["Headers"]["Values"],
+                    strict=False,
+                )
+            }
 
-        return attachment_name
+            with open(destination_path, "wb") as file:
+                if result["BlobFileAccess"]["RequiresAuth"]:
+                    response = self.request(
+                        "GET", download_uri, headers=headers, stream=True
+                    )
+                    for chunk in response.iter_bytes(chunk_size=8192):
+                        file.write(chunk)
+                else:
+                    with httpx.Client() as client:
+                        with client.stream(
+                            "GET", download_uri, headers=headers
+                        ) as response:
+                            for chunk in response.iter_bytes(chunk_size=8192):
+                                file.write(chunk)
+
+            return attachment_name
+        except Exception as e:
+            # If not found in UiPath, check local storage
+            if "404" in str(e):
+                # Check if file exists in temp directory
+                if os.path.exists(self._temp_dir):
+                    # Look for any file starting with our UUID
+                    pattern = f"{key}_*"
+                    matching_files = list(Path(self._temp_dir).glob(pattern))
+
+                    if matching_files:
+                        # Get the full filename
+                        local_file = matching_files[0]
+
+                        # Extract the original name from the filename (part after UUID_)
+                        file_name = os.path.basename(local_file)
+                        original_name = file_name[len(f"{key}_") :]
+
+                        # Copy the file to the destination
+                        shutil.copy2(local_file, destination_path)
+
+                        return original_name
+
+            # Re-raise the original exception if we can't find it locally
+            raise Exception(
+                f"Attachment with key {key} not found in UiPath or local storage"
+            ) from e
 
     @traced(name="attachments_download", run_type="uipath")
     async def download_async(
@@ -123,6 +168,12 @@ class AttachmentsService(FolderContext, BaseService):
         """Download an attachment asynchronously.
 
         This method asynchronously downloads an attachment from UiPath to a local file.
+        If the attachment is not found in UiPath (404 error), it will check
+        for a local file in the temporary directory that matches the UUID.
+
+        Note:
+            The local file fallback functionality is intended for local development
+            and debugging purposes only.
 
         Args:
             key (uuid.UUID): The key of the attachment to download.
@@ -134,7 +185,7 @@ class AttachmentsService(FolderContext, BaseService):
             str: The name of the downloaded attachment.
 
         Raises:
-            Exception: If the download fails.
+            Exception: If the download fails and no local file is found.
 
         Examples:
             ```python
@@ -151,44 +202,77 @@ class AttachmentsService(FolderContext, BaseService):
                 print(f"Downloaded attachment: {attachment_name}")
             ```
         """
-        spec = self._retrieve_download_uri_spec(
-            key=key,
-            folder_key=folder_key,
-            folder_path=folder_path,
-        )
-
-        result = (
-            await self.request_async(
-                spec.method,
-                url=spec.endpoint,
-                params=spec.params,
-                headers=spec.headers,
-            )
-        ).json()
-
-        # Get the attachment name
-        attachment_name = result["Name"]
-
-        download_uri = result["BlobFileAccess"]["Uri"]
-        headers = {
-            key: value
-            for key, value in zip(
-                result["BlobFileAccess"]["Headers"]["Keys"],
-                result["BlobFileAccess"]["Headers"]["Values"],
-                strict=False,
+        try:
+            spec = self._retrieve_download_uri_spec(
+                key=key,
+                folder_key=folder_key,
+                folder_path=folder_path,
             )
-        }
 
-        with open(destination_path, "wb") as file:
-            if result["BlobFileAccess"]["RequiresAuth"]:
-                response = await self.request_async(
-                    "GET", download_uri, headers=headers
+            result = (
+                await self.request_async(
+                    spec.method,
+                    url=spec.endpoint,
+                    params=spec.params,
+                    headers=spec.headers,
                 )
-                file.write(response.content)
-            else:
-                file.write(request("GET", download_uri, headers=headers).content)
+            ).json()
+
+            # Get the attachment name
+            attachment_name = result["Name"]
+
+            download_uri = result["BlobFileAccess"]["Uri"]
+            headers = {
+                key: value
+                for key, value in zip(
+                    result["BlobFileAccess"]["Headers"]["Keys"],
+                    result["BlobFileAccess"]["Headers"]["Values"],
+                    strict=False,
+                )
+            }
 
-        return attachment_name
+            with open(destination_path, "wb") as file:
+                if result["BlobFileAccess"]["RequiresAuth"]:
+                    response = await self.request_async(
+                        "GET", download_uri, headers=headers, stream=True
+                    )
+                    async for chunk in response.aiter_bytes(chunk_size=8192):
+                        file.write(chunk)
+                else:
+                    async with httpx.AsyncClient() as client:
+                        async with client.stream(
+                            "GET", download_uri, headers=headers
+                        ) as response:
+                            async for chunk in response.aiter_bytes(chunk_size=8192):
+                                file.write(chunk)
+
+            return attachment_name
+        except Exception as e:
+            # If not found in UiPath, check local storage
+            if "404" in str(e):
+                # Check if file exists in temp directory
+                if os.path.exists(self._temp_dir):
+                    # Look for any file starting with our UUID
+                    pattern = f"{key}_*"
+                    matching_files = list(Path(self._temp_dir).glob(pattern))
+
+                    if matching_files:
+                        # Get the full filename
+                        local_file = matching_files[0]
+
+                        # Extract the original name from the filename (part after UUID_)
+                        file_name = os.path.basename(local_file)
+                        original_name = file_name[len(f"{key}_") :]
+
+                        # Copy the file to the destination
+                        shutil.copy2(local_file, destination_path)
+
+                        return original_name
+
+            # Re-raise the original exception if we can't find it locally
+            raise Exception(
+                f"Attachment with key {key} not found in UiPath or local storage"
+            ) from e
 
     @overload
     def upload(
@@ -305,7 +389,8 @@ class AttachmentsService(FolderContext, BaseService):
                         "PUT", upload_uri, headers=headers, files={"file": file}
                     )
                 else:
-                    request("PUT", upload_uri, headers=headers, files={"file": file})
+                    with httpx.Client() as client:
+                        client.put(upload_uri, headers=headers, files={"file": file})
         else:
             # Upload from memory
             # Convert string to bytes if needed
@@ -315,7 +400,8 @@ class AttachmentsService(FolderContext, BaseService):
             if result["BlobFileAccess"]["RequiresAuth"]:
                 self.request("PUT", upload_uri, headers=headers, content=content)
             else:
-                request("PUT", upload_uri, headers=headers, content=content)
+                with httpx.Client() as client:
+                    client.put(upload_uri, headers=headers, content=content)
 
         return attachment_key
 
@@ -438,7 +524,8 @@ class AttachmentsService(FolderContext, BaseService):
                         "PUT", upload_uri, headers=headers, files={"file": file}
                     )
                 else:
-                    request("PUT", upload_uri, headers=headers, files={"file": file})
+                    with httpx.Client() as client:
+                        client.put(upload_uri, headers=headers, files={"file": file})
         else:
             # Upload from memory
             # Convert string to bytes if needed
@@ -450,7 +537,8 @@ class AttachmentsService(FolderContext, BaseService):
                     "PUT", upload_uri, headers=headers, content=content
                 )
             else:
-                request("PUT", upload_uri, headers=headers, content=content)
+                with httpx.Client() as client:
+                    client.put(upload_uri, headers=headers, content=content)
 
         return attachment_key
 
@@ -465,6 +553,12 @@ class AttachmentsService(FolderContext, BaseService):
         """Delete an attachment.
 
         This method deletes an attachment from UiPath.
+        If the attachment is not found in UiPath (404 error), it will check
+        for a local file in the temporary directory that matches the UUID.
+
+        Note:
+            The local file fallback functionality is intended for local development
+            and debugging purposes only.
 
         Args:
             key (uuid.UUID): The key of the attachment to delete.
@@ -472,7 +566,7 @@ class AttachmentsService(FolderContext, BaseService):
             folder_path (Optional[str]): The path of the folder. Override the default one set in the SDK config.
 
         Raises:
-            Exception: If the deletion fails.
+            Exception: If the deletion fails and no local file is found.
 
         Examples:
             ```python
@@ -486,17 +580,37 @@ class AttachmentsService(FolderContext, BaseService):
             print("Attachment deleted successfully")
             ```
         """
-        spec = self._delete_attachment_spec(
-            key=key,
-            folder_key=folder_key,
-            folder_path=folder_path,
-        )
+        try:
+            spec = self._delete_attachment_spec(
+                key=key,
+                folder_key=folder_key,
+                folder_path=folder_path,
+            )
 
-        self.request(
-            spec.method,
-            url=spec.endpoint,
-            headers=spec.headers,
-        )
+            self.request(
+                spec.method,
+                url=spec.endpoint,
+                headers=spec.headers,
+            )
+        except Exception as e:
+            # If not found in UiPath, check local storage
+            if "404" in str(e):
+                # Check if file exists in temp directory
+                if os.path.exists(self._temp_dir):
+                    # Look for any file starting with our UUID
+                    pattern = f"{key}_*"
+                    matching_files = list(Path(self._temp_dir).glob(pattern))
+
+                    if matching_files:
+                        # Delete all matching files
+                        for file_path in matching_files:
+                            os.remove(file_path)
+                        return
+
+            # Re-raise the original exception if we can't find it locally
+            raise Exception(
+                f"Attachment with key {key} not found in UiPath or local storage"
+            ) from e
 
     @traced(name="attachments_delete", run_type="uipath")
     async def delete_async(
@@ -509,6 +623,12 @@ class AttachmentsService(FolderContext, BaseService):
         """Delete an attachment asynchronously.
 
         This method asynchronously deletes an attachment from UiPath.
+        If the attachment is not found in UiPath (404 error), it will check
+        for a local file in the temporary directory that matches the UUID.
+
+        Note:
+            The local file fallback functionality is intended for local development
+            and debugging purposes only.
 
         Args:
             key (uuid.UUID): The key of the attachment to delete.
@@ -516,7 +636,7 @@ class AttachmentsService(FolderContext, BaseService):
             folder_path (Optional[str]): The path of the folder. Override the default one set in the SDK config.
 
         Raises:
-            Exception: If the deletion fails.
+            Exception: If the deletion fails and no local file is found.
 
         Examples:
             ```python
@@ -532,17 +652,37 @@ class AttachmentsService(FolderContext, BaseService):
                 print("Attachment deleted successfully")
             ```
         """
-        spec = self._delete_attachment_spec(
-            key=key,
-            folder_key=folder_key,
-            folder_path=folder_path,
-        )
+        try:
+            spec = self._delete_attachment_spec(
+                key=key,
+                folder_key=folder_key,
+                folder_path=folder_path,
+            )
 
-        await self.request_async(
-            spec.method,
-            url=spec.endpoint,
-            headers=spec.headers,
-        )
+            await self.request_async(
+                spec.method,
+                url=spec.endpoint,
+                headers=spec.headers,
+            )
+        except Exception as e:
+            # If not found in UiPath, check local storage
+            if "404" in str(e):
+                # Check if file exists in temp directory
+                if os.path.exists(self._temp_dir):
+                    # Look for any file starting with our UUID
+                    pattern = f"{key}_*"
+                    matching_files = list(Path(self._temp_dir).glob(pattern))
+
+                    if matching_files:
+                        # Delete all matching files
+                        for file_path in matching_files:
+                            os.remove(file_path)
+                        return
+
+            # Re-raise the original exception if we can't find it locally
+            raise Exception(
+                f"Attachment with key {key} not found in UiPath or local storage"
+            ) from e
 
     @property
     def custom_headers(self) -> Dict[str, str]:

{uipath-2.0.57 → uipath-2.0.59}/src/uipath/_services/context_grounding_service.py

@@ -3,6 +3,7 @@ from typing import Any, List, Optional, Tuple, Union
 
 import httpx
 from pydantic import TypeAdapter
+from typing_extensions import deprecated
 
 from .._config import Config
 from .._execution_context import ExecutionContext
@@ -234,6 +235,7 @@ class ContextGroundingService(FolderContext, BaseService):
             raise Exception("ContextGroundingIndex not found") from e
 
     @traced(name="contextgrounding_retrieve_by_id", run_type="uipath")
+    @deprecated("Use retrieve instead")
     def retrieve_by_id(
         self,
         id: str,
@@ -266,6 +268,7 @@ class ContextGroundingService(FolderContext, BaseService):
         ).json()
 
     @traced(name="contextgrounding_retrieve_by_id", run_type="uipath")
+    @deprecated("Use retrieve_async instead")
     async def retrieve_by_id_async(
         self,
         id: str,
@@ -656,11 +659,11 @@ class ContextGroundingService(FolderContext, BaseService):
 
     def _resolve_folder_key(self, folder_key, folder_path):
         if folder_key is None and folder_path is not None:
-            folder_key = self._folders_service.retrieve_key_by_folder_path(folder_path)
+            folder_key = self._folders_service.retrieve_key(folder_path=folder_path)
 
         if folder_key is None and folder_path is None:
             folder_key = self._folder_key or (
-                self._folders_service.retrieve_key_by_folder_path(self._folder_path)
+                self._folders_service.retrieve_key(folder_path=self._folder_path)
                 if self._folder_path
                 else None
             )

{uipath-2.0.57 → uipath-2.0.59}/src/uipath/_services/folder_service.py

@@ -1,5 +1,7 @@
 from typing import Optional
 
+from typing_extensions import deprecated
+
 from uipath.tracing._traced import traced
 
 from .._config import Config
@@ -8,20 +10,6 @@ from .._utils import Endpoint, RequestSpec
 from ._base_service import BaseService
 
 
-def _retrieve_spec(folder_path: str) -> RequestSpec:
-    folder_name = folder_path.split("/")[-1]
-    return RequestSpec(
-        method="GET",
-        endpoint=Endpoint(
-            "orchestrator_/api/FoldersNavigation/GetFoldersForCurrentUser"
-        ),
-        params={
-            "searchText": folder_name,
-            "take": 1,
-        },
-    )
-
-
 class FolderService(BaseService):
     """Service for managing UiPath Folders.
 
@@ -34,8 +22,13 @@ class FolderService(BaseService):
         super().__init__(config=config, execution_context=execution_context)
 
     @traced(name="folder_retrieve_key_by_folder_path", run_type="uipath")
+    @deprecated("Use retrieve_key instead")
     def retrieve_key_by_folder_path(self, folder_path: str) -> Optional[str]:
-        spec = _retrieve_spec(folder_path)
+        return self.retrieve_key(folder_path=folder_path)
+
+    @traced(name="folder_retrieve_key", run_type="uipath")
+    def retrieve_key(self, *, folder_path: str) -> Optional[str]:
+        spec = self._retrieve_spec(folder_path)
         response = self.request(
             spec.method,
             url=spec.endpoint,
@@ -50,3 +43,16 @@ class FolderService(BaseService):
             ),
             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"
+            ),
+            params={
+                "searchText": folder_name,
+                "take": 1,
+            },
+        )