hatchet-sdk 1.6.4__tar.gz → 1.7.0__tar.gz

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/PKG-INFO

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

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/clients/admin.py

@@ -141,19 +141,6 @@ class AdminClient:
             priority=_options.priority,
         )
 
-    def _prepare_put_workflow_request(
-        self,
-        name: str,
-        workflow: workflow_protos.CreateWorkflowVersionRequest,
-        overrides: workflow_protos.CreateWorkflowVersionRequest | None = None,
-    ) -> workflow_protos.CreateWorkflowVersionRequest:
-        if overrides is not None:
-            workflow.MergeFrom(overrides)
-
-        workflow.name = name
-
-        return workflow
-
     def _parse_schedule(
         self, schedule: datetime | timestamp_pb2.Timestamp
     ) -> timestamp_pb2.Timestamp:
@@ -191,11 +178,9 @@ class AdminClient:
     @tenacity_retry
     async def aio_put_workflow(
         self,
-        name: str,
         workflow: workflow_protos.CreateWorkflowVersionRequest,
-        overrides: workflow_protos.CreateWorkflowVersionRequest | None = None,
     ) -> workflow_protos.CreateWorkflowVersionResponse:
-        return await asyncio.to_thread(self.put_workflow, name, workflow, overrides)
+        return await asyncio.to_thread(self.put_workflow, workflow)
 
     @tenacity_retry
     async def aio_put_rate_limit(
@@ -221,12 +206,8 @@ class AdminClient:
     @tenacity_retry
     def put_workflow(
         self,
-        name: str,
         workflow: workflow_protos.CreateWorkflowVersionRequest,
-        overrides: workflow_protos.CreateWorkflowVersionRequest | None = None,
     ) -> workflow_protos.CreateWorkflowVersionResponse:
-        opts = self._prepare_put_workflow_request(name, workflow, overrides)
-
         if self.client is None:
             conn = new_conn(self.config, False)
             self.client = AdminServiceStub(conn)
@@ -234,7 +215,7 @@ class AdminClient:
         return cast(
             workflow_protos.CreateWorkflowVersionResponse,
             self.client.PutWorkflow(
-                opts,
+                workflow,
                 metadata=get_metadata(self.token),
             ),
         )
@@ -324,6 +305,9 @@ class AdminClient:
             additional_metadata=options.additional_metadata,
             desired_worker_id=desired_worker_id,
             priority=options.priority,
+            namespace=options.namespace,
+            sticky=options.sticky,
+            key=options.key,
         )
 
         namespace = options.namespace or self.namespace

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/clients/rest/api/workflow_api.py

@@ -88,6 +88,12 @@ class WorkflowApi:
             Optional[Annotated[str, Field(min_length=36, strict=True, max_length=36)]],
             Field(description="The workflow id to get runs for."),
         ] = None,
+        workflow_name: Annotated[
+            Optional[StrictStr], Field(description="The workflow name to get runs for.")
+        ] = None,
+        cron_name: Annotated[
+            Optional[StrictStr], Field(description="The cron name to get runs for.")
+        ] = None,
         additional_metadata: Annotated[
             Optional[List[StrictStr]],
             Field(description="A list of metadata key value pairs to filter by"),
@@ -123,6 +129,10 @@ class WorkflowApi:
         :type limit: int
         :param workflow_id: The workflow id to get runs for.
         :type workflow_id: str
+        :param workflow_name: The workflow name to get runs for.
+        :type workflow_name: str
+        :param cron_name: The cron name to get runs for.
+        :type cron_name: str
         :param additional_metadata: A list of metadata key value pairs to filter by
         :type additional_metadata: List[str]
         :param order_by_field: The order by field
@@ -156,6 +166,8 @@ class WorkflowApi:
             offset=offset,
             limit=limit,
             workflow_id=workflow_id,
+            workflow_name=workflow_name,
+            cron_name=cron_name,
             additional_metadata=additional_metadata,
             order_by_field=order_by_field,
             order_by_direction=order_by_direction,
@@ -198,6 +210,12 @@ class WorkflowApi:
             Optional[Annotated[str, Field(min_length=36, strict=True, max_length=36)]],
             Field(description="The workflow id to get runs for."),
         ] = None,
+        workflow_name: Annotated[
+            Optional[StrictStr], Field(description="The workflow name to get runs for.")
+        ] = None,
+        cron_name: Annotated[
+            Optional[StrictStr], Field(description="The cron name to get runs for.")
+        ] = None,
         additional_metadata: Annotated[
             Optional[List[StrictStr]],
             Field(description="A list of metadata key value pairs to filter by"),
@@ -233,6 +251,10 @@ class WorkflowApi:
         :type limit: int
         :param workflow_id: The workflow id to get runs for.
         :type workflow_id: str
+        :param workflow_name: The workflow name to get runs for.
+        :type workflow_name: str
+        :param cron_name: The cron name to get runs for.
+        :type cron_name: str
         :param additional_metadata: A list of metadata key value pairs to filter by
         :type additional_metadata: List[str]
         :param order_by_field: The order by field
@@ -266,6 +288,8 @@ class WorkflowApi:
             offset=offset,
             limit=limit,
             workflow_id=workflow_id,
+            workflow_name=workflow_name,
+            cron_name=cron_name,
             additional_metadata=additional_metadata,
             order_by_field=order_by_field,
             order_by_direction=order_by_direction,
@@ -308,6 +332,12 @@ class WorkflowApi:
             Optional[Annotated[str, Field(min_length=36, strict=True, max_length=36)]],
             Field(description="The workflow id to get runs for."),
         ] = None,
+        workflow_name: Annotated[
+            Optional[StrictStr], Field(description="The workflow name to get runs for.")
+        ] = None,
+        cron_name: Annotated[
+            Optional[StrictStr], Field(description="The cron name to get runs for.")
+        ] = None,
         additional_metadata: Annotated[
             Optional[List[StrictStr]],
             Field(description="A list of metadata key value pairs to filter by"),
@@ -343,6 +373,10 @@ class WorkflowApi:
         :type limit: int
         :param workflow_id: The workflow id to get runs for.
         :type workflow_id: str
+        :param workflow_name: The workflow name to get runs for.
+        :type workflow_name: str
+        :param cron_name: The cron name to get runs for.
+        :type cron_name: str
         :param additional_metadata: A list of metadata key value pairs to filter by
         :type additional_metadata: List[str]
         :param order_by_field: The order by field
@@ -376,6 +410,8 @@ class WorkflowApi:
             offset=offset,
             limit=limit,
             workflow_id=workflow_id,
+            workflow_name=workflow_name,
+            cron_name=cron_name,
             additional_metadata=additional_metadata,
             order_by_field=order_by_field,
             order_by_direction=order_by_direction,
@@ -401,6 +437,8 @@ class WorkflowApi:
         offset,
         limit,
         workflow_id,
+        workflow_name,
+        cron_name,
         additional_metadata,
         order_by_field,
         order_by_direction,
@@ -441,6 +479,14 @@ class WorkflowApi:
 
             _query_params.append(("workflowId", workflow_id))
 
+        if workflow_name is not None:
+
+            _query_params.append(("workflowName", workflow_name))
+
+        if cron_name is not None:
+
+            _query_params.append(("cronName", cron_name))
+
         if additional_metadata is not None:
 
             _query_params.append(("additionalMetadata", additional_metadata))

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/features/cron.py

@@ -172,6 +172,8 @@ class CronClient(BaseRestClient):
         additional_metadata: JSONSerializableMapping | None = None,
         order_by_field: CronWorkflowsOrderByField | None = None,
         order_by_direction: WorkflowRunOrderByDirection | None = None,
+        workflow_name: str | None = None,
+        cron_name: str | None = None,
     ) -> CronWorkflowsList:
         """
         Retrieve a list of all workflow cron triggers matching the criteria.
@@ -182,6 +184,8 @@ class CronClient(BaseRestClient):
         :param additional_metadata: Filter by additional metadata keys.
         :param order_by_field: The field to order the list by.
         :param order_by_direction: The direction to order the list by.
+        :param workflow_name: The name of the workflow to filter by.
+        :param cron_name: The name of the cron trigger to filter by.
 
         :return: A list of cron workflows.
         """
@@ -193,6 +197,8 @@ class CronClient(BaseRestClient):
             additional_metadata=additional_metadata,
             order_by_field=order_by_field,
             order_by_direction=order_by_direction,
+            workflow_name=workflow_name,
+            cron_name=cron_name,
         )
 
     def list(
@@ -203,6 +209,8 @@ class CronClient(BaseRestClient):
         additional_metadata: JSONSerializableMapping | None = None,
         order_by_field: CronWorkflowsOrderByField | None = None,
         order_by_direction: WorkflowRunOrderByDirection | None = None,
+        workflow_name: str | None = None,
+        cron_name: str | None = None,
     ) -> CronWorkflowsList:
         """
         Retrieve a list of all workflow cron triggers matching the criteria.
@@ -213,6 +221,8 @@ class CronClient(BaseRestClient):
         :param additional_metadata: Filter by additional metadata keys.
         :param order_by_field: The field to order the list by.
         :param order_by_direction: The direction to order the list by.
+        :param workflow_name: The name of the workflow to filter by.
+        :param cron_name: The name of the cron trigger to filter by.
 
         :return: A list of cron workflows.
         """
@@ -227,6 +237,8 @@ class CronClient(BaseRestClient):
                 ),
                 order_by_field=order_by_field,
                 order_by_direction=order_by_direction,
+                workflow_name=workflow_name,
+                cron_name=cron_name,
             )
 
     def get(self, cron_id: str) -> CronWorkflows:

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/features/runs.py

@@ -131,7 +131,7 @@ class RunsClient(BaseRestClient):
 
     async def aio_list(
         self,
-        since: datetime = datetime.now() - timedelta(hours=1),
+        since: datetime | None = None,
         only_tasks: bool = False,
         offset: int | None = None,
         limit: int | None = None,
@@ -160,7 +160,7 @@ class RunsClient(BaseRestClient):
         """
         return await asyncio.to_thread(
             self.list,
-            since=since,
+            since=since or datetime.now() - timedelta(days=1),
             only_tasks=only_tasks,
             offset=offset,
             limit=limit,
@@ -174,7 +174,7 @@ class RunsClient(BaseRestClient):
 
     def list(
         self,
-        since: datetime = datetime.now() - timedelta(hours=1),
+        since: datetime | None = None,
         only_tasks: bool = False,
         offset: int | None = None,
         limit: int | None = None,
@@ -204,7 +204,7 @@ class RunsClient(BaseRestClient):
         with self.client() as client:
             return self._wra(client).v1_workflow_run_list(
                 tenant=self.client_config.tenant_id,
-                since=since,
+                since=since or datetime.now() - timedelta(days=1),
                 only_tasks=only_tasks,
                 offset=offset,
                 limit=limit,

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/runnables/standalone.py

@@ -1,4 +1,5 @@
-from datetime import datetime
+import asyncio
+from datetime import datetime, timedelta
 from typing import Any, Generic, cast, get_type_hints
 
 from hatchet_sdk.clients.admin import (
@@ -7,7 +8,10 @@ from hatchet_sdk.clients.admin import (
     WorkflowRunTriggerConfig,
 )
 from hatchet_sdk.clients.rest.models.cron_workflows import CronWorkflows
+from hatchet_sdk.clients.rest.models.v1_task_status import V1TaskStatus
+from hatchet_sdk.clients.rest.models.v1_task_summary import V1TaskSummary
 from hatchet_sdk.contracts.workflows_pb2 import WorkflowVersion
+from hatchet_sdk.logger import logger
 from hatchet_sdk.runnables.task import Task
 from hatchet_sdk.runnables.types import EmptyModel, R, TWorkflowInput
 from hatchet_sdk.runnables.workflow import BaseWorkflow, Workflow
@@ -294,3 +298,88 @@ class Standalone(BaseWorkflow[TWorkflowInput], Generic[TWorkflowInput, R]):
 
     def to_task(self) -> Task[TWorkflowInput, R]:
         return self._task
+
+    def list_runs(
+        self,
+        since: datetime | None = None,
+        until: datetime | None = None,
+        limit: int = 100,
+        offset: int | None = None,
+        statuses: list[V1TaskStatus] | None = None,
+        additional_metadata: dict[str, str] | None = None,
+        worker_id: str | None = None,
+        parent_task_external_id: str | None = None,
+    ) -> list[V1TaskSummary]:
+        """
+        List runs of the workflow.
+
+        :param since: The start time for the runs to be listed.
+        :param until: The end time for the runs to be listed.
+        :param limit: The maximum number of runs to be listed.
+        :param offset: The offset for pagination.
+        :param statuses: The statuses of the runs to be listed.
+        :param additional_metadata: Additional metadata for filtering the runs.
+        :param worker_id: The ID of the worker that ran the tasks.
+        :param parent_task_external_id: The external ID of the parent task.
+
+        :returns: A list of `V1TaskSummary` objects representing the runs of the workflow.
+        """
+        workflows = self.client.workflows.list(workflow_name=self._workflow.name)
+
+        if not workflows.rows:
+            logger.warning(f"No runs found for {self.name}")
+            return []
+
+        workflow = workflows.rows[0]
+
+        response = self.client.runs.list(
+            workflow_ids=[workflow.metadata.id],
+            since=since or datetime.now() - timedelta(days=1),
+            only_tasks=True,
+            offset=offset,
+            limit=limit,
+            statuses=statuses,
+            until=until,
+            additional_metadata=additional_metadata,
+            worker_id=worker_id,
+            parent_task_external_id=parent_task_external_id,
+        )
+
+        return response.rows
+
+    async def aio_list_runs(
+        self,
+        since: datetime | None = None,
+        until: datetime | None = None,
+        limit: int = 100,
+        offset: int | None = None,
+        statuses: list[V1TaskStatus] | None = None,
+        additional_metadata: dict[str, str] | None = None,
+        worker_id: str | None = None,
+        parent_task_external_id: str | None = None,
+    ) -> list[V1TaskSummary]:
+        """
+        List runs of the workflow.
+
+        :param since: The start time for the runs to be listed.
+        :param until: The end time for the runs to be listed.
+        :param limit: The maximum number of runs to be listed.
+        :param offset: The offset for pagination.
+        :param statuses: The statuses of the runs to be listed.
+        :param additional_metadata: Additional metadata for filtering the runs.
+        :param worker_id: The ID of the worker that ran the tasks.
+        :param parent_task_external_id: The external ID of the parent task.
+
+        :returns: A list of `V1TaskSummary` objects representing the runs of the workflow.
+        """
+        return await asyncio.to_thread(
+            self.list_runs,
+            since=since or datetime.now() - timedelta(days=1),
+            offset=offset,
+            limit=limit,
+            statuses=statuses,
+            until=until,
+            additional_metadata=additional_metadata,
+            worker_id=worker_id,
+            parent_task_external_id=parent_task_external_id,
+        )

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/runnables/workflow.py

@@ -1,5 +1,5 @@
 import asyncio
-from datetime import datetime
+from datetime import datetime, timedelta
 from typing import TYPE_CHECKING, Any, Callable, Generic, cast
 
 from google.protobuf import timestamp_pb2
@@ -11,6 +11,8 @@ from hatchet_sdk.clients.admin import (
     WorkflowRunTriggerConfig,
 )
 from hatchet_sdk.clients.rest.models.cron_workflows import CronWorkflows
+from hatchet_sdk.clients.rest.models.v1_task_status import V1TaskStatus
+from hatchet_sdk.clients.rest.models.v1_task_summary import V1TaskSummary
 from hatchet_sdk.context.context import Context, DurableContext
 from hatchet_sdk.contracts.v1.workflows_pb2 import (
     CreateWorkflowVersionRequest,
@@ -624,7 +626,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         [Callable[[TWorkflowInput, DurableContext], R]], Task[TWorkflowInput, R]
     ]:
         """
-        A decorator to transform a function into a durable Hatchet task that run as part of a workflow.
+        A decorator to transform a function into a durable Hatchet task that runs as part of a workflow.
 
         **IMPORTANT:** This decorator creates a _durable_ task, which works using Hatchet's durable execution capabilities. This is an advanced feature of Hatchet.
 
@@ -765,7 +767,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         """
         A decorator to transform a function into a Hatchet on-success task that runs as the last step in a workflow that had all upstream tasks succeed.
 
-        :param name: The name of the on-success task. If not specified, defaults to the name of the function being wrapped by the `on_failure_task` decorator.
+        :param name: The name of the on-success task. If not specified, defaults to the name of the function being wrapped by the `on_success_task` decorator.
 
         :param schedule_timeout: The maximum time to wait for the task to be scheduled. The run will be canceled if the task does not begin within this time.
 
@@ -803,8 +805,8 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
                 parents=[],
             )
 
-            if self._on_failure_task:
-                raise ValueError("Only one on-failure task is allowed")
+            if self._on_success_task:
+                raise ValueError("Only one on-success task is allowed")
 
             self._on_success_task = task
 
@@ -846,3 +848,93 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
                 self._on_success_task = _task
             case _:
                 raise ValueError("Invalid task type")
+
+    def list_runs(
+        self,
+        since: datetime | None = None,
+        until: datetime | None = None,
+        limit: int = 100,
+        offset: int | None = None,
+        statuses: list[V1TaskStatus] | None = None,
+        additional_metadata: dict[str, str] | None = None,
+        worker_id: str | None = None,
+        parent_task_external_id: str | None = None,
+        only_tasks: bool = False,
+    ) -> list[V1TaskSummary]:
+        """
+        List runs of the workflow.
+
+        :param since: The start time for the runs to be listed.
+        :param until: The end time for the runs to be listed.
+        :param limit: The maximum number of runs to be listed.
+        :param offset: The offset for pagination.
+        :param statuses: The statuses of the runs to be listed.
+        :param additional_metadata: Additional metadata for filtering the runs.
+        :param worker_id: The ID of the worker that ran the tasks.
+        :param parent_task_external_id: The external ID of the parent task.
+        :param only_tasks: Whether to list only task runs.
+
+        :returns: A list of `V1TaskSummary` objects representing the runs of the workflow.
+        """
+        workflows = self.client.workflows.list(workflow_name=self.name)
+
+        if not workflows.rows:
+            logger.warning(f"No runs found for {self.name}")
+            return []
+
+        workflow = workflows.rows[0]
+
+        response = self.client.runs.list(
+            workflow_ids=[workflow.metadata.id],
+            since=since or datetime.now() - timedelta(days=1),
+            only_tasks=only_tasks,
+            offset=offset,
+            limit=limit,
+            statuses=statuses,
+            until=until,
+            additional_metadata=additional_metadata,
+            worker_id=worker_id,
+            parent_task_external_id=parent_task_external_id,
+        )
+
+        return response.rows
+
+    async def aio_list_runs(
+        self,
+        since: datetime | None = None,
+        until: datetime | None = None,
+        limit: int = 100,
+        offset: int | None = None,
+        statuses: list[V1TaskStatus] | None = None,
+        additional_metadata: dict[str, str] | None = None,
+        worker_id: str | None = None,
+        parent_task_external_id: str | None = None,
+        only_tasks: bool = False,
+    ) -> list[V1TaskSummary]:
+        """
+        List runs of the workflow.
+
+        :param since: The start time for the runs to be listed.
+        :param until: The end time for the runs to be listed.
+        :param limit: The maximum number of runs to be listed.
+        :param offset: The offset for pagination.
+        :param statuses: The statuses of the runs to be listed.
+        :param additional_metadata: Additional metadata for filtering the runs.
+        :param worker_id: The ID of the worker that ran the tasks.
+        :param parent_task_external_id: The external ID of the parent task.
+        :param only_tasks: Whether to list only task runs.
+
+        :returns: A list of `V1TaskSummary` objects representing the runs of the workflow.
+        """
+        return await asyncio.to_thread(
+            self.list_runs,
+            since=since or datetime.now() - timedelta(days=1),
+            only_tasks=only_tasks,
+            offset=offset,
+            limit=limit,
+            statuses=statuses,
+            until=until,
+            additional_metadata=additional_metadata,
+            worker_id=worker_id,
+            parent_task_external_id=parent_task_external_id,
+        )

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/hatchet_sdk/worker/worker.py

@@ -147,7 +147,7 @@ class Worker:
 
     def register_workflow_from_opts(self, opts: CreateWorkflowVersionRequest) -> None:
         try:
-            self.client.admin.put_workflow(opts.name, opts)
+            self.client.admin.put_workflow(opts)
         except Exception as e:
             logger.error(f"failed to register workflow: {opts.name}")
             logger.error(e)
@@ -159,11 +159,8 @@ class Worker:
                 "workflow must have at least one task registered before registering"
             )
 
-        opts = workflow.to_proto()
-        name = workflow.name
-
         try:
-            self.client.admin.put_workflow(name, opts)
+            self.client.admin.put_workflow(workflow.to_proto())
         except Exception as e:
             logger.error(f"failed to register workflow: {workflow.name}")
             logger.error(e)

{hatchet_sdk-1.6.4 → hatchet_sdk-1.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hatchet-sdk"
-version = "1.6.4"
+version = "1.7.0"
 description = ""
 authors = ["Alexander Belanger <alexander@hatchet.run>"]
 readme = "README.md"