hatchet-sdk 1.0.1__tar.gz → 1.0.3__tar.gz

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 1.0.1
+Version: 1.0.3
 Summary: 
 Author: Alexander Belanger
 Author-email: alexander@hatchet.run
@@ -29,6 +29,7 @@ Requires-Dist: prometheus-client (>=0.21.1,<0.22.0)
 Requires-Dist: protobuf (>=5.29.1,<6.0.0)
 Requires-Dist: pydantic (>=2.6.3,<3.0.0)
 Requires-Dist: pydantic-settings (>=2.7.1,<3.0.0)
+Requires-Dist: pytest-timeout (>=2.3.1,<3.0.0)
 Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
 Requires-Dist: tenacity (>=8.4.1)

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/clients/admin.py

@@ -36,6 +36,7 @@ class ScheduleTriggerWorkflowOptions(BaseModel):
     child_index: int | None = None
     child_key: str | None = None
     namespace: str | None = None
+    additional_metadata: JSONSerializableMapping = Field(default_factory=dict)
 
 
 class TriggerWorkflowOptions(ScheduleTriggerWorkflowOptions):
@@ -153,7 +154,11 @@ class AdminClient:
             name=name,
             schedules=[self._parse_schedule(schedule) for schedule in schedules],
             input=json.dumps(input),
-            **options.model_dump(),
+            parent_id=options.parent_id,
+            parent_step_run_id=options.parent_step_run_id,
+            child_index=options.child_index,
+            child_key=options.child_key,
+            additional_metadata=json.dumps(options.additional_metadata),
         )
 
     @tenacity_retry
@@ -316,6 +321,7 @@ class AdminClient:
         except (grpc.RpcError, grpc.aio.AioRpcError) as e:
             if e.code() == grpc.StatusCode.ALREADY_EXISTS:
                 raise DedupeViolationErr(e.details())
+            raise e
 
         return WorkflowRunRef(
             workflow_run_id=resp.workflow_run_id,

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/clients/dispatcher/action_listener.py

@@ -277,9 +277,7 @@ class ActionListener:
                         )
 
                         t.cancel()
-
-                        if listener:
-                            listener.cancel()
+                        listener.cancel()
 
                         break
 
@@ -300,7 +298,9 @@ class ActionListener:
                             )
                         )
                     except (ValueError, json.JSONDecodeError) as e:
-                        raise ValueError(f"Error decoding payload: {e}")
+                        logger.error(f"Error decoding payload: {e}")
+
+                        action_payload = ActionPayload()
 
                     action = Action(
                         tenant_id=assigned_action.tenantId,
@@ -421,7 +421,7 @@ class ActionListener:
         except Exception as e:
             logger.error(f"failed to unregister: {e}")
 
-        if self.interrupt:
+        if self.interrupt:  # type: ignore[truthy-bool]
             self.interrupt.set()
 
     def unregister(self) -> WorkerUnsubscribeRequest:

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/clients/durable_event_listener.py

@@ -159,8 +159,8 @@ class DurableEventListener:
                                 )
 
                                 t.cancel()
-                                if self.listener:
-                                    self.listener.cancel()
+                                self.listener.cancel()
+
                                 await asyncio.sleep(
                                     DEFAULT_DURABLE_EVENT_LISTENER_RETRY_INTERVAL
                                 )
@@ -237,6 +237,8 @@ class DurableEventListener:
         del self.events[subscription_id]
 
     async def subscribe(self, task_id: str, signal_key: str) -> DurableEvent:
+        subscription_id: int | None = None
+
         try:
             # create a new subscription id, place a mutex on the counter
             async with self.subscription_counter_lock:
@@ -275,7 +277,8 @@ class DurableEventListener:
         except asyncio.CancelledError:
             raise
         finally:
-            self.cleanup_subscription(subscription_id)
+            if subscription_id:
+                self.cleanup_subscription(subscription_id)
 
     async def _retry_subscribe(
         self,

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/clients/events.py

@@ -86,8 +86,7 @@ class EventClient:
         namespaced_event_key = namespace + event_key
 
         try:
-            meta = options.additional_metadata
-            meta_bytes = None if meta is None else json.dumps(meta)
+            meta_bytes = json.dumps(options.additional_metadata)
         except Exception as e:
             raise ValueError(f"Error encoding meta: {e}")
 

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/clients/run_event_listener.py

@@ -1,5 +1,4 @@
 import asyncio
-import json
 from enum import Enum
 from typing import Any, AsyncGenerator, Callable, Generator, cast
 
@@ -128,18 +127,10 @@ class RunEventListener:
                             raise Exception(
                                 f"Unknown event type: {workflow_event.eventType}"
                             )
-                        payload = None
 
-                        try:
-                            if workflow_event.eventPayload:
-                                payload = json.loads(workflow_event.eventPayload)
-                        except Exception:
-                            payload = workflow_event.eventPayload
-                            pass
-
-                        assert isinstance(payload, str)
-
-                        yield StepRunEvent(type=eventType, payload=payload)
+                        yield StepRunEvent(
+                            type=eventType, payload=workflow_event.eventPayload
+                        )
                     elif workflow_event.resourceType == RESOURCE_TYPE_WORKFLOW_RUN:
                         if workflow_event.eventType in step_run_event_type_mapping:
                             workflowRunEventType = step_run_event_type_mapping[
@@ -150,17 +141,10 @@ class RunEventListener:
                                 f"Unknown event type: {workflow_event.eventType}"
                             )
 
-                        payload = None
-
-                        try:
-                            if workflow_event.eventPayload:
-                                payload = json.loads(workflow_event.eventPayload)
-                        except Exception:
-                            pass
-
-                        assert isinstance(payload, str)
-
-                        yield StepRunEvent(type=workflowRunEventType, payload=payload)
+                        yield StepRunEvent(
+                            type=workflowRunEventType,
+                            payload=workflow_event.eventPayload,
+                        )
 
                     if workflow_event.hangup:
                         listener = None
@@ -236,9 +220,6 @@ class RunEventListenerClient:
         return self.stream(workflow_run_id)
 
     def stream(self, workflow_run_id: str) -> RunEventListener:
-        if not isinstance(workflow_run_id, str) and hasattr(workflow_run_id, "__str__"):
-            workflow_run_id = str(workflow_run_id)
-
         if not self.client:
             aio_conn = new_conn(self.config, True)
             self.client = DispatcherStub(aio_conn)  # type: ignore[no-untyped-call]

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/clients/workflow_listener.py

@@ -132,8 +132,8 @@ class PooledWorkflowRunListener:
                                 )
 
                                 t.cancel()
-                                if self.listener:
-                                    self.listener.cancel()
+                                self.listener.cancel()
+
                                 await asyncio.sleep(
                                     DEFAULT_WORKFLOW_LISTENER_RETRY_INTERVAL
                                 )
@@ -203,6 +203,8 @@ class PooledWorkflowRunListener:
         del self.events[subscription_id]
 
     async def subscribe(self, workflow_run_id: str) -> WorkflowRunEvent:
+        subscription_id: int | None = None
+
         try:
             # create a new subscription id, place a mutex on the counter
             await self.subscription_counter_lock.acquire()
@@ -234,7 +236,8 @@ class PooledWorkflowRunListener:
         except asyncio.CancelledError:
             raise
         finally:
-            self.cleanup_subscription(subscription_id)
+            if subscription_id:
+                self.cleanup_subscription(subscription_id)
 
     async def result(self, workflow_run_id: str) -> dict[str, Any]:
         from hatchet_sdk.clients.admin import DedupeViolationErr

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/context/context.py

@@ -113,6 +113,14 @@ class Context:
 
         return parent_step_data
 
+    def aio_task_output(self, task: "Task[TWorkflowInput, R]") -> "R":
+        if task.is_async_function:
+            return self.task_output(task)
+
+        raise ValueError(
+            f"Task '{task.name}' is not an async function. Use `task_output` instead."
+        )
+
     @property
     def was_triggered_by_event(self) -> bool:
         return self.data.triggered_by == "event"
@@ -157,6 +165,7 @@ class Context:
 
         def handle_result(future: Future[tuple[bool, Exception | None]]) -> None:
             success, exception = future.result()
+
             if not success and exception:
                 if raise_on_error:
                     raise exception

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/worker/runner/runner.py

@@ -123,6 +123,7 @@ class Runner:
 
             errored = False
             cancelled = task.cancelled()
+            output = None
 
             # Get the output from the future
             try:
@@ -167,6 +168,7 @@ class Runner:
 
             errored = False
             cancelled = task.cancelled()
+            output = None
 
             # Get the output from the future
             try:
@@ -204,12 +206,9 @@ class Runner:
     def thread_action_func(
         self, ctx: Context, task: Task[TWorkflowInput, R], action: Action
     ) -> R:
-        if action.step_run_id is not None and action.step_run_id != "":
+        if action.step_run_id:
             self.threads[action.step_run_id] = current_thread()
-        elif (
-            action.get_group_key_run_id is not None
-            and action.get_group_key_run_id != ""
-        ):
+        elif action.get_group_key_run_id:
             self.threads[action.get_group_key_run_id] = current_thread()
 
         return task.call(ctx)

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/worker/runner/utils/capture_logs.py

@@ -63,9 +63,6 @@ def capture_logs(
 ) -> Callable[P, Awaitable[T]]:
     @functools.wraps(func)
     async def wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
-        if not logger:
-            raise Exception("No logger configured on client")
-
         log_stream = StringIO()
         custom_handler = CustomLogHandler(event_client, log_stream)
         custom_handler.setLevel(logging.INFO)

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/hatchet_sdk/worker/worker.py

@@ -103,7 +103,7 @@ class Worker:
         self.durable_action_queue: "Queue[Action | STOP_LOOP_TYPE]" = self.ctx.Queue()
         self.durable_event_queue: "Queue[ActionEvent]" = self.ctx.Queue()
 
-        self.loop: asyncio.AbstractEventLoop
+        self.loop: asyncio.AbstractEventLoop | None
 
         self.client = Client(config=self.config, debug=self.debug)
 
@@ -226,6 +226,9 @@ class Worker:
     def start(self, options: WorkerStartOptions = WorkerStartOptions()) -> None:
         self.owned_loop = self._setup_loop(options.loop)
 
+        if not self.loop:
+            raise RuntimeError("event loop not set, cannot start worker")
+
         asyncio.run_coroutine_threadsafe(self._aio_start(), self.loop)
 
         # start the loop and wait until its closed
@@ -265,27 +268,31 @@ class Worker:
             )
             self.durable_action_runner = self._run_action_runner(is_durable=True)
 
-        self.action_listener_health_check = self.loop.create_task(
-            self._check_listener_health()
-        )
+        if self.loop:
+            self.action_listener_health_check = self.loop.create_task(
+                self._check_listener_health()
+            )
 
-        await self.action_listener_health_check
+            await self.action_listener_health_check
 
     def _run_action_runner(self, is_durable: bool) -> WorkerActionRunLoopManager:
         # Retrieve the shared queue
-        return WorkerActionRunLoopManager(
-            self.name + ("_durable" if is_durable else ""),
-            self.durable_action_registry if is_durable else self.action_registry,
-            self.validator_registry,
-            1_000 if is_durable else self.slots,
-            self.config,
-            self.durable_action_queue if is_durable else self.action_queue,
-            self.durable_event_queue if is_durable else self.event_queue,
-            self.loop,
-            self.handle_kill,
-            self.client.debug,
-            self.labels,
-        )
+        if self.loop:
+            return WorkerActionRunLoopManager(
+                self.name + ("_durable" if is_durable else ""),
+                self.durable_action_registry if is_durable else self.action_registry,
+                self.validator_registry,
+                1_000 if is_durable else self.slots,
+                self.config,
+                self.durable_action_queue if is_durable else self.action_queue,
+                self.durable_event_queue if is_durable else self.event_queue,
+                self.loop,
+                self.handle_kill,
+                self.client.debug,
+                self.labels,
+            )
+
+        raise RuntimeError("event loop not set, cannot start action runner")
 
     def _start_action_listener(
         self, is_durable: bool
@@ -332,7 +339,7 @@ class Worker:
                 ):
                     logger.debug("child action listener process killed...")
                     self._status = WorkerStatus.UNHEALTHY
-                    if not self.killing:
+                    if self.loop:
                         self.loop.create_task(self.exit_gracefully())
                     break
                 else:
@@ -349,11 +356,13 @@ class Worker:
     def _handle_exit_signal(self, signum: int, frame: FrameType | None) -> None:
         sig_name = "SIGTERM" if signum == signal.SIGTERM else "SIGINT"
         logger.info(f"received signal {sig_name}...")
-        self.loop.create_task(self.exit_gracefully())
+        if self.loop:
+            self.loop.create_task(self.exit_gracefully())
 
     def _handle_force_quit_signal(self, signum: int, frame: FrameType | None) -> None:
         logger.info("received SIGQUIT...")
-        self.loop.create_task(self._exit_forcefully())
+        if self.loop:
+            self.loop.create_task(self._exit_forcefully())
 
     async def _close(self) -> None:
         logger.info(f"closing worker '{self.name}'...")

{hatchet_sdk-1.0.1 → hatchet_sdk-1.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hatchet-sdk"
-version = "1.0.1"
+version = "1.0.3"
 description = ""
 authors = ["Alexander Belanger <alexander@hatchet.run>"]
 readme = "README.md"
@@ -35,6 +35,7 @@ opentelemetry-exporter-otlp = { version = "^1.28.0", optional = true }
 opentelemetry-exporter-otlp-proto-http = { version = "^1.28.0", optional = true }
 prometheus-client = "^0.21.1"
 pydantic-settings = "^2.7.1"
+pytest-timeout = "^2.3.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.5"
@@ -106,6 +107,12 @@ exclude = [
     "hatchet_sdk/v0/*",
 ]
 strict = true
+enable_error_code = [
+    "possibly-undefined",
+    "truthy-bool",
+    "redundant-expr",
+    "truthy-iterable",
+]
 
 [tool.ruff]
 exclude = [
@@ -148,3 +155,4 @@ v2_simple = "examples.v2.simple.worker:main"
 otel = "examples.opentelemetry_instrumentation.worker:main"
 waits = "examples.waits.worker:main"
 durable = "examples.durable.worker:main"
+streaming = "examples.streaming.worker:main"