hatchet-sdk 0.46.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

hatchet_sdk/features/cron.py

@@ -1,6 +1,6 @@
-from typing import Union
+from typing import List, Union
 
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, Field, field_validator
 
 from hatchet_sdk.client import Client
 from hatchet_sdk.clients.rest.models.cron_workflows import CronWorkflows
@@ -11,9 +11,10 @@ from hatchet_sdk.clients.rest.models.cron_workflows_order_by_field import (
 from hatchet_sdk.clients.rest.models.workflow_run_order_by_direction import (
     WorkflowRunOrderByDirection,
 )
+from hatchet_sdk.utils.typing import JSONSerializableMapping
 
 
-class CreateCronTriggerInput(BaseModel):
+class CreateCronTriggerJSONSerializableMapping(BaseModel):
     """
     Schema for creating a workflow run triggered by a cron.
 
@@ -23,12 +24,13 @@ class CreateCronTriggerInput(BaseModel):
         additional_metadata (dict[str, str]): Additional metadata associated with the cron trigger (e.g. {"key1": "value1", "key2": "value2"}).
     """
 
-    expression: str = None
-    input: dict = {}
-    additional_metadata: dict[str, str] = {}
+    expression: str
+    input: JSONSerializableMapping = Field(default_factory=dict)
+    additional_metadata: JSONSerializableMapping = Field(default_factory=dict)
 
     @field_validator("expression")
-    def validate_cron_expression(cls, v):
+    @classmethod
+    def validate_cron_expression(cls, v: str) -> str:
         """
         Validates the cron expression to ensure it adheres to the expected format.
 
@@ -79,15 +81,14 @@ class CronClient:
             _client (Client): The client instance to be used for REST interactions.
         """
         self._client = _client
-        self.aio = CronClientAsync(_client)
 
     def create(
         self,
         workflow_name: str,
         cron_name: str,
         expression: str,
-        input: dict,
-        additional_metadata: dict[str, str],
+        input: JSONSerializableMapping,
+        additional_metadata: JSONSerializableMapping,
     ) -> CronWorkflows:
         """
         Creates a new workflow cron trigger.
@@ -102,7 +103,7 @@ class CronClient:
         Returns:
             CronWorkflows: The created cron workflow instance.
         """
-        validated_input = CreateCronTriggerInput(
+        validated_input = CreateCronTriggerJSONSerializableMapping(
             expression=expression, input=input, additional_metadata=additional_metadata
         )
 
@@ -121,10 +122,11 @@ class CronClient:
         Args:
             cron_trigger (Union[str, CronWorkflows]): The cron trigger ID or CronWorkflows instance to delete.
         """
-        id_ = cron_trigger
-        if isinstance(cron_trigger, CronWorkflows):
-            id_ = cron_trigger.metadata.id
-        self._client.rest.cron_delete(id_)
+        self._client.rest.cron_delete(
+            cron_trigger.metadata.id
+            if isinstance(cron_trigger, CronWorkflows)
+            else cron_trigger
+        )
 
     def list(
         self,
@@ -168,38 +170,19 @@ class CronClient:
         Returns:
             CronWorkflows: The requested cron workflow instance.
         """
-        id_ = cron_trigger
-        if isinstance(cron_trigger, CronWorkflows):
-            id_ = cron_trigger.metadata.id
-        return self._client.rest.cron_get(id_)
-
-
-class CronClientAsync:
-    """
-    Asynchronous client for managing workflow cron triggers.
-
-    Attributes:
-        _client (Client): The underlying client used to interact with the REST API asynchronously.
-    """
-
-    _client: Client
-
-    def __init__(self, _client: Client):
-        """
-        Initializes the CronClientAsync with a given Client instance.
-
-        Args:
-            _client (Client): The client instance to be used for asynchronous REST interactions.
-        """
-        self._client = _client
+        return self._client.rest.cron_get(
+            cron_trigger.metadata.id
+            if isinstance(cron_trigger, CronWorkflows)
+            else cron_trigger
+        )
 
-    async def create(
+    async def aio_create(
         self,
         workflow_name: str,
         cron_name: str,
         expression: str,
-        input: dict,
-        additional_metadata: dict[str, str],
+        input: JSONSerializableMapping,
+        additional_metadata: JSONSerializableMapping,
     ) -> CronWorkflows:
         """
         Asynchronously creates a new workflow cron trigger.
@@ -214,11 +197,11 @@ class CronClientAsync:
         Returns:
             CronWorkflows: The created cron workflow instance.
         """
-        validated_input = CreateCronTriggerInput(
+        validated_input = CreateCronTriggerJSONSerializableMapping(
             expression=expression, input=input, additional_metadata=additional_metadata
         )
 
-        return await self._client.rest.aio.cron_create(
+        return await self._client.rest.aio_create_cron(
             workflow_name=workflow_name,
             cron_name=cron_name,
             expression=validated_input.expression,
@@ -226,24 +209,25 @@ class CronClientAsync:
             additional_metadata=validated_input.additional_metadata,
         )
 
-    async def delete(self, cron_trigger: Union[str, CronWorkflows]) -> None:
+    async def aio_delete(self, cron_trigger: Union[str, CronWorkflows]) -> None:
         """
         Asynchronously deletes a workflow cron trigger.
 
         Args:
             cron_trigger (Union[str, CronWorkflows]): The cron trigger ID or CronWorkflows instance to delete.
         """
-        id_ = cron_trigger
-        if isinstance(cron_trigger, CronWorkflows):
-            id_ = cron_trigger.metadata.id
-        await self._client.rest.aio.cron_delete(id_)
+        await self._client.rest.aio_delete_cron(
+            cron_trigger.metadata.id
+            if isinstance(cron_trigger, CronWorkflows)
+            else cron_trigger
+        )
 
-    async def list(
+    async def aio_list(
         self,
         offset: int | None = None,
         limit: int | None = None,
         workflow_id: str | None = None,
-        additional_metadata: list[str] | None = None,
+        additional_metadata: List[str] | None = None,
         order_by_field: CronWorkflowsOrderByField | None = None,
         order_by_direction: WorkflowRunOrderByDirection | None = None,
     ) -> CronWorkflowsList:
@@ -261,7 +245,7 @@ class CronClientAsync:
         Returns:
             CronWorkflowsList: A list of cron workflows.
         """
-        return await self._client.rest.aio.cron_list(
+        return await self._client.rest.aio_list_crons(
             offset=offset,
             limit=limit,
             workflow_id=workflow_id,
@@ -270,7 +254,7 @@ class CronClientAsync:
             order_by_direction=order_by_direction,
         )
 
-    async def get(self, cron_trigger: Union[str, CronWorkflows]) -> CronWorkflows:
+    async def aio_get(self, cron_trigger: Union[str, CronWorkflows]) -> CronWorkflows:
         """
         Asynchronously retrieves a specific workflow cron trigger by ID.
 
@@ -280,7 +264,9 @@ class CronClientAsync:
         Returns:
             CronWorkflows: The requested cron workflow instance.
         """
-        id_ = cron_trigger
-        if isinstance(cron_trigger, CronWorkflows):
-            id_ = cron_trigger.metadata.id
-        return await self._client.rest.aio.cron_get(id_)
+
+        return await self._client.rest.aio_get_cron(
+            cron_trigger.metadata.id
+            if isinstance(cron_trigger, CronWorkflows)
+            else cron_trigger
+        )

hatchet_sdk/features/scheduled.py

@@ -1,10 +1,9 @@
 import datetime
-from typing import Any, Coroutine, Dict, List, Optional, Union
+from typing import List, Optional, Union
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 from hatchet_sdk.client import Client
-from hatchet_sdk.clients.rest.models.cron_workflows import CronWorkflows
 from hatchet_sdk.clients.rest.models.cron_workflows_order_by_field import (
     CronWorkflowsOrderByField,
 )
@@ -12,24 +11,28 @@ from hatchet_sdk.clients.rest.models.scheduled_workflows import ScheduledWorkflo
 from hatchet_sdk.clients.rest.models.scheduled_workflows_list import (
     ScheduledWorkflowsList,
 )
+from hatchet_sdk.clients.rest.models.scheduled_workflows_order_by_field import (
+    ScheduledWorkflowsOrderByField,
+)
 from hatchet_sdk.clients.rest.models.workflow_run_order_by_direction import (
     WorkflowRunOrderByDirection,
 )
+from hatchet_sdk.utils.typing import JSONSerializableMapping
 
 
-class CreateScheduledTriggerInput(BaseModel):
+class CreateScheduledTriggerJSONSerializableMapping(BaseModel):
     """
     Schema for creating a scheduled workflow run.
 
     Attributes:
-        input (Dict[str, Any]): The input data for the scheduled workflow.
-        additional_metadata (Dict[str, str]): Additional metadata associated with the future run (e.g. ["key1:value1", "key2:value2"]).
+        input (JSONSerializableMapping): The input data for the scheduled workflow.
+        additional_metadata (JSONSerializableMapping): Additional metadata associated with the future run (e.g. ["key1:value1", "key2:value2"]).
         trigger_at (Optional[datetime.datetime]): The datetime when the run should be triggered.
     """
 
-    input: Dict[str, Any] = {}
-    additional_metadata: Dict[str, str] = {}
-    trigger_at: Optional[datetime.datetime] = None
+    input: JSONSerializableMapping = Field(default_factory=dict)
+    additional_metadata: JSONSerializableMapping = Field(default_factory=dict)
+    trigger_at: datetime.datetime
 
 
 class ScheduledClient:
@@ -51,14 +54,13 @@ class ScheduledClient:
             _client (Client): The client instance to be used for REST interactions.
         """
         self._client = _client
-        self.aio: "ScheduledClientAsync" = ScheduledClientAsync(_client)
 
     def create(
         self,
         workflow_name: str,
         trigger_at: datetime.datetime,
-        input: Dict[str, Any],
-        additional_metadata: Dict[str, str],
+        input: JSONSerializableMapping,
+        additional_metadata: JSONSerializableMapping,
     ) -> ScheduledWorkflows:
         """
         Creates a new scheduled workflow run asynchronously.
@@ -66,14 +68,14 @@ class ScheduledClient:
         Args:
             workflow_name (str): The name of the scheduled workflow.
             trigger_at (datetime.datetime): The datetime when the run should be triggered.
-            input (Dict[str, Any]): The input data for the scheduled workflow.
-            additional_metadata (Dict[str, str]): Additional metadata associated with the future run as a key-value pair (e.g. {"key1": "value1", "key2": "value2"}).
+            input (JSONSerializableMapping): The input data for the scheduled workflow.
+            additional_metadata (JSONSerializableMapping): Additional metadata associated with the future run as a key-value pair (e.g. {"key1": "value1", "key2": "value2"}).
 
         Returns:
             ScheduledWorkflows: The created scheduled workflow instance.
         """
 
-        validated_input = CreateScheduledTriggerInput(
+        validated_input = CreateScheduledTriggerJSONSerializableMapping(
             trigger_at=trigger_at, input=input, additional_metadata=additional_metadata
         )
 
@@ -91,16 +93,17 @@ class ScheduledClient:
         Args:
             scheduled (Union[str, ScheduledWorkflows]): The scheduled workflow trigger ID or ScheduledWorkflows instance to delete.
         """
-        id_ = scheduled
-        if isinstance(scheduled, ScheduledWorkflows):
-            id_ = scheduled.metadata.id
-        self._client.rest.schedule_delete(id_)
+        self._client.rest.schedule_delete(
+            scheduled.metadata.id
+            if isinstance(scheduled, ScheduledWorkflows)
+            else scheduled
+        )
 
     def list(
         self,
-        offset: Optional[int] = None,
-        limit: Optional[int] = None,
-        workflow_id: Optional[str] = None,
+        offset: int | None = None,
+        limit: int | None = None,
+        workflow_id: str | None = None,
         additional_metadata: Optional[List[str]] = None,
         order_by_field: Optional[CronWorkflowsOrderByField] = None,
         order_by_direction: Optional[WorkflowRunOrderByDirection] = None,
@@ -109,9 +112,9 @@ class ScheduledClient:
         Retrieves a list of scheduled workflows based on provided filters.
 
         Args:
-            offset (Optional[int]): The starting point for the list.
-            limit (Optional[int]): The maximum number of items to return.
-            workflow_id (Optional[str]): Filter by specific workflow ID.
+            offset (int | None): The starting point for the list.
+            limit (int | None): The maximum number of items to return.
+            workflow_id (str | None): Filter by specific workflow ID.
             additional_metadata (Optional[List[str]]): Filter by additional metadata keys (e.g. ["key1:value1", "key2:value2"]).
             order_by_field (Optional[CronWorkflowsOrderByField]): Field to order the results by.
             order_by_direction (Optional[WorkflowRunOrderByDirection]): Direction to order the results.
@@ -138,37 +141,18 @@ class ScheduledClient:
         Returns:
             ScheduledWorkflows: The requested scheduled workflow instance.
         """
-        id_ = scheduled
-        if isinstance(scheduled, ScheduledWorkflows):
-            id_ = scheduled.metadata.id
-        return self._client.rest.schedule_get(id_)
-
-
-class ScheduledClientAsync:
-    """
-    Asynchronous client for managing scheduled workflows.
-
-    Attributes:
-        _client (Client): The underlying client used to interact with the REST API asynchronously.
-    """
-
-    _client: Client
-
-    def __init__(self, _client: Client) -> None:
-        """
-        Initializes the ScheduledClientAsync with a given Client instance.
-
-        Args:
-            _client (Client): The client instance to be used for asynchronous REST interactions.
-        """
-        self._client = _client
+        return self._client.rest.schedule_get(
+            scheduled.metadata.id
+            if isinstance(scheduled, ScheduledWorkflows)
+            else scheduled
+        )
 
-    async def create(
+    async def aio_create(
         self,
         workflow_name: str,
         trigger_at: datetime.datetime,
-        input: Dict[str, Any],
-        additional_metadata: Dict[str, str],
+        input: JSONSerializableMapping,
+        additional_metadata: JSONSerializableMapping,
     ) -> ScheduledWorkflows:
         """
         Creates a new scheduled workflow run asynchronously.
@@ -176,44 +160,45 @@ class ScheduledClientAsync:
         Args:
             workflow_name (str): The name of the scheduled workflow.
             trigger_at (datetime.datetime): The datetime when the run should be triggered.
-            input (Dict[str, Any]): The input data for the scheduled workflow.
-            additional_metadata (Dict[str, str]): Additional metadata associated with the future run.
+            input (JSONSerializableMapping): The input data for the scheduled workflow.
+            additional_metadata (JSONSerializableMapping): Additional metadata associated with the future run.
 
         Returns:
             ScheduledWorkflows: The created scheduled workflow instance.
         """
-        return await self._client.rest.aio.schedule_create(
+        return await self._client.rest.aio_create_schedule(
             workflow_name, trigger_at, input, additional_metadata
         )
 
-    async def delete(self, scheduled: Union[str, ScheduledWorkflows]) -> None:
+    async def aio_delete(self, scheduled: Union[str, ScheduledWorkflows]) -> None:
         """
         Deletes a scheduled workflow asynchronously.
 
         Args:
             scheduled (Union[str, ScheduledWorkflows]): The scheduled workflow trigger ID or ScheduledWorkflows instance to delete.
         """
-        id_ = scheduled
-        if isinstance(scheduled, ScheduledWorkflows):
-            id_ = scheduled.metadata.id
-        await self._client.rest.aio.schedule_delete(id_)
+        await self._client.rest.aio_delete_schedule(
+            scheduled.metadata.id
+            if isinstance(scheduled, ScheduledWorkflows)
+            else scheduled
+        )
 
-    async def list(
+    async def aio_list(
         self,
-        offset: Optional[int] = None,
-        limit: Optional[int] = None,
-        workflow_id: Optional[str] = None,
+        offset: int | None = None,
+        limit: int | None = None,
+        workflow_id: str | None = None,
         additional_metadata: Optional[List[str]] = None,
-        order_by_field: Optional[CronWorkflowsOrderByField] = None,
+        order_by_field: Optional[ScheduledWorkflowsOrderByField] = None,
         order_by_direction: Optional[WorkflowRunOrderByDirection] = None,
     ) -> ScheduledWorkflowsList:
         """
         Retrieves a list of scheduled workflows based on provided filters asynchronously.
 
         Args:
-            offset (Optional[int]): The starting point for the list.
-            limit (Optional[int]): The maximum number of items to return.
-            workflow_id (Optional[str]): Filter by specific workflow ID.
+            offset (int | None): The starting point for the list.
+            limit (int | None): The maximum number of items to return.
+            workflow_id (str | None): Filter by specific workflow ID.
             additional_metadata (Optional[List[str]]): Filter by additional metadata keys (e.g. ["key1:value1", "key2:value2"]).
             order_by_field (Optional[CronWorkflowsOrderByField]): Field to order the results by.
             order_by_direction (Optional[WorkflowRunOrderByDirection]): Direction to order the results.
@@ -221,7 +206,7 @@ class ScheduledClientAsync:
         Returns:
             ScheduledWorkflowsList: A list of scheduled workflows matching the criteria.
         """
-        return await self._client.rest.aio.schedule_list(
+        return await self._client.rest.aio_list_schedule(
             offset=offset,
             limit=limit,
             workflow_id=workflow_id,
@@ -230,7 +215,7 @@ class ScheduledClientAsync:
             order_by_direction=order_by_direction,
         )
 
-    async def get(
+    async def aio_get(
         self, scheduled: Union[str, ScheduledWorkflows]
     ) -> ScheduledWorkflows:
         """
@@ -242,7 +227,8 @@ class ScheduledClientAsync:
         Returns:
             ScheduledWorkflows: The requested scheduled workflow instance.
         """
-        id_ = scheduled
-        if isinstance(scheduled, ScheduledWorkflows):
-            id_ = scheduled.metadata.id
-        return await self._client.rest.aio.schedule_get(id_)
+        return await self._client.rest.aio_get_schedule(
+            scheduled.metadata.id
+            if isinstance(scheduled, ScheduledWorkflows)
+            else scheduled
+        )