more helpful type hint

Author: mrkaye97

hatchet_sdk/clients/admin.py

@@ -31,7 +31,7 @@
     inject_carrier_into_metadata,
     parse_carrier_from_metadata,
 )
-from hatchet_sdk.utils.types import AdditionalMetadata, Input
+from hatchet_sdk.utils.types import JSONSerializableDict
 from hatchet_sdk.workflow_run import RunRef, WorkflowRunRef
 
 from ..loader import ClientConfig
@@ -52,26 +52,26 @@ class ScheduleTriggerWorkflowOptions(BaseModel):
 
 
 class ChildTriggerWorkflowOptions(BaseModel):
-    additional_metadata: AdditionalMetadata = Field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = Field(default_factory=dict)
     sticky: bool | None = None
 
 
 class ChildWorkflowRunDict(BaseModel):
     workflow_name: str
-    input: Input
+    input: JSONSerializableDict
     options: ChildTriggerWorkflowOptions
     key: str | None = None
 
 
 class TriggerWorkflowOptions(ScheduleTriggerWorkflowOptions):
-    additional_metadata: AdditionalMetadata = Field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = Field(default_factory=dict)
     desired_worker_id: str | None = None
     namespace: str | None = None
 
 
 class WorkflowRunDict(BaseModel):
     workflow_name: str
-    input: Input
+    input: JSONSerializableDict
     options: TriggerWorkflowOptions
 
 
@@ -133,7 +133,7 @@ def _prepare_schedule_workflow_request(
         self,
         name: str,
         schedules: list[Union[datetime, timestamp_pb2.Timestamp]],
-        input: Input = {},
+        input: JSONSerializableDict = {},
         options: ScheduleTriggerWorkflowOptions = ScheduleTriggerWorkflowOptions(),
     ) -> ScheduleWorkflowRequest:
         timestamp_schedules = []
@@ -175,7 +175,7 @@ def __init__(self, config: ClientConfig):
     async def run(
         self,
         function: Union[str, Callable[[Any], T]],
-        input: Input,
+        input: JSONSerializableDict,
         options: TriggerWorkflowOptions = TriggerWorkflowOptions(),
     ) -> "RunRef[T]":
         workflow_name = cast(
@@ -197,7 +197,7 @@ async def run(
     async def run_workflow(
         self,
         workflow_name: str,
-        input: Input,
+        input: JSONSerializableDict,
         options: TriggerWorkflowOptions = TriggerWorkflowOptions(),
     ) -> WorkflowRunRef:
         ctx = parse_carrier_from_metadata(options.additional_metadata)
@@ -335,7 +335,7 @@ async def schedule_workflow(
         self,
         name: str,
         schedules: list[Union[datetime, timestamp_pb2.Timestamp]],
-        input: Input = {},
+        input: JSONSerializableDict = {},
         options: ScheduleTriggerWorkflowOptions = ScheduleTriggerWorkflowOptions(),
     ) -> WorkflowVersion:
         try:
@@ -410,7 +410,7 @@ def schedule_workflow(
         self,
         name: str,
         schedules: list[Union[datetime, timestamp_pb2.Timestamp]],
-        input: Input = {},
+        input: JSONSerializableDict = {},
         options: ScheduleTriggerWorkflowOptions = ScheduleTriggerWorkflowOptions(),
     ) -> WorkflowVersion:
         try:
@@ -442,7 +442,7 @@ def schedule_workflow(
     def run_workflow(
         self,
         workflow_name: str,
-        input: Input,
+        input: JSONSerializableDict,
         options: TriggerWorkflowOptions = TriggerWorkflowOptions(),
     ) -> WorkflowRunRef:
         ctx = parse_carrier_from_metadata(options.additional_metadata)
@@ -542,7 +542,7 @@ def run_workflows(
     def run(
         self,
         function: Union[str, Callable[[Any], T]],
-        input: Input,
+        input: JSONSerializableDict,
         options: TriggerWorkflowOptions = TriggerWorkflowOptions(),
     ) -> "RunRef[T]":
         workflow_name = cast(

hatchet_sdk/clients/dispatcher/action_listener.py

@@ -24,7 +24,7 @@
 from hatchet_sdk.logger import logger
 from hatchet_sdk.utils.backoff import exp_backoff_sleep
 from hatchet_sdk.utils.serialization import flatten
-from hatchet_sdk.utils.types import AdditionalMetadata
+from hatchet_sdk.utils.types import JSONSerializableDict
 
 from ...loader import ClientConfig
 from ...metadata import get_metadata
@@ -72,7 +72,7 @@ class Action:
     action_payload: str
     action_type: ActionType
     retry_count: int
-    additional_metadata: AdditionalMetadata = field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = field(default_factory=dict)
 
     child_workflow_index: int | None = None
     child_workflow_key: str | None = None

hatchet_sdk/clients/events.py

@@ -25,7 +25,7 @@
     inject_carrier_into_metadata,
     parse_carrier_from_metadata,
 )
-from hatchet_sdk.utils.types import AdditionalMetadata
+from hatchet_sdk.utils.types import JSONSerializableDict
 
 from ..loader import ClientConfig
 from ..metadata import get_metadata
@@ -47,7 +47,7 @@ def proto_timestamp_now() -> timestamp_pb2.Timestamp:
 
 
 class PushEventOptions(BaseModel):
-    additional_metadata: AdditionalMetadata = Field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = Field(default_factory=dict)
     namespace: str | None = None
 
 
@@ -59,7 +59,7 @@ class BulkPushEventOptions(BaseModel):
 class BulkPushEventWithMetadata(BaseModel):
     key: str
     payload: Any
-    additional_metadata: AdditionalMetadata = Field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = Field(default_factory=dict)
 
 
 class EventClient:

hatchet_sdk/clients/rest_client.py

@@ -66,7 +66,7 @@
     WorkflowRunsCancelRequest,
 )
 from hatchet_sdk.clients.rest.models.workflow_version import WorkflowVersion
-from hatchet_sdk.utils.types import AdditionalMetadata, Input
+from hatchet_sdk.utils.types import JSONSerializableDict
 
 
 class AsyncRestApi:
@@ -212,7 +212,7 @@ async def workflow_run_bulk_cancel(
     async def workflow_run_create(
         self,
         workflow_id: str,
-        input: Input,
+        input: JSONSerializableDict,
         version: str | None = None,
         additional_metadata: list[str] | None = None,
     ) -> WorkflowRun:
@@ -230,8 +230,8 @@ async def cron_create(
         workflow_name: str,
         cron_name: str,
         expression: str,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ):
         return await self.workflow_run_api.cron_workflow_trigger_create(
             tenant=self.tenant_id,
@@ -279,8 +279,8 @@ async def schedule_create(
         self,
         name: str,
         trigger_at: datetime.datetime,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ):
         return await self.workflow_run_api.scheduled_workflow_run_create(
             tenant=self.tenant_id,
@@ -471,7 +471,7 @@ def workflow_run_bulk_cancel(
     def workflow_run_create(
         self,
         workflow_id: str,
-        input: Input,
+        input: JSONSerializableDict,
         version: str | None = None,
         additional_metadata: list[str] | None = None,
     ) -> WorkflowRun:
@@ -486,8 +486,8 @@ def cron_create(
         workflow_name: str,
         cron_name: str,
         expression: str,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ) -> CronWorkflows:
         return self._run_coroutine(
             self.aio.cron_create(
@@ -525,8 +525,8 @@ def schedule_create(
         self,
         workflow_name: str,
         trigger_at: datetime.datetime,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ):
         return self._run_coroutine(
             self.aio.schedule_create(

hatchet_sdk/context/context.py

@@ -18,7 +18,7 @@
     BulkTriggerWorkflowRequest,
     TriggerWorkflowRequest,
 )
-from hatchet_sdk.utils.types import Input, WorkflowValidator
+from hatchet_sdk.utils.types import JSONSerializableDict, WorkflowValidator
 from hatchet_sdk.utils.typing import is_basemodel_subclass
 from hatchet_sdk.workflow_run import WorkflowRunRef
 
@@ -101,7 +101,7 @@ def __init__(
     async def spawn_workflow(
         self,
         workflow_name: str,
-        input: Input = {},
+        input: JSONSerializableDict = {},
         key: str | None = None,
         options: ChildTriggerWorkflowOptions = ChildTriggerWorkflowOptions(),
     ) -> WorkflowRunRef:

hatchet_sdk/features/cron.py

@@ -11,10 +11,10 @@
 from hatchet_sdk.clients.rest.models.workflow_run_order_by_direction import (
     WorkflowRunOrderByDirection,
 )
-from hatchet_sdk.utils.types import AdditionalMetadata, Input
+from hatchet_sdk.utils.types import JSONSerializableDict
 
 
-class CreateCronTriggerInput(BaseModel):
+class CreateCronTriggerJSONSerializableDict(BaseModel):
     """
     Schema for creating a workflow run triggered by a cron.
 
@@ -25,8 +25,8 @@ class CreateCronTriggerInput(BaseModel):
     """
 
     expression: str = None
-    input: Input = Field(default_factory=dict)
-    additional_metadata: AdditionalMetadata = Field(default_factory=dict)
+    input: JSONSerializableDict = Field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = Field(default_factory=dict)
 
     @field_validator("expression")
     def validate_cron_expression(cls, v):
@@ -87,8 +87,8 @@ def create(
         workflow_name: str,
         cron_name: str,
         expression: str,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ) -> CronWorkflows:
         """
         Creates a new workflow cron trigger.
@@ -103,7 +103,7 @@ def create(
         Returns:
             CronWorkflows: The created cron workflow instance.
         """
-        validated_input = CreateCronTriggerInput(
+        validated_input = CreateCronTriggerJSONSerializableDict(
             expression=expression, input=input, additional_metadata=additional_metadata
         )
 
@@ -199,8 +199,8 @@ async def create(
         workflow_name: str,
         cron_name: str,
         expression: str,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ) -> CronWorkflows:
         """
         Asynchronously creates a new workflow cron trigger.
@@ -215,7 +215,7 @@ async def create(
         Returns:
             CronWorkflows: The created cron workflow instance.
         """
-        validated_input = CreateCronTriggerInput(
+        validated_input = CreateCronTriggerJSONSerializableDict(
             expression=expression, input=input, additional_metadata=additional_metadata
         )
 

hatchet_sdk/features/scheduled.py

@@ -15,10 +15,10 @@
 from hatchet_sdk.clients.rest.models.workflow_run_order_by_direction import (
     WorkflowRunOrderByDirection,
 )
-from hatchet_sdk.utils.types import AdditionalMetadata, Input
+from hatchet_sdk.utils.types import JSONSerializableDict
 
 
-class CreateScheduledTriggerInput(BaseModel):
+class CreateScheduledTriggerJSONSerializableDict(BaseModel):
     """
     Schema for creating a scheduled workflow run.
 
@@ -28,8 +28,8 @@ class CreateScheduledTriggerInput(BaseModel):
         trigger_at (Optional[datetime.datetime]): The datetime when the run should be triggered.
     """
 
-    input: Input = Field(default_factory=dict)
-    additional_metadata: AdditionalMetadata = Field(default_factory=dict)
+    input: JSONSerializableDict = Field(default_factory=dict)
+    additional_metadata: JSONSerializableDict = Field(default_factory=dict)
     trigger_at: datetime.datetime | None = None
 
 
@@ -58,8 +58,8 @@ def create(
         self,
         workflow_name: str,
         trigger_at: datetime.datetime,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ) -> ScheduledWorkflows:
         """
         Creates a new scheduled workflow run asynchronously.
@@ -74,7 +74,7 @@ def create(
             ScheduledWorkflows: The created scheduled workflow instance.
         """
 
-        validated_input = CreateScheduledTriggerInput(
+        validated_input = CreateScheduledTriggerJSONSerializableDict(
             trigger_at=trigger_at, input=input, additional_metadata=additional_metadata
         )
 
@@ -168,8 +168,8 @@ async def create(
         self,
         workflow_name: str,
         trigger_at: datetime.datetime,
-        input: Input,
-        additional_metadata: AdditionalMetadata,
+        input: JSONSerializableDict,
+        additional_metadata: JSONSerializableDict,
     ) -> ScheduledWorkflows:
         """
         Creates a new scheduled workflow run asynchronously.

hatchet_sdk/utils/types.py

@@ -8,5 +8,4 @@ class WorkflowValidator(BaseModel):
     step_output: Type[BaseModel] | None = None
 
 
-AdditionalMetadata = dict[str, Any]
-Input = dict[str, Any]
+JSONSerializableDict = dict[str, Any]

hatchet_sdk/v2/callable.py

@@ -26,7 +26,7 @@
 from hatchet_sdk.labels import DesiredWorkerLabel
 from hatchet_sdk.logger import logger
 from hatchet_sdk.rate_limit import RateLimit
-from hatchet_sdk.utils.types import Input
+from hatchet_sdk.utils.types import JSONSerializableDict
 from hatchet_sdk.v2.concurrency import ConcurrencyFunction
 from hatchet_sdk.workflow_run import RunRef
 
@@ -177,7 +177,7 @@ class DurableContext(Context):
     def run(
         self,
         function: str | Callable[[Context], Any],
-        input: Input = {},
+        input: JSONSerializableDict = {},
         key: str | None = None,
         options: ChildTriggerWorkflowOptions | None = None,
     ) -> "RunRef[T]":