Add warning notices to Nexus APIs

Author: dandavison

temporalio/client.py

@@ -7272,7 +7272,7 @@ class NexusCallback:
     """Nexus callback to attach to events such as workflow completion.
 
     .. warning::
-        This option is experimental and unstable.
+        This API is experimental and unstable.
     """
 
     url: str

temporalio/nexus/__init__.py

@@ -1,5 +1,8 @@
 """Temporal Nexus support
 
+.. warning::
+    Nexus APIs are experimental and unstable.
+
 See https://github.com/temporalio/sdk-python/tree/main#nexus
 """
 

temporalio/nexus/_operation_context.py

@@ -55,6 +55,9 @@
 class Info:
     """Information about the running Nexus operation.
 
+    .. warning::
+        This API is experimental and unstable.
+
     Retrieved inside a Nexus operation handler via :py:func:`info`.
     """
 
@@ -175,7 +178,11 @@ def _add_outbound_links(
 
 
 class WorkflowRunOperationContext(StartOperationContext):
-    """Context received by a workflow run operation."""
+    """Context received by a workflow run operation.
+
+    .. warning::
+        This API is experimental and unstable.
+    """
 
     def __init__(self, *args, **kwargs):
         """Initialize the workflow run operation context."""

temporalio/nexus/_token.py

@@ -17,6 +17,9 @@
 class WorkflowHandle(Generic[OutputT]):
     """A handle to a workflow that is backing a Nexus operation.
 
+    .. warning::
+        This API is experimental and unstable.
+
     Do not instantiate this directly. Use
     :py:func:`temporalio.nexus.WorkflowRunOperationContext.start_workflow` to create a
     handle.

temporalio/worker/_worker.py

@@ -164,6 +164,9 @@ def __init__(
                 may be async functions or non-async functions.
             nexus_service_handlers: Instances of Nexus service handler classes
                 decorated with :py:func:`@nexusrpc.handler.service_handler`.
+
+                .. warning::
+                    This parameter is experimental and unstable.
             workflows: Workflow classes decorated with
                 :py:func:`@workflow.defn<temporalio.workflow.defn>`.
             activity_executor: Concurrent executor to use for non-async
@@ -187,6 +190,9 @@ def __init__(
                 Nexus operations. This is required if any operation start methods
                 are non-`async def`. :py:class:`concurrent.futures.ThreadPoolExecutor`
                 is recommended.
+
+                .. warning::
+                    This parameter is experimental and unstable.
             workflow_runner: Runner for workflows.
             unsandboxed_workflow_runner: Runner for workflows that opt-out of
                 sandboxing.

temporalio/workflow.py

@@ -4386,7 +4386,11 @@ async def execute_child_workflow(
 
 
 class NexusOperationHandle(Generic[OutputT]):
-    """Handle for interacting with a Nexus operation."""
+    """Handle for interacting with a Nexus operation.
+
+    .. warning::
+        This API is experimental and unstable.
+    """
 
     def cancel(self) -> bool:
         """Request cancellation of the operation."""
@@ -5116,6 +5120,9 @@ def _to_proto(self) -> temporalio.bridge.proto.common.VersioningIntent.ValueType
 class NexusClient(ABC, Generic[ServiceT]):
     """A client for invoking Nexus operations.
 
+    .. warning::
+        This API is experimental and unstable.
+
     Example::
 
         nexus_client = workflow.create_nexus_client(
@@ -5420,6 +5427,9 @@ def create_nexus_client(
 ) -> NexusClient[ServiceT]:
     """Create a Nexus client.
 
+    .. warning::
+        This API is experimental and unstable.
+
     Args:
         service: The Nexus service.
         endpoint: The Nexus endpoint.