UiPath Core Abstractions

0.5.11 · active · verified Wed Apr 15

uipath-core is a foundational Python library providing core abstractions for the UiPath Python SDK. It encapsulates fundamental components like common exceptions, versioning, and registry mechanisms that underpin the broader UiPath automation and AI ecosystem. As of version 0.5.11, it serves as a dependency for higher-level UiPath libraries, offering essential building blocks for integration and development. Its release cadence is tied to the main UiPath Python SDK.

Warnings

breaking The `platform` module, which previously provided core functionalities, was extracted into a separate `uipath-platform` library starting with `uipath-python` SDK v2.9.0. If your application or custom `uipath-core` extensions relied on direct imports from `uipath.platform`, these imports will now fail unless `uipath-platform` is explicitly installed and imports are updated.
Fix: Explicitly install `uipath-platform` (`pip install uipath-platform`) and update any direct `uipath.platform` imports to reflect its new package structure if necessary. Review the `uipath-python` SDK v2.9.0 migration guide for full details.
breaking Core 'context grounding' contracts underwent significant changes in `uipath-python` SDK v2.9.0. Specific fields like `PreProcessing` and `Fields` were removed, while `extraction_strategy`, `embeddings_enabled`, and `is_encrypted` were added. This impacts any code that interacts with or extends UiPath's context grounding mechanisms, potentially including custom components built using `uipath-core` abstractions.
Fix: Review the `uipath-python` SDK v2.9.0 migration guide for updated context grounding contract details and adapt your code accordingly. Ensure any custom data structures or interfaces align with the new contract.
gotcha `uipath-core` provides low-level abstractions and foundational components. It is not intended for direct interaction with high-level UiPath SDK functionalities such as orchestrator communication, AI functions, or RPA process execution. Attempting to find or use such features directly from `uipath-core` will result in `AttributeError` or `ImportError`.
Fix: For high-level SDK operations, use the main `uipath` package (e.g., `pip install uipath`) and refer to its documentation for specific modules like `uipath.functions` or `uipath.orchestrator`.

Install

pip install uipath-core Install `uipath-core`

Imports

UiPathError

wrong:

from uipath.exceptions import UiPathError

correct:

from uipath.core.exceptions import UiPathError

UiPathError is located within the core sub-package.

Quickstart

This example demonstrates how to import and handle a foundational exception from `uipath-core`, showcasing its role in providing core abstractions for custom components.

from uipath.core.exceptions import UiPathError

class CustomUiPathComponent:
    def __init__(self, name):
        self.name = name

    def execute(self, should_fail: bool):
        if should_fail:
            raise UiPathError(f"Component '{self.name}' failed to execute.")
        return f"Component '{self.name}' executed successfully."

try:
    component = CustomUiPathComponent("MyProcessor")
    print(component.execute(False))
    print(component.execute(True))
except UiPathError as e:
    print(f"Caught expected UiPathError: {e}")

view raw JSON →