uipath-core 0.1.5__tar.gz → 0.1.6__tar.gz

{uipath_core-0.1.5 → uipath_core-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath-core
-Version: 0.1.5
+Version: 0.1.6
 Summary: UiPath Core abstractions
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-core-python

{uipath_core-0.1.5 → uipath_core-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-core"
-version = "0.1.5"
+version = "0.1.6"
 description = "UiPath Core abstractions"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

{uipath_core-0.1.5 → uipath_core-0.1.6}/src/uipath/core/guardrails/__init__.py

@@ -16,6 +16,7 @@ from .guardrails import (
     GuardrailScope,
     GuardrailSelector,
     GuardrailValidationResult,
+    GuardrailValidationResultType,
     NumberRule,
     Rule,
     SelectorType,
@@ -43,4 +44,5 @@ __all__ = [
     "GuardrailScope",
     "GuardrailSelector",
     "GuardrailValidationResult",
+    "GuardrailValidationResultType",
 ]

{uipath_core-0.1.5 → uipath_core-0.1.6}/src/uipath/core/guardrails/_deterministic_guardrails_service.py

@@ -16,6 +16,7 @@ from .guardrails import (
     DeterministicGuardrail,
     FieldSource,
     GuardrailValidationResult,
+    GuardrailValidationResultType,
     NumberRule,
     SpecificFieldsSelector,
     UniversalRule,
@@ -38,7 +39,7 @@ class DeterministicGuardrailsService(BaseModel):
         # Output rules will be evaluated during post-execution
         if has_output_rule:
             return GuardrailValidationResult(
-                validation_passed=True,
+                result=GuardrailValidationResultType.PASSED,
                 reason="Guardrail contains output-dependent rules that will be evaluated during post-execution",
             )
         return self._evaluate_deterministic_guardrail(
@@ -64,7 +65,7 @@ class DeterministicGuardrailsService(BaseModel):
         # Only input rules exist and they should have been evaluated during pre-execution
         if not has_output_rule:
             return GuardrailValidationResult(
-                validation_passed=True,
+                result=GuardrailValidationResultType.PASSED,
                 reason="Guardrail contains only input-dependent rules that were evaluated during pre-execution",
             )
 
@@ -128,15 +129,17 @@ class DeterministicGuardrailsService(BaseModel):
                 passed, reason = evaluate_universal_rule(rule, output_data)
             else:
                 return GuardrailValidationResult(
-                    validation_passed=False,
+                    result=GuardrailValidationResultType.VALIDATION_FAILED,
                     reason=f"Unknown rule type: {type(rule)}",
                 )
 
             if not passed:
                 return GuardrailValidationResult(
-                    validation_passed=False, reason=reason or "Rule validation failed"
+                    result=GuardrailValidationResultType.VALIDATION_FAILED,
+                    reason=reason or "Rule validation failed",
                 )
 
         return GuardrailValidationResult(
-            validation_passed=True, reason="All deterministic guardrail rules passed"
+            result=GuardrailValidationResultType.PASSED,
+            reason="All deterministic guardrail rules passed",
         )

{uipath_core-0.1.5 → uipath_core-0.1.6}/src/uipath/core/guardrails/_evaluators.py

@@ -288,13 +288,13 @@ def evaluate_universal_rule(
 
     Universal rules trigger based on the apply_to scope and execution phase:
     - Pre-execution (empty output_data):
-      - INPUT: triggers (validation_passed = False)
-      - OUTPUT: does not trigger (validation_passed = True)
-      - INPUT_AND_OUTPUT: triggers (validation_passed = False)
+      - INPUT: triggers (result = VALIDATION_FAILED)
+      - OUTPUT: does not trigger (result = PASSED)
+      - INPUT_AND_OUTPUT: triggers (result = VALIDATION_FAILED)
     - Post-execution (output_data has data):
-      - INPUT: does not trigger (validation_passed = True)
-      - OUTPUT: triggers (validation_passed = False)
-      - INPUT_AND_OUTPUT: triggers (validation_passed = False)
+      - INPUT: does not trigger (result = PASSED)
+      - OUTPUT: triggers (result = VALIDATION_FAILED)
+      - INPUT_AND_OUTPUT: triggers (result = VALIDATION_FAILED)
     """
     # Determine if this is pre-execution (no output data) or post-execution
     is_pre_execution = not output_data or len(output_data) == 0

{uipath_core-0.1.5 → uipath_core-0.1.6}/src/uipath/core/guardrails/guardrails.py

@@ -6,18 +6,27 @@ from typing import Annotated, Callable, Literal
 from pydantic import BaseModel, ConfigDict, Field
 
 
+class GuardrailValidationResultType(str, Enum):
+    """Guardrail validation result type enumeration."""
+
+    PASSED = "passed"
+    VALIDATION_FAILED = "validation_failed"
+    ENTITLEMENTS_MISSING = "entitlements_missing"
+    FEATURE_DISABLED = "feature_disabled"
+
+
 class GuardrailValidationResult(BaseModel):
     """Result returned from validating input with a given guardrail.
 
     Attributes:
-        validation_passed: Indicates whether the input data passed the guardrail validation.
+        result: The validation result type.
         reason: Textual explanation describing why the validation passed or failed.
     """
 
     model_config = ConfigDict(populate_by_name=True)
 
-    validation_passed: bool = Field(
-        alias="validation_passed", description="Whether the input passed validation."
+    result: GuardrailValidationResultType = Field(
+        alias="result", description="Validation result."
     )
     reason: str = Field(
         alias="reason", description="Explanation for the validation result."

{uipath_core-0.1.5 → uipath_core-0.1.6}/tests/guardrails/test_deterministic_guardrails_service.py

@@ -13,6 +13,7 @@ from uipath.core.guardrails import (
     FieldSource,
     GuardrailScope,
     GuardrailSelector,
+    GuardrailValidationResultType,
     NumberRule,
     SpecificFieldsSelector,
     UniversalRule,
@@ -79,7 +80,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert (
             result.reason
             == "Guardrail contains only input-dependent rules that were evaluated during pre-execution"
@@ -145,7 +146,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
         assert (
             result.reason
             == "Input data didn't match the guardrail condition: [age] comparing function [(n): n < 21.0]"
@@ -213,7 +214,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
         assert (
             result.reason
             == "Input data didn't match the guardrail condition: [isActive] comparing function [(b): b is not True]"
@@ -259,7 +260,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert (
             result.reason
             == "Guardrail contains only input-dependent rules that were evaluated during pre-execution"
@@ -317,7 +318,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
         assert (
             result.reason
             == 'Input data didn\'t match the guardrail condition: [userName] comparing function [(s): not bool(re.search(".*te.*3.*", s))]'
@@ -363,7 +364,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert (
             result.reason
             == "Guardrail contains only input-dependent rules that were evaluated during pre-execution"
@@ -421,7 +422,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_evaluate_post_deterministic_guardrail_word_contains_substring_detects_violation(
         self,
@@ -475,7 +476,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
         assert (
             result.reason
             == 'Input data didn\'t match the guardrail condition: [userName] comparing function [(s): "dre" in s]'
@@ -519,7 +520,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert (
             result.reason
             == "Guardrail contains only input-dependent rules that were evaluated during pre-execution"
@@ -575,7 +576,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_should_trigger_policy_pre_execution_only_some_rules_not_met_returns_false(
         self,
@@ -598,7 +599,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_should_ignore_post_execution_guardrail_for_pre_execution_returns_false(
         self,
@@ -620,7 +621,7 @@ class TestDeterministicGuardrailsService:
         )
 
         # Should fail because post-execution guardrail needs output data
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_post_execution_guardrail_for_pre_execution_returns_false(
         self,
@@ -646,7 +647,7 @@ class TestDeterministicGuardrailsService:
         )
 
         # Pre-execution guardrail should still pass in post-execution
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_post_execution_with_output_fields_all_conditions_met_returns_true(
         self,
@@ -671,7 +672,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_post_execution_with_output_fields_input_conditions_not_met_returns_false(
         self,
@@ -696,7 +697,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_should_trigger_policy_post_execution_with_output_fields_output_conditions_not_met_returns_false(
         self,
@@ -721,7 +722,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_should_trigger_policy_post_execution_multiple_rules_all_conditions_must_be_met_returns_true(
         self,
@@ -746,7 +747,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_post_execution_rule_with_multiple_conditions_all_must_be_met_returns_true(
         self,
@@ -771,7 +772,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_post_execution_rule_with_multiple_conditions_one_condition_not_met_returns_false(
         self,
@@ -796,7 +797,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_should_trigger_policy_post_execution_with_all_fields_selector_output_schema_has_fields_returns_true(
         self,
@@ -840,7 +841,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_post_execution_with_all_fields_selector_empty_output_schema_returns_true(
         self,
@@ -880,7 +881,7 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def test_should_trigger_policy_pre_execution_always_rule_with_input_apply_to_returns_true(
         self,
@@ -899,7 +900,9 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False  # Should trigger
+        assert (
+            result.result == GuardrailValidationResultType.VALIDATION_FAILED
+        )  # Should trigger
 
     def test_should_trigger_policy_pre_execution_always_rule_with_output_apply_to_returns_false(
         self,
@@ -920,7 +923,9 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True  # Should not trigger
+        assert (
+            result.result == GuardrailValidationResultType.PASSED
+        )  # Should not trigger
 
     def test_should_trigger_policy_pre_execution_always_rule_with_input_and_output_apply_to_returns_true(
         self,
@@ -941,7 +946,9 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False  # Should trigger
+        assert (
+            result.result == GuardrailValidationResultType.VALIDATION_FAILED
+        )  # Should trigger
 
     def test_should_trigger_policy_post_execution_always_rule_with_input_apply_to_returns_false(
         self,
@@ -966,7 +973,9 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is True  # Should not trigger
+        assert (
+            result.result == GuardrailValidationResultType.PASSED
+        )  # Should not trigger
 
     def test_should_trigger_policy_post_execution_always_rule_with_output_apply_to_returns_true(
         self,
@@ -991,7 +1000,9 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False  # Should trigger
+        assert (
+            result.result == GuardrailValidationResultType.VALIDATION_FAILED
+        )  # Should trigger
 
     def test_should_trigger_policy_post_execution_always_rule_with_input_and_output_apply_to_returns_true(
         self,
@@ -1016,7 +1027,9 @@ class TestDeterministicGuardrailsService:
             guardrail=guardrail,
         )
 
-        assert result.validation_passed is False  # Should trigger
+        assert (
+            result.result == GuardrailValidationResultType.VALIDATION_FAILED
+        )  # Should trigger
 
         # Helper methods to create guardrails
 
@@ -1226,7 +1239,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert (
             result.reason
             == "Guardrail contains only input-dependent rules that were evaluated during pre-execution"
@@ -1284,7 +1297,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert result.reason == "All deterministic guardrail rules passed"
 
     def test_evaluate_post_deterministic_guardrail_only_always_rule_fails(
@@ -1322,7 +1335,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is False
+        assert result.result == GuardrailValidationResultType.VALIDATION_FAILED
 
     def test_evaluate_post_deterministic_guardrail_only_input_rules_passes(
         self,
@@ -1370,7 +1383,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
         assert (
             result.reason
             == "Guardrail contains only input-dependent rules that were evaluated during pre-execution"
@@ -1434,7 +1447,7 @@ class TestDeterministicGuardrailsService:
             guardrail=deterministic_guardrail,
         )
 
-        assert result.validation_passed is True
+        assert result.result == GuardrailValidationResultType.PASSED
 
     def _create_guardrail_with_always_rule(
         self, apply_to: ApplyTo

{uipath_core-0.1.5 → uipath_core-0.1.6}/uv.lock

@@ -991,7 +991,7 @@ wheels = [
 
 [[package]]
 name = "uipath-core"
-version = "0.1.5"
+version = "0.1.6"
 source = { editable = "." }
 dependencies = [
     { name = "opentelemetry-instrumentation" },