hatchet-sdk 0.41.0__py3-none-any.whl → 0.42.1__py3-none-any.whl

hatchet_sdk/workflow.py

@@ -1,17 +1,51 @@
 import functools
-from typing import Any, Callable, List, Tuple
+from typing import Any, Callable, Protocol, Type, TypeVar, Union, cast, get_type_hints
+
+from pydantic import BaseModel
 
 from hatchet_sdk import ConcurrencyLimitStrategy
-from hatchet_sdk.contracts.workflows_pb2 import (
+from hatchet_sdk.contracts.workflows_pb2 import (  # type: ignore[attr-defined]
     CreateWorkflowJobOpts,
     CreateWorkflowStepOpts,
     CreateWorkflowVersionOpts,
+    StickyStrategy,
     WorkflowConcurrencyOpts,
     WorkflowKind,
 )
 from hatchet_sdk.logger import logger
+from hatchet_sdk.utils.typing import is_basemodel_subclass
+
+
+class WorkflowStepProtocol(Protocol):
+    def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
+
+    __name__: str
+
+    _step_name: str
+    _step_timeout: str | None
+    _step_parents: list[str]
+    _step_retries: int | None
+    _step_rate_limits: list[str] | None
+    _step_desired_worker_labels: dict[str, str]
+    _step_backoff_factor: float | None
+    _step_backoff_max_seconds: int | None
+
+    _concurrency_fn_name: str
+    _concurrency_max_runs: int | None
+    _concurrency_limit_strategy: str | None
+
+    _on_failure_step_name: str
+    _on_failure_step_timeout: str | None
+    _on_failure_step_retries: int
+    _on_failure_step_rate_limits: list[str] | None
+    _on_failure_step_backoff_factor: float | None
+    _on_failure_step_backoff_max_seconds: int | None
+
+
+StepsType = list[tuple[str, WorkflowStepProtocol]]
 
-stepsType = List[Tuple[str, Callable[..., Any]]]
+T = TypeVar("T")
+TW = TypeVar("TW", bound="WorkflowInterface")
 
 
 class ConcurrencyExpression:
@@ -35,28 +69,48 @@ class ConcurrencyExpression:
         self.limit_strategy = limit_strategy
 
 
+class WorkflowInterface(Protocol):
+    def get_name(self, namespace: str) -> str: ...
+
+    def get_actions(self, namespace: str) -> list[tuple[str, Callable[..., Any]]]: ...
+
+    def get_create_opts(self, namespace: str) -> Any: ...
+
+    on_events: list[str]
+    on_crons: list[str]
+    name: str
+    version: str
+    timeout: str
+    schedule_timeout: str
+    sticky: Union[StickyStrategy.Value, None]
+    default_priority: int | None
+    concurrency_expression: ConcurrencyExpression | None
+    input_validator: Type[BaseModel] | None
+
+
 class WorkflowMeta(type):
-    def __new__(cls, name, bases, attrs):
-        concurrencyActions: stepsType = [
-            (getattr(func, "_concurrency_fn_name"), attrs.pop(func_name))
-            for func_name, func in list(attrs.items())
-            if hasattr(func, "_concurrency_fn_name")
-        ]
-        steps: stepsType = [
-            (getattr(func, "_step_name"), attrs.pop(func_name))
-            for func_name, func in list(attrs.items())
-            if hasattr(func, "_step_name")
-        ]
-        onFailureSteps: stepsType = [
-            (getattr(func, "_on_failure_step_name"), attrs.pop(func_name))
-            for func_name, func in list(attrs.items())
-            if hasattr(func, "_on_failure_step_name")
-        ]
+    def __new__(
+        cls: Type["WorkflowMeta"],
+        name: str,
+        bases: tuple[type, ...],
+        attrs: dict[str, Any],
+    ) -> "WorkflowMeta":
+        def _create_steps_actions_list(name: str) -> StepsType:
+            return [
+                (getattr(func, name), attrs.pop(func_name))
+                for func_name, func in list(attrs.items())
+                if hasattr(func, name)
+            ]
+
+        concurrencyActions = _create_steps_actions_list("_concurrency_fn_name")
+        steps = _create_steps_actions_list("_step_name")
+
+        onFailureSteps = _create_steps_actions_list("_on_failure_step_name")
 
         # Define __init__ and get_step_order methods
         original_init = attrs.get("__init__")  # Get the original __init__ if it exists
 
-        def __init__(self, *args, **kwargs):
+        def __init__(self: TW, *args: Any, **kwargs: Any) -> None:
             if original_init:
                 original_init(self, *args, **kwargs)  # Call original __init__
 
@@ -64,7 +118,7 @@ class WorkflowMeta(type):
             return f"{namespace}{name.lower()}"
 
         @functools.cache
-        def get_actions(self, namespace: str) -> stepsType:
+        def get_actions(self: TW, namespace: str) -> StepsType:
             serviceName = get_service_name(namespace)
             func_actions = [
                 (serviceName + ":" + func_name, func) for func_name, func in steps
@@ -87,8 +141,8 @@ class WorkflowMeta(type):
         for step_name, step_func in steps:
             attrs[step_name] = step_func
 
-        def get_name(self, namespace: str):
-            return namespace + attrs["name"]
+        def get_name(self: TW, namespace: str) -> str:
+            return namespace + cast(str, attrs["name"])
 
         attrs["get_name"] = get_name
 
@@ -99,11 +153,11 @@ class WorkflowMeta(type):
         default_priority = attrs["default_priority"]
 
         @functools.cache
-        def get_create_opts(self, namespace: str):
+        def get_create_opts(self: TW, namespace: str) -> CreateWorkflowVersionOpts:
             serviceName = get_service_name(namespace)
             name = self.get_name(namespace)
             event_triggers = [namespace + event for event in attrs["on_events"]]
-            createStepOpts: List[CreateWorkflowStepOpts] = [
+            createStepOpts: list[CreateWorkflowStepOpts] = [
                 CreateWorkflowStepOpts(
                     readable_id=step_name,
                     action=serviceName + ":" + step_name,
@@ -113,6 +167,8 @@ class WorkflowMeta(type):
                     retries=func._step_retries,
                     rate_limits=func._step_rate_limits,
                     worker_labels=func._step_desired_worker_labels,
+                    backoff_factor=func._step_backoff_factor,
+                    backoff_max_seconds=func._step_backoff_max_seconds,
                 )
                 for step_name, func in steps
             ]
@@ -140,7 +196,7 @@ class WorkflowMeta(type):
                     "Error: Both concurrencyActions and concurrency_expression are defined. Please use only one concurrency configuration method."
                 )
 
-            on_failure_job: List[CreateWorkflowJobOpts] | None = None
+            on_failure_job: list[CreateWorkflowJobOpts] | None = None
 
             if len(onFailureSteps) > 0:
                 func_name, func = onFailureSteps[0]
@@ -155,6 +211,8 @@ class WorkflowMeta(type):
                             parents=[],
                             retries=func._on_failure_step_retries,
                             rate_limits=func._on_failure_step_rate_limits,
+                            backoff_factor=func._on_failure_step_backoff_factor,
+                            backoff_max_seconds=func._on_failure_step_backoff_max_seconds,
                         )
                     ],
                 )

{hatchet_sdk-0.41.0.dist-info → hatchet_sdk-0.42.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 0.41.0
+Version: 0.42.1
 Summary: 
 Author: Alexander Belanger
 Author-email: alexander@hatchet.run

{hatchet_sdk-0.41.0.dist-info → hatchet_sdk-0.42.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
 hatchet_sdk/__init__.py,sha256=R5ogd_Dn_6gA_u9a5W2URNq6eDtN1i56cObBv1tOwyU,9408
 hatchet_sdk/client.py,sha256=ajjLd-gZptVuAx25gG_SdAW8xDA4V7HMIhgYuh9MkVY,3486
-hatchet_sdk/clients/admin.py,sha256=RbtF3DDryv7C2PS9aNJMG6QfJd_Vmb-0ym78MjZ1qro,21425
-hatchet_sdk/clients/dispatcher/action_listener.py,sha256=K8qpUumWeUsXcxvqapFz8kNQNs8fWpygLQVKtZsyrAA,15388
-hatchet_sdk/clients/dispatcher/dispatcher.py,sha256=jvvby7JVeeyy2Blc42KPWHO7dcHvvmgy1r_hWrzkk0U,6076
+hatchet_sdk/clients/admin.py,sha256=rN1T5U7lnrg1FEOUGCD6diqfIsge8SjwnCwn52j0STo,21458
+hatchet_sdk/clients/dispatcher/action_listener.py,sha256=eOq5z29MhC7ynbOOegDRQr-RqDhpS3gfeLswIlZbuGg,15378
+hatchet_sdk/clients/dispatcher/dispatcher.py,sha256=IA_KFqjuxKmGVLuOQNV0SG_dFpX6PeOR8M6Kpl0fU20,6092
 hatchet_sdk/clients/event_ts.py,sha256=ACGvDdfhvK6ZLKdsPxy-PksLhjIU69P9cdH3AxX-X10,728
 hatchet_sdk/clients/events.py,sha256=vPK2UlI1bmrx24mAqGYJQ884yHviVmrGX5qNIBc5-a8,7466
 hatchet_sdk/clients/rest/__init__.py,sha256=IR4dbdTrEse-Eb7wRRwjdKnzKnTU-_HZaKYZzAcLtEI,13840
@@ -179,26 +179,26 @@ hatchet_sdk/clients/rest/models/workflow_version_definition.py,sha256=e18BUh1XO0
 hatchet_sdk/clients/rest/models/workflow_version_meta.py,sha256=TW4R7bAuYAg_LraN-8psdZqp2E8wH9hYyL5Sji86aLk,3791
 hatchet_sdk/clients/rest/models/workflow_workers_count.py,sha256=qhzqfvjjIDyARkiiLGluMIqEmqO-diHTsjlu0Doi0yg,2875
 hatchet_sdk/clients/rest/rest.py,sha256=G83F1k4g_ePzvXW95rApzvaRDQPcaxrj-JmZyq1LvGw,6606
-hatchet_sdk/clients/rest/tenacity_utils.py,sha256=pPDW8CUR4EPY4lzAddgxbOiavXIjX-Cd_zAPkudPkpU,912
+hatchet_sdk/clients/rest/tenacity_utils.py,sha256=AmVMjML3pd8qzsWyvaEnaI33zkidou5EK_EQXF69SAE,1032
 hatchet_sdk/clients/rest_client.py,sha256=wYCRQjjZha9XcYg6pdVgrFV4pcli89Y_G45EDEDteCk,21874
 hatchet_sdk/clients/run_event_listener.py,sha256=51WTg52_aISgYPOFPHJ21rb4IO6aEd7Ugp7FCf4HnfM,10184
 hatchet_sdk/clients/workflow_listener.py,sha256=Q_WJcGlZNHJGSpxzDac9wELjgxhP0vLaNTXRy_xnxc8,9466
 hatchet_sdk/connection.py,sha256=593aUGAj7Ouf00lcVwx_pmhdQ9NOC5ANT1Jrf8nwkHs,2165
 hatchet_sdk/context/__init__.py,sha256=Pl_seJ_SJpW34BBZp4KixuZ8GiRK9sJFfegf9u3m7zk,29
-hatchet_sdk/context/context.py,sha256=nZxq3lKTCdE7C01-60Wp1Hvcs3nj-NH85JXQovuncFk,11873
-hatchet_sdk/context/worker_context.py,sha256=ABpRevkXWCz313wUU0O1DfwOiTEG9b-mvqJfifTyGVA,913
-hatchet_sdk/contracts/dispatcher_pb2.py,sha256=M7Q3CINYJ9Syc84mn0P3z4JTd-7Pt7gEdA6AJuZ9fZ0,13502
-hatchet_sdk/contracts/dispatcher_pb2.pyi,sha256=68jyixQpHzysCcDrepEBlA7iGvHznWnaCkTPshfK3Lw,17215
+hatchet_sdk/context/context.py,sha256=l0aewPZpncvVzH-L68U-TKH1bMHUuB-4rwXNZ1n69r0,13561
+hatchet_sdk/context/worker_context.py,sha256=1nwq75wnT2zu9Z1fel_TKw0eiMpXJIGAn6HbH1GRVNU,920
+hatchet_sdk/contracts/dispatcher_pb2.py,sha256=W9_Us2_HIdUV5idN2rPwzt4J06JfDeogxwDVvjerk_U,14320
+hatchet_sdk/contracts/dispatcher_pb2.pyi,sha256=6cRfHDhiLElKifrAtdiLFY8QF2_x1KkPBPplG49Ml3I,18240
 hatchet_sdk/contracts/dispatcher_pb2_grpc.py,sha256=4uJkNig8nssJwS7P-lea1YqE4wl0cVWQaJpOndOdaDs,21453
 hatchet_sdk/contracts/events_pb2.py,sha256=w_DmfXMfxlAyHWcuv_hPt7ouABAMmOEjGKVOHjYJc-4,4073
 hatchet_sdk/contracts/events_pb2.pyi,sha256=ekw9YVS2vJdk0BLLqf7_Atg8qCN5xIq7EnIP4Vhg_4g,4030
 hatchet_sdk/contracts/events_pb2_grpc.py,sha256=q5Vfu2KXS3JzP7XdHEpleAlYxgyBqIxq5WpRoz-XlH8,8327
-hatchet_sdk/contracts/workflows_pb2.py,sha256=67r5paHqWMgx8JG6MmX8JtE3BO16b6F-uXM4yCjgmVg,11076
-hatchet_sdk/contracts/workflows_pb2.pyi,sha256=znHwxPUKjB8X1mq7XSw18qx8XUSjiSH-HUYksG00gUU,14328
+hatchet_sdk/contracts/workflows_pb2.py,sha256=oHpiARGasVy8MWkYQszalEEvN4wAvzVecDmOUmlO9hs,11694
+hatchet_sdk/contracts/workflows_pb2.pyi,sha256=JS-kP0IL7dtU3HUhJ4PCpAgF3ZLdZ6NbXvvkD43KwVA,15355
 hatchet_sdk/contracts/workflows_pb2_grpc.py,sha256=rOC2yF2VqxyGsxHnr1XbKFFh8-eLGic2SXgfS1gU3xM,8864
 hatchet_sdk/features/cron.py,sha256=4lKMH0MqiN8cHJk2jhF0Ueqs6z5ozwJzlOeSeaWqvO0,10217
 hatchet_sdk/features/scheduled.py,sha256=YhEbNWl8dWOH61rXVjAyu8iG1BZqpSkD4kgaxkKIHgY,9504
-hatchet_sdk/hatchet.py,sha256=svu4mX8dPw4qrCJ3wwyqXZ9KKeZ0NckORu6tzAEynNE,9570
+hatchet_sdk/hatchet.py,sha256=UYSHRyqfjvcidOB1PrMLtF1WPacsXoVD_okhjdPxhfI,9599
 hatchet_sdk/labels.py,sha256=OuOtOHeZAd1aYi3j_EhgzIGo1_1wDlYokV74xHSuf8Y,259
 hatchet_sdk/loader.py,sha256=dGs6Tt8wdEgHeCBesbbQsP6ZYiARBvoqwIdXIO1P5Os,7913
 hatchet_sdk/logger.py,sha256=5uOr52T4mImSQm1QvWT8HvZFK5WfPNh3Y1cBQZRFgUQ,333
@@ -207,22 +207,24 @@ hatchet_sdk/rate_limit.py,sha256=ycFv2NHyBxv31U7h8xVDO661rwif_lfCQf52gWIkB6g,181
 hatchet_sdk/semver.py,sha256=PrgBL0TnyXl3p_OK1iSMk9Gpujfh5asQpJ4DHJLCW2k,998
 hatchet_sdk/token.py,sha256=Ap3jnbaPAL10F2G_D71wj7OpBcvrI3RuE0keqXx1lAE,698
 hatchet_sdk/utils/aio_utils.py,sha256=8woLr_rO3CgzpA_2igTcU133oCxNnQoWCt-PZAWrZ_Q,4072
-hatchet_sdk/utils/backoff.py,sha256=bBfilECV_6JvoG0W3bAHQqDixkdtGeEh0zzbnamQaFs,345
-hatchet_sdk/utils/serialization.py,sha256=FtVi44lkOCuH7lvrRhbldW_-d_fUaNtPMfnSm29ked4,394
-hatchet_sdk/utils/tracing.py,sha256=yrX3CL-daT7YCPW08qkpIq9wi2IuZoC2DRMC8oR42eA,2189
-hatchet_sdk/v2/callable.py,sha256=t3O9_IczXCgeYXJQNmVcllDp_5c4a_qNpzQ099Xsams,6969
+hatchet_sdk/utils/backoff.py,sha256=6B5Rb5nLKw_TqqgpJMYjIBV1PTTtbOMRZCveisVhg_I,353
+hatchet_sdk/utils/serialization.py,sha256=P2Uq0yxg-Cea5Lmf6IOh2r7W17MNF1Hv2qxSny6BUk8,451
+hatchet_sdk/utils/tracing.py,sha256=UjTw2vMLg1p6GjOGwt634nYJaNZh8c70PBxOBVLiDQ4,2261
+hatchet_sdk/utils/types.py,sha256=qhx1OoeXh77AN6s4SMaGpB3zK3hPm7ocv-23JFa6_wE,191
+hatchet_sdk/utils/typing.py,sha256=qXhnoQJXjXwuzyZUQ2H3YQ6YW7vL9D_kvmh2kJM5Z9s,233
+hatchet_sdk/v2/callable.py,sha256=Lnt-kUdM-UJIqCIWZnXgVQHJ11GK9akW66i1oz45WAg,7011
 hatchet_sdk/v2/concurrency.py,sha256=aDr8vunzEJOoe2iGxip6M2fbGTde19kJu-UxCNkXQjM,1282
 hatchet_sdk/v2/hatchet.py,sha256=begVaMZmBllykNuyfAvqhL88m5ELBmx7RrJvsL4xdmY,6872
 hatchet_sdk/worker/__init__.py,sha256=1Ze1seDuXx5yD1IfHmqGFgK5qrRazVW4ZcDVGl-Pddw,61
-hatchet_sdk/worker/action_listener_process.py,sha256=irNd_n42HzXHuBY8OFhhyYIWzQYV3rmba38y68HSBKA,10059
-hatchet_sdk/worker/runner/run_loop_manager.py,sha256=KGRiCXr9jqpB1nYUL6eoSUCgkp2_iuUglSC_Nnxer6c,3232
-hatchet_sdk/worker/runner/runner.py,sha256=srtCZ6W9VIS65nHdLRyf4tbVlIS_QQbH3AwiPilbBOE,17666
+hatchet_sdk/worker/action_listener_process.py,sha256=tmlzDgyHWxGl8fJWE9NKqjvhqpGi9SMmOh5dFyiVL-Q,9979
+hatchet_sdk/worker/runner/run_loop_manager.py,sha256=nV7fhNxJKCcrBm0ci118aszF_7AxenBkOTIe1UsBEt4,3490
+hatchet_sdk/worker/runner/runner.py,sha256=fOzfn9Eh6LWhxYl1dRF_EzKBq-EeTIDzeEuX8V0Wm1o,18547
 hatchet_sdk/worker/runner/utils/capture_logs.py,sha256=s_BGxeykelVbusx6u31EPx3vv9c2BHkuBnYcaLW680E,2381
 hatchet_sdk/worker/runner/utils/error_with_traceback.py,sha256=Iih_s8JNqrinXETFJ3ZS88EhaTekfM6m5fqIP7QWoIM,181
-hatchet_sdk/worker/worker.py,sha256=YUkShUFcAVzr9QUeanIaMnNS9mVJTRyoF8vODwzNOjs,10373
-hatchet_sdk/workflow.py,sha256=nx7jUPQ6NLfy1I93oeT5ZQDWFM_KL0TfMqzM0QigOjk,7336
+hatchet_sdk/worker/worker.py,sha256=fBqTuSnE4lfl-CMTg0FYuw1jE20_CJOwyu2QuzTGdpU,11335
+hatchet_sdk/workflow.py,sha256=qH7lEtR8lvwfP0lHPN2dXJjEh2xmHST19ADW7z82OgM,9209
 hatchet_sdk/workflow_run.py,sha256=BwK5cefvXXvyQ1Ednj_7LeejMwQJqWnvUC_FTBmJNxk,1805
-hatchet_sdk-0.41.0.dist-info/METADATA,sha256=BW1_X8kuKyLpoV16GRelVgw5T8QrqQgdoHdc4cwnhOw,1471
-hatchet_sdk-0.41.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-hatchet_sdk-0.41.0.dist-info/entry_points.txt,sha256=APa-bxAkIadhvJInIRzCWG5Jfe0DlVR_epeMk3rAsAI,828
-hatchet_sdk-0.41.0.dist-info/RECORD,,
+hatchet_sdk-0.42.1.dist-info/METADATA,sha256=BaDtr-PCud9AbcDoCGbMWi-P7Q-z29y2VtJlapr9m_8,1471
+hatchet_sdk-0.42.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+hatchet_sdk-0.42.1.dist-info/entry_points.txt,sha256=CBdxVD3JfWwRLJsOlSKj5OJh2gY_64rQkyXw5DfNpQ4,930
+hatchet_sdk-0.42.1.dist-info/RECORD,,

{hatchet_sdk-0.41.0.dist-info → hatchet_sdk-0.42.1.dist-info}/entry_points.txt

@@ -15,7 +15,9 @@ logger=examples.logger.worker:main
 manual_trigger=examples.manual_trigger.worker:main
 on_failure=examples.on_failure.worker:main
 programatic_replay=examples.programatic_replay.worker:main
+pydantic=examples.pydantic.worker:main
 rate_limit=examples.rate_limit.worker:main
+retries_with_backoff=examples.retries_with_backoff.worker:main
 simple=examples.simple.worker:main
 timeout=examples.timeout.worker:main