Add top level sleep fn

Author: Sushisource

temporalio/worker/_workflow_instance.py

@@ -1439,6 +1439,20 @@ def workflow_upsert_search_attributes(
                         else [update.value]
                     )
 
+    async def workflow_sleep(
+        self, duration: float, *, summary: Optional[str] = None
+    ) -> None:
+        user_metadata = (
+            temporalio.api.sdk.v1.UserMetadata(
+                summary=self._payload_converter.to_payload(summary)
+            )
+            if summary
+            else None
+        )
+        self._timer_impl(
+            duration, lambda _: None, options=_TimerOptions(user_metadata=user_metadata)
+        )
+
     async def workflow_wait_condition(
         self,
         fn: Callable[[], bool],

temporalio/workflow.py

@@ -750,6 +750,11 @@ def workflow_upsert_search_attributes(
         ],
     ) -> None: ...
 
+    @abstractmethod
+    async def workflow_sleep(
+        self, duration: float, *, summary: Optional[str] = None
+    ) -> None: ...
+
     @abstractmethod
     async def workflow_wait_condition(
         self,
@@ -1071,15 +1076,6 @@ def update(
 ]: ...
 
 
-@overload
-def update(
-    *, description: str
-) -> Callable[
-    [Callable[MultiParamSpec, ReturnType]],
-    UpdateMethodMultiParam[MultiParamSpec, ReturnType],
-]: ...
-
-
 def update(
     fn: Optional[CallableSyncOrAsyncType] = None,
     *,
@@ -1170,6 +1166,24 @@ def uuid4() -> uuid.UUID:
     return uuid.UUID(bytes=random().getrandbits(16 * 8).to_bytes(16, "big"), version=4)
 
 
+async def sleep(
+    duration: Union[float, timedelta], *, summary: Optional[str] = None
+) -> None:
+    """Sleep for the given duration.
+
+    Args:
+        duration: Duration to sleep in seconds or as a timedelta.
+        summary: A single-line fixed summary for this timer that may appear in UI/CLI.
+            This can be in single-line Temporal markdown format.
+    """
+    await _Runtime.current().workflow_sleep(
+        duration=duration.total_seconds()
+        if isinstance(duration, timedelta)
+        else duration,
+        summary=summary,
+    )
+
+
 async def wait_condition(
     fn: Callable[[], bool],
     *,
@@ -1992,7 +2006,7 @@ def start_activity(
             need to. Contact Temporal before setting this value.
         versioning_intent: When using the Worker Versioning feature, specifies whether this Activity
             should run on a worker with a compatible Build Id or not.
-        summary:  Gets or sets a single-line fixed summary for this activity that may appear in UI/CLI.
+        summary: A single-line fixed summary for this activity that may appear in UI/CLI.
             This can be in single-line Temporal markdown format.
 
     Returns:

tests/worker/test_workflow.py

@@ -6195,6 +6195,7 @@ async def run(self) -> None:
             raise RuntimeError("Expected timeout")
         except asyncio.TimeoutError:
             pass
+        await workflow.sleep(0.01, summary="timer2")
         self._waiting = True
         workflow.set_current_details("such detail")
         await workflow.wait_condition(lambda: self._done)
@@ -6263,6 +6264,7 @@ async def waiting() -> bool:
                 execution=WorkflowExecution(workflow_id=handle.id),
             )
         )
+        timer_summs = set()
         for event in resp.history.events:
             if event.event_type == EventType.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED:
                 assert "cool workflow bro" in PayloadConverter.default.from_payload(
@@ -6276,6 +6278,7 @@ async def waiting() -> bool:
                     event.user_metadata.summary
                 )
             elif event.event_type == EventType.EVENT_TYPE_TIMER_STARTED:
-                assert "hi!" in PayloadConverter.default.from_payload(
-                    event.user_metadata.summary
+                timer_summs.add(
+                    PayloadConverter.default.from_payload(event.user_metadata.summary)
                 )
+        assert timer_summs == {"hi!", "timer2"}