hatchet-sdk 1.16.0__py3-none-any.whl → 1.16.1__py3-none-any.whl

hatchet_sdk/clients/rest/models/v1_cel_debug_error_response.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Self
+
+
+class V1CELDebugErrorResponse(BaseModel):
+    """
+    V1CELDebugErrorResponse
+    """  # noqa: E501
+
+    status: StrictStr
+    error: StrictStr = Field(description="The error message if the evaluation failed")
+    __properties: ClassVar[List[str]] = ["status", "error"]
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["ERROR"]):
+            raise ValueError("must be one of enum values ('ERROR')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V1CELDebugErrorResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1CELDebugErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"status": obj.get("status"), "error": obj.get("error")}
+        )
+        return _obj

hatchet_sdk/clients/rest/models/v1_cel_debug_request.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Self
+
+
+class V1CELDebugRequest(BaseModel):
+    """
+    V1CELDebugRequest
+    """  # noqa: E501
+
+    expression: StrictStr = Field(description="The CEL expression to evaluate")
+    input: Dict[str, Any] = Field(
+        description="The input, which simulates the workflow run input"
+    )
+    filter_payload: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="The filter payload, which simulates a payload set on a previous-created filter",
+        alias="filterPayload",
+    )
+    additional_metadata: Optional[Dict[str, Any]] = Field(
+        default=None,
+        description="Additional metadata, which simulates metadata that could be sent with an event or a workflow run",
+        alias="additionalMetadata",
+    )
+    __properties: ClassVar[List[str]] = [
+        "expression",
+        "input",
+        "filterPayload",
+        "additionalMetadata",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V1CELDebugRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1CELDebugRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "expression": obj.get("expression"),
+                "input": obj.get("input"),
+                "filterPayload": obj.get("filterPayload"),
+                "additionalMetadata": obj.get("additionalMetadata"),
+            }
+        )
+        return _obj

hatchet_sdk/clients/rest/models/v1_cel_debug_response.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing_extensions import Self
+
+from hatchet_sdk.clients.rest.models.v1_cel_debug_response_status import (
+    V1CELDebugResponseStatus,
+)
+
+
+class V1CELDebugResponse(BaseModel):
+    """
+    V1CELDebugResponse
+    """  # noqa: E501
+
+    status: V1CELDebugResponseStatus
+    output: Optional[StrictBool] = Field(
+        default=None,
+        description="The result of the CEL expression evaluation, if successful",
+    )
+    error: Optional[StrictStr] = Field(
+        default=None, description="The error message if the evaluation failed"
+    )
+    __properties: ClassVar[List[str]] = ["status", "output", "error"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V1CELDebugResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1CELDebugResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "status": obj.get("status"),
+                "output": obj.get("output"),
+                "error": obj.get("error"),
+            }
+        )
+        return _obj

hatchet_sdk/clients/rest/models/v1_cel_debug_response_status.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class V1CELDebugResponseStatus(str, Enum):
+    """
+    The status of the CEL evaluation
+    """
+
+    """
+    allowed enum values
+    """
+    SUCCESS = "SUCCESS"
+    ERROR = "ERROR"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of V1CELDebugResponseStatus from a JSON string"""
+        return cls(json.loads(json_str))

hatchet_sdk/clients/rest/models/v1_cel_debug_success_response.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictBool,
+    StrictStr,
+    field_validator,
+)
+from typing_extensions import Self
+
+
+class V1CELDebugSuccessResponse(BaseModel):
+    """
+    V1CELDebugSuccessResponse
+    """  # noqa: E501
+
+    status: StrictStr
+    output: StrictBool = Field(
+        description="The result of the CEL expression evaluation"
+    )
+    __properties: ClassVar[List[str]] = ["status", "output"]
+
+    @field_validator("status")
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["SUCCESS"]):
+            raise ValueError("must be one of enum values ('SUCCESS')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V1CELDebugSuccessResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1CELDebugSuccessResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"status": obj.get("status"), "output": obj.get("output")}
+        )
+        return _obj

hatchet_sdk/clients/rest/models/v1_replayed_tasks.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    Hatchet API
+
+    The Hatchet API
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Annotated, Self
+
+
+class V1ReplayedTasks(BaseModel):
+    """
+    V1ReplayedTasks
+    """  # noqa: E501
+
+    ids: Optional[
+        List[Annotated[str, Field(min_length=36, strict=True, max_length=36)]]
+    ] = Field(
+        default=None, description="The list of task external ids that were replayed"
+    )
+    __properties: ClassVar[List[str]] = ["ids"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of V1ReplayedTasks from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of V1ReplayedTasks from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"ids": obj.get("ids")})
+        return _obj

hatchet_sdk/features/cel.py

@@ -0,0 +1,99 @@
+import asyncio
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from hatchet_sdk.clients.rest.api.cel_api import CELApi
+from hatchet_sdk.clients.rest.api_client import ApiClient
+from hatchet_sdk.clients.rest.models.v1_cel_debug_request import V1CELDebugRequest
+from hatchet_sdk.clients.rest.models.v1_cel_debug_response_status import (
+    V1CELDebugResponseStatus,
+)
+from hatchet_sdk.clients.v1.api_client import BaseRestClient, retry
+from hatchet_sdk.utils.typing import JSONSerializableMapping
+
+
+class CELSuccess(BaseModel):
+    status: Literal["success"] = "success"
+    output: bool
+
+
+class CELFailure(BaseModel):
+    status: Literal["failure"] = "failure"
+    error: str
+
+
+class CELEvaluationResult(BaseModel):
+    result: CELSuccess | CELFailure = Field(discriminator="status")
+
+
+class CELClient(BaseRestClient):
+    """
+    The CEL client is a client for debugging CEL expressions within Hatchet
+    """
+
+    def _ca(self, client: ApiClient) -> CELApi:
+        return CELApi(client)
+
+    @retry
+    def debug(
+        self,
+        expression: str,
+        input: JSONSerializableMapping,
+        additional_metadata: JSONSerializableMapping | None = None,
+        filter_payload: JSONSerializableMapping | None = None,
+    ) -> CELEvaluationResult:
+        """
+        Debug a CEL expression with the provided input, filter payload, and optional metadata. Useful for testing and validating CEL expressions and debugging issues in production.
+
+        :param expression: The CEL expression to debug.
+        :param input: The input, which simulates the workflow run input.
+        :param additional_metadata: Additional metadata, which simulates metadata that could be sent with an event or a workflow run
+        :param filter_payload: The filter payload, which simulates a payload set on a previous-created filter
+
+        :raises ValueError: If no response is received from the CEL debug API.
+
+        :return: A V1CELDebugErrorResponse or V1CELDebugSuccessResponse containing the result of the debug operation.
+        """
+        request = V1CELDebugRequest(
+            expression=expression,
+            input=input,
+            additionalMetadata=additional_metadata,
+            filterPayload=filter_payload,
+        )
+        with self.client() as client:
+            result = self._ca(client).v1_cel_debug(
+                tenant=self.client_config.tenant_id, v1_cel_debug_request=request
+            )
+
+            if result.status == V1CELDebugResponseStatus.ERROR:
+                if result.error is None:
+                    raise ValueError("No error message received from CEL debug API.")
+
+                return CELEvaluationResult(result=CELFailure(error=result.error))
+
+            if result.output is None:
+                raise ValueError("No output received from CEL debug API.")
+
+            return CELEvaluationResult(result=CELSuccess(output=result.output))
+
+    async def aio_debug(
+        self,
+        expression: str,
+        input: JSONSerializableMapping,
+        additional_metadata: JSONSerializableMapping | None = None,
+        filter_payload: JSONSerializableMapping | None = None,
+    ) -> CELEvaluationResult:
+        """
+        Debug a CEL expression with the provided input, filter payload, and optional metadata. Useful for testing and validating CEL expressions and debugging issues in production.
+
+        :param expression: The CEL expression to debug.
+        :param input: The input, which simulates the workflow run input.
+        :param additional_metadata: Additional metadata, which simulates metadata that could be sent with an event or a workflow run
+        :param filter_payload: The filter payload, which simulates a payload set on a previous-created filter
+
+        :return: A V1CELDebugErrorResponse or V1CELDebugSuccessResponse containing the result of the debug operation.
+        """
+        return await asyncio.to_thread(
+            self.debug, expression, input, additional_metadata, filter_payload
+        )

hatchet_sdk/hatchet.py

@@ -12,6 +12,7 @@ from hatchet_sdk.clients.events import EventClient
 from hatchet_sdk.clients.listeners.run_event_listener import RunEventListenerClient
 from hatchet_sdk.clients.rest.models.tenant_version import TenantVersion
 from hatchet_sdk.config import ClientConfig
+from hatchet_sdk.features.cel import CELClient
 from hatchet_sdk.features.cron import CronClient
 from hatchet_sdk.features.filters import FiltersClient
 from hatchet_sdk.features.logs import LogsClient
@@ -66,6 +67,13 @@ class Hatchet:
                 "🚨⚠️‼️ YOU ARE USING A V0 ENGINE WITH A V1 SDK, WHICH IS NOT SUPPORTED. PLEASE UPGRADE YOUR ENGINE TO V1.🚨⚠️‼️"
             )
 
+    @property
+    def cel(self) -> CELClient:
+        """
+        The CEL client is a client for interacting with Hatchet's CEL API.
+        """
+        return self._client.cel
+
     @property
     def cron(self) -> CronClient:
         """

{hatchet_sdk-1.16.0.dist-info → hatchet_sdk-1.16.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 1.16.0
+Version: 1.16.1
 Summary: 
 License: MIT
 Author: Alexander Belanger