uipath 2.0.59__tar.gz → 2.0.61__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.59
+Version: 2.0.61
 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.61/docs/hooks.py

@@ -0,0 +1,20 @@
+import os
+import re
+import shutil
+
+
+def on_pre_build(config):
+    if not os.path.exists("docs/quick_start_images"):
+        shutil.copy(
+            "docs/plugins/uipath-langchain-python/docs/quick_start.md", "docs/index.md"
+        )
+        shutil.copytree(
+            "docs/plugins/uipath-langchain-python/docs/quick_start_images",
+            "docs/quick_start_images",
+        )
+
+
+def on_post_page(output, page, config):
+    pattern = r"(<body[^>]*>)"
+    replacement = rf"\1\n<noscript><iframe src='https://www.googletagmanager.com/ns.html?id={config['google_tag_manager_id']}' height='0' width='0' style='display:none;visibility:hidden'></iframe></noscript>"
+    return re.sub(pattern, replacement, output)

uipath-2.0.61/docs/overrides/main.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+<!-- Google Tag Manager -->
+<script>(function (w, d, s, l, i) {
+        w[l] = w[l] || []; w[l].push({
+            'gtm.start':
+                new Date().getTime(), event: 'gtm.js'
+        }); var f = d.getElementsByTagName(s)[0],
+            j = d.createElement(s), dl = l != 'dataLayer' ? '&l=' + l : ''; j.async = true; j.src =
+                'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f);
+    })(window, document, 'script', 'dataLayer', '{{ config.google_tag_manager_id }}');</script>
+<!-- End Google Tag Manager -->
+{% endblock %}

{uipath-2.0.59 → uipath-2.0.61}/mkdocs.yml

@@ -12,6 +12,8 @@ extra_css:
 extra_javascript:
   - javascripts/extra.js
 
+google_tag_manager_id: GTM-PLLP8P
+
 theme:
   name: material
   custom_dir: docs/overrides
@@ -96,7 +98,8 @@ plugins:
             show_bases: false
   - mkdocs-simple-hooks:
       hooks:
-        on_pre_build: "docs.hooks:redirect_index"
+        on_pre_build: "docs.hooks:on_pre_build"
+        on_post_page: "docs.hooks:on_post_page"
   - termynal:
       prompt_literal_start:
         - "$"

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

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.59"
+version = "2.0.61"
 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.61/src/uipath/_cli/_utils/_constants.py

@@ -0,0 +1 @@
+BINDINGS_VERSION = "2.2"

{uipath-2.0.59 → uipath-2.0.61}/src/uipath/_cli/_utils/_parse_ast.py

@@ -3,10 +3,16 @@
 import ast
 import os
 from dataclasses import dataclass, field
-from typing import Any, Dict, List, Optional
-
-from ..._services import AssetsService, BucketsService, ProcessesService
+from typing import Any, Dict, List, Optional, Tuple
+
+from ..._services import (
+    AssetsService,
+    BucketsService,
+    ContextGroundingService,
+    ProcessesService,
+)
 from ..._utils import get_inferred_bindings_names
+from ._constants import BINDINGS_VERSION
 
 
 @dataclass
@@ -33,6 +39,14 @@ service_name_resource_mapping = {
     "processes": "process",
     "buckets": "bucket",
     "connections": "connection",
+    "context_grounding": "index",
+}
+
+supported_bindings_by_service = {
+    "assets": AssetsService,
+    "processes": ProcessesService,
+    "buckets": BucketsService,
+    "context_grounding": ContextGroundingService,
 }
 
 
@@ -67,48 +81,10 @@ class ServiceUsage:
     def get_component_info(self) -> List[Dict[str, str]]:
         """Extract component names and folders based on the service type."""
         result = []
-
-        if self.service_name == "assets":
-            for call in self.method_calls:
-                inferred_bindings = get_inferred_bindings_names(AssetsService)
-                if call.method_name in inferred_bindings:
-                    name = extract_parameter(
-                        call, inferred_bindings[call.method_name]["name"], 0
-                    )
-                    folder_path = extract_parameter(
-                        call, inferred_bindings[call.method_name]["folder_path"]
-                    )
-                    if name:
-                        result.append(
-                            {
-                                "name": name,
-                                "folder": folder_path or "",
-                                "method": call.method_name,
-                            }
-                        )
-
-        elif self.service_name == "processes":
-            for call in self.method_calls:
-                inferred_bindings = get_inferred_bindings_names(ProcessesService)
-                if call.method_name in inferred_bindings:
-                    name = extract_parameter(
-                        call, inferred_bindings[call.method_name]["name"], 0
-                    )
-                    folder_path = extract_parameter(
-                        call, inferred_bindings[call.method_name]["folder_path"]
-                    )
-                    if name:
-                        result.append(
-                            {
-                                "name": name,
-                                "folder": folder_path or "",
-                                "method": call.method_name,
-                            }
-                        )
-
-        elif self.service_name == "buckets":
+        has_support, service_cls = self._support_for_bindings_inference()
+        if has_support:
             for call in self.method_calls:
-                inferred_bindings = get_inferred_bindings_names(BucketsService)
+                inferred_bindings = get_inferred_bindings_names(service_cls)
                 if call.method_name in inferred_bindings:
                     name = extract_parameter(
                         call, inferred_bindings[call.method_name]["name"], 0
@@ -125,9 +101,9 @@ class ServiceUsage:
                             }
                         )
 
+        # custom logic for connections bindings
         elif self.service_name == "connections":
             for call in self.method_calls:
-                connection_id = None
                 if len(call.args) > 0:
                     connection_id = call.args[0]
                     if connection_id:
@@ -141,6 +117,12 @@ class ServiceUsage:
 
         return result
 
+    def _support_for_bindings_inference(self) -> Tuple[bool, Any]:
+        return (
+            self.service_name in supported_bindings_by_service,
+            supported_bindings_by_service.get(self.service_name, None),
+        )
+
 
 def extract_parameter(
     method_call: ServiceMethodCall,
@@ -462,11 +444,10 @@ def convert_to_bindings_format(sdk_usage_data):
                             "defaultValue": connection_id,
                             "isExpression": is_connection_id_expression,
                             "displayName": "Connection",
-                            "description": "The connection to be used",
                         }
                     },
                     "metadata": {
-                        "BindingsVersion": "2.1",
+                        "BindingsVersion": BINDINGS_VERSION,
                         "Connector": connector_name,
                         "UseConnectionService": "True",
                     },
@@ -500,7 +481,7 @@ def convert_to_bindings_format(sdk_usage_data):
                 },
                 "metadata": {
                     "ActivityName": method_name,
-                    "BindingsVersion": "2.1",
+                    "BindingsVersion": BINDINGS_VERSION,
                     "DisplayLabel": "FullName",
                 },
             }

{uipath-2.0.59 → uipath-2.0.61}/src/uipath/_cli/cli_init.py

@@ -6,6 +6,7 @@ from pathlib import Path
 from typing import Optional
 
 import click
+from dotenv import load_dotenv
 
 from ..telemetry import track
 from ._utils._console import ConsoleLogger
@@ -56,6 +57,9 @@ def get_user_script(directory: str, entrypoint: Optional[str] = None) -> Optiona
 @track
 def init(entrypoint: str) -> None:
     """Create uipath.json with input/output schemas and bindings."""
+    current_path = os.getcwd()
+    load_dotenv(os.path.join(current_path, ".env"), override=True)
+
     with console.spinner("Initializing UiPath project ..."):
         current_directory = os.getcwd()
         generate_env_file(current_directory)

{uipath-2.0.59 → uipath-2.0.61}/src/uipath/_services/assets_service.py

@@ -6,7 +6,7 @@ from .._config import Config
 from .._execution_context import ExecutionContext
 from .._folder_context import FolderContext
 from .._utils import Endpoint, RequestSpec, header_folder, infer_bindings
-from .._utils._read_overwrites import OverwritesManager, read_resource_overwrites
+from .._utils._read_overwrites import OverwritesManager
 from ..models import Asset, UserAsset
 from ..tracing._traced import traced
 from ._base_service import BaseService
@@ -24,10 +24,10 @@ class AssetsService(FolderContext, BaseService):
         self._overwrites_manager = OverwritesManager()
         self._base_url = "assets"
 
-    @infer_bindings()
     @traced(
         name="assets_retrieve", run_type="uipath", hide_input=True, hide_output=True
     )
+    @infer_bindings(resource_type="asset")
     def retrieve(
         self,
         name: str,
@@ -61,31 +61,28 @@ class AssetsService(FolderContext, BaseService):
         except ValueError:
             is_user = False
 
-        with read_resource_overwrites("asset", name, folder_path) as (
-            overwritten_name,
-            overwritten_folder_path,
-        ):
-            spec = self._retrieve_spec(
-                overwritten_name,
-                folder_key=folder_key,
-                folder_path=overwritten_folder_path,
-            )
-            response = self.request(
-                spec.method,
-                url=spec.endpoint,
-                params=spec.params,
-                content=spec.content,
-                headers=spec.headers,
-            )
+        spec = self._retrieve_spec(
+            name,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
+        response = self.request(
+            spec.method,
+            url=spec.endpoint,
+            params=spec.params,
+            content=spec.content,
+            headers=spec.headers,
+        )
 
-            if is_user:
-                return UserAsset.model_validate(response.json())
-            else:
-                return Asset.model_validate(response.json()["value"][0])
+        if is_user:
+            return UserAsset.model_validate(response.json())
+        else:
+            return Asset.model_validate(response.json()["value"][0])
 
     @traced(
         name="assets_retrieve", run_type="uipath", hide_input=True, hide_output=True
     )
+    @infer_bindings(resource_type="asset")
     async def retrieve_async(
         self,
         name: str,
@@ -110,32 +107,28 @@ class AssetsService(FolderContext, BaseService):
         except ValueError:
             is_user = False
 
-        with read_resource_overwrites("asset", name, folder_path) as (
-            overwritten_name,
-            overwritten_folder_path,
-        ):
-            spec = self._retrieve_spec(
-                overwritten_name,
-                folder_key=folder_key,
-                folder_path=overwritten_folder_path,
-            )
-            response = await self.request_async(
-                spec.method,
-                url=spec.endpoint,
-                params=spec.params,
-                content=spec.content,
-                headers=spec.headers,
-            )
+        spec = self._retrieve_spec(
+            name,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
+        response = await self.request_async(
+            spec.method,
+            url=spec.endpoint,
+            params=spec.params,
+            content=spec.content,
+            headers=spec.headers,
+        )
 
-            if is_user:
-                return UserAsset.model_validate(response.json())
-            else:
-                return Asset.model_validate(response.json()["value"][0])
+        if is_user:
+            return UserAsset.model_validate(response.json())
+        else:
+            return Asset.model_validate(response.json()["value"][0])
 
-    @infer_bindings()
     @traced(
         name="assets_credential", run_type="uipath", hide_input=True, hide_output=True
     )
+    @infer_bindings(resource_type="asset")
     def retrieve_credential(
         self,
         name: str,
@@ -168,31 +161,27 @@ class AssetsService(FolderContext, BaseService):
         if not is_user:
             raise ValueError("This method can only be used for robot assets.")
 
-        with read_resource_overwrites("asset", name, folder_path) as (
-            overwritten_name,
-            overwritten_folder_path,
-        ):
-            spec = self._retrieve_spec(
-                overwritten_name,
-                folder_key=folder_key,
-                folder_path=overwritten_folder_path,
-            )
+        spec = self._retrieve_spec(
+            name,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
 
-            response = self.request(
-                spec.method,
-                url=spec.endpoint,
-                content=spec.content,
-                headers=spec.headers,
-            )
+        response = self.request(
+            spec.method,
+            url=spec.endpoint,
+            content=spec.content,
+            headers=spec.headers,
+        )
 
-            user_asset = UserAsset.model_validate(response.json())
+        user_asset = UserAsset.model_validate(response.json())
 
-            return user_asset.credential_password
+        return user_asset.credential_password
 
-    @infer_bindings()
     @traced(
         name="assets_credential", run_type="uipath", hide_input=True, hide_output=True
     )
+    @infer_bindings(resource_type="asset")
     async def retrieve_credential_async(
         self,
         name: str,
@@ -225,26 +214,22 @@ class AssetsService(FolderContext, BaseService):
         if not is_user:
             raise ValueError("This method can only be used for robot assets.")
 
-        with read_resource_overwrites("asset", name, folder_path) as (
-            overwritten_name,
-            overwritten_folder_path,
-        ):
-            spec = self._retrieve_spec(
-                overwritten_name,
-                folder_key=folder_key,
-                folder_path=overwritten_folder_path,
-            )
+        spec = self._retrieve_spec(
+            name,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
 
-            response = await self.request_async(
-                spec.method,
-                url=spec.endpoint,
-                content=spec.content,
-                headers=spec.headers,
-            )
+        response = await self.request_async(
+            spec.method,
+            url=spec.endpoint,
+            content=spec.content,
+            headers=spec.headers,
+        )
 
-            user_asset = UserAsset.model_validate(response.json())
+        user_asset = UserAsset.model_validate(response.json())
 
-            return user_asset.credential_password
+        return user_asset.credential_password
 
     @traced(name="assets_update", run_type="uipath", hide_input=True, hide_output=True)
     def update(
@@ -275,22 +260,18 @@ class AssetsService(FolderContext, BaseService):
         if not is_user:
             raise ValueError("This method can only be used for robot assets.")
 
-        with read_resource_overwrites("asset", robot_asset.name or "", folder_path) as (
-            overwritten_name,
-            overwritten_folder_path,
-        ):
-            spec = self._update_spec(
-                robot_asset, folder_key=folder_key, folder_path=overwritten_folder_path
-            )
+        spec = self._update_spec(
+            robot_asset, folder_key=folder_key, folder_path=folder_path
+        )
 
-            response = self.request(
-                spec.method,
-                url=spec.endpoint,
-                content=spec.content,
-                headers=spec.headers,
-            )
+        response = self.request(
+            spec.method,
+            url=spec.endpoint,
+            content=spec.content,
+            headers=spec.headers,
+        )
 
-            return response.json()
+        return response.json()
 
     @traced(name="assets_update", run_type="uipath", hide_input=True, hide_output=True)
     async def update_async(
@@ -310,22 +291,18 @@ class AssetsService(FolderContext, BaseService):
         Returns:
             Response: The HTTP response confirming the update.
         """
-        with read_resource_overwrites("asset", robot_asset.name or "", folder_path) as (
-            overwritten_name,
-            overwritten_folder_path,
-        ):
-            spec = self._update_spec(
-                robot_asset, folder_key=folder_key, folder_path=overwritten_folder_path
-            )
+        spec = self._update_spec(
+            robot_asset, folder_key=folder_key, folder_path=folder_path
+        )
 
-            response = await self.request_async(
-                spec.method,
-                url=spec.endpoint,
-                content=spec.content,
-                headers=spec.headers,
-            )
+        response = await self.request_async(
+            spec.method,
+            url=spec.endpoint,
+            content=spec.content,
+            headers=spec.headers,
+        )
 
-            return response.json()
+        return response.json()
 
     @property
     def custom_headers(self) -> Dict[str, str]:

{uipath-2.0.59 → uipath-2.0.61}/src/uipath/_services/buckets_service.py

@@ -29,6 +29,7 @@ class BucketsService(FolderContext, BaseService):
         self.custom_client_async = httpx.AsyncClient()
 
     @traced(name="buckets_download", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
     def download(
         self,
         *,
@@ -83,7 +84,70 @@ class BucketsService(FolderContext, BaseService):
                 file_content = self.custom_client.get(read_uri, headers=headers).content
             file.write(file_content)
 
+    @traced(name="buckets_download", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
+    async def download_async(
+        self,
+        *,
+        name: Optional[str] = None,
+        key: Optional[str] = None,
+        blob_file_path: str,
+        destination_path: str,
+        folder_key: Optional[str] = None,
+        folder_path: Optional[str] = None,
+    ) -> None:
+        """Download a file from a bucket asynchronously.
+
+        Args:
+            key (Optional[str]): The key of the bucket.
+            name (Optional[str]): The name of the bucket.
+            blob_file_path (str): The path to the file in the bucket.
+            destination_path (str): The local path where the file will be saved.
+            folder_key (Optional[str]): The key of the folder where the bucket resides.
+            folder_path (Optional[str]): The path of the folder where the bucket resides.
+
+        Raises:
+            ValueError: If neither key nor name is provided.
+            Exception: If the bucket with the specified key is not found.
+        """
+        bucket = await self.retrieve_async(
+            name=name, key=key, folder_key=folder_key, folder_path=folder_path
+        )
+        spec = self._retrieve_readUri_spec(
+            bucket.id, blob_file_path, 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()
+
+        read_uri = result["Uri"]
+
+        headers = {
+            key: value
+            for key, value in zip(
+                result["Headers"]["Keys"], result["Headers"]["Values"], strict=False
+            )
+        }
+
+        with open(destination_path, "wb") as file:
+            # the self.request adds auth bearer token
+            if result["RequiresAuth"]:
+                file_content = (
+                    await self.request_async("GET", read_uri, headers=headers)
+                ).content
+            else:
+                file_content = (
+                    await self.custom_client_async.get(read_uri, headers=headers)
+                ).content
+            file.write(file_content)
+
     @traced(name="buckets_upload", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
     def upload(
         self,
         *,
@@ -166,6 +230,7 @@ class BucketsService(FolderContext, BaseService):
                     )
 
     @traced(name="buckets_upload", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
     async def upload_async(
         self,
         *,
@@ -252,8 +317,8 @@ class BucketsService(FolderContext, BaseService):
                         write_uri, headers=headers, files={"file": file}
                     )
 
-    @infer_bindings()
     @traced(name="buckets_retrieve", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
     def retrieve(
         self,
         *,
@@ -300,8 +365,8 @@ class BucketsService(FolderContext, BaseService):
             raise Exception(f"Bucket with name '{name}' not found") from e
         return Bucket.model_validate(response)
 
-    @infer_bindings()
     @traced(name="buckets_retrieve", run_type="uipath")
+    @infer_bindings(resource_type="bucket")
     async def retrieve_async(
         self,
         *,
@@ -372,7 +437,7 @@ class BucketsService(FolderContext, BaseService):
 
     def _retrieve_readUri_spec(
         self,
-        bucket_id: str,
+        bucket_id: int,
         blob_file_path: str,
         folder_key: Optional[str] = None,
         folder_path: Optional[str] = None,
@@ -390,7 +455,7 @@ class BucketsService(FolderContext, BaseService):
 
     def _retrieve_writeri_spec(
         self,
-        bucket_id: str,
+        bucket_id: int,
         content_type: str,
         blob_file_path: str,
         folder_key: Optional[str] = None,

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

@@ -8,7 +8,7 @@ from typing_extensions import deprecated
 from .._config import Config
 from .._execution_context import ExecutionContext
 from .._folder_context import FolderContext
-from .._utils import Endpoint, RequestSpec, header_folder
+from .._utils import Endpoint, RequestSpec, header_folder, infer_bindings
 from .._utils.constants import (
     ORCHESTRATOR_STORAGE_BUCKET_DATA_SOURCE,
 )
@@ -46,6 +46,7 @@ class ContextGroundingService(FolderContext, BaseService):
         super().__init__(config=config, execution_context=execution_context)
 
     @traced(name="add_to_index", run_type="uipath")
+    @infer_bindings(resource_type="index")
     def add_to_index(
         self,
         name: str,
@@ -96,6 +97,7 @@ class ContextGroundingService(FolderContext, BaseService):
         self.ingest_data(index, folder_key=folder_key, folder_path=folder_path)
 
     @traced(name="add_to_index", run_type="uipath")
+    @infer_bindings(resource_type="index")
     async def add_to_index_async(
         self,
         name: str,
@@ -151,6 +153,7 @@ class ContextGroundingService(FolderContext, BaseService):
         )
 
     @traced(name="contextgrounding_retrieve", run_type="uipath")
+    @infer_bindings(resource_type="index")
     def retrieve(
         self,
         name: str,
@@ -192,6 +195,7 @@ class ContextGroundingService(FolderContext, BaseService):
             raise Exception("ContextGroundingIndex not found") from e
 
     @traced(name="contextgrounding_retrieve", run_type="uipath")
+    @infer_bindings(resource_type="index")
     async def retrieve_async(
         self,
         name: str,