Edit TODOs

Author: dandavison

temporalio/nexus/_util.py

@@ -85,15 +85,13 @@ def _get_start_method_input_and_output_type_annotations(
     try:
         type_annotations = typing.get_type_hints(start)
     except TypeError:
-        # TODO(preview): stacklevel
         warnings.warn(
             f"Expected decorated start method {start} to have type annotations"
         )
         return None, None
     output_type = type_annotations.pop("return", None)
 
     if len(type_annotations) != 2:
-        # TODO(preview): stacklevel
         suffix = f": {type_annotations}" if type_annotations else ""
         warnings.warn(
             f"Expected decorated start method {start} to have exactly 2 "
@@ -104,7 +102,6 @@ def _get_start_method_input_and_output_type_annotations(
     else:
         ctx_type, input_type = type_annotations.values()
         if not issubclass(ctx_type, WorkflowRunOperationContext):
-            # TODO(preview): stacklevel
             warnings.warn(
                 f"Expected first parameter of {start} to be an instance of "
                 f"WorkflowRunOperationContext, but is {ctx_type}."

temporalio/worker/_workflow_instance.py

@@ -869,7 +869,7 @@ def _apply_resolve_nexus_operation_start(
             # Note that core will still send a `ResolveNexusOperation` job in the same
             # activation, so there does not need to be an exceptional case for this in
             # lang.
-            # TODO(dan): confirm appropriate to take no action here
+            # TODO(nexus-prerelease): confirm appropriate to take no action here
             pass
         else:
             raise ValueError(f"Unknown Nexus operation start status: {job}")
@@ -893,7 +893,6 @@ def _apply_resolve_nexus_operation(
             )
             handle._resolve_success(output)
         elif result.HasField("failed"):
-            # TODO(dan): test failure converter
             handle._resolve_failure(
                 self._failure_converter.from_failure(
                     result.failed, self._payload_converter
@@ -2991,9 +2990,9 @@ async def cancel(self) -> None:
         await self._instance._cancel_external_workflow(command)
 
 
-# TODO(dan): are we sure we don't want to inherit from asyncio.Task as ActivityHandle and
-# ChildWorkflowHandle do? I worry that we should provide .done(), .result(), .exception()
-# etc for consistency.
+# TODO(nexus-preview): are we sure we don't want to inherit from asyncio.Task as
+# ActivityHandle and ChildWorkflowHandle do? I worry that we should provide .done(),
+# .result(), .exception() etc for consistency.
 class _NexusOperationHandle(temporalio.workflow.NexusOperationHandle[OutputT]):
     def __init__(
         self,
@@ -3011,7 +3010,7 @@ def __init__(
 
     @property
     def operation_token(self) -> Optional[str]:
-        # TODO(dan): How should this behave?
+        # TODO(nexus-prerelease): How should this behave?
         # Java has a separate class that only exists if the operation token exists:
         # https://github.com/temporalio/sdk-java/blob/master/temporal-sdk/src/main/java/io/temporal/internal/sync/NexusOperationExecutionImpl.java#L26
         # And Go similar:

temporalio/workflow.py

@@ -1983,7 +1983,7 @@ class _AsyncioTask(asyncio.Task[AnyType]):
         pass
 
 else:
-    # TODO(dan): inherited classes should be other way around?
+    # TODO: inherited classes should be other way around?
     class _AsyncioTask(Generic[AnyType], asyncio.Task):
         pass
 

tests/nexus/test_handler.py

@@ -130,9 +130,6 @@ async def run(self, input: Input) -> Output:
         return Output(value=f"from link test workflow: {input.value}")
 
 
-# TODO: implement some of these ops as explicit OperationHandler classes to provide coverage for that?
-
-
 # The service_handler decorator is applied by the test
 class MyServiceHandler:
     @sync_operation

tests/nexus/test_workflow_caller.py

@@ -51,9 +51,9 @@
 from temporalio.worker import Worker
 from tests.helpers.nexus import create_nexus_endpoint, make_nexus_endpoint_name
 
-# TODO(dan): test availability of Temporal client etc in async context set by worker
-# TODO(dan): test worker shutdown, wait_all_completed, drain etc
-# TODO(dan): test worker op handling failure
+# TODO(nexus-prerelease): test availability of Temporal client etc in async context set by worker
+# TODO(nexus-prerelease): test worker shutdown, wait_all_completed, drain etc
+# TODO(nexus-prerelease): test worker op handling failure
 
 # -----------------------------------------------------------------------------
 # Test definition
@@ -145,7 +145,7 @@ async def run(
         )
 
 
-# TODO: make types pass pyright strict mode
+# TODO(nexus-prerelease): check type-checking passing in CI
 
 
 class SyncOrAsyncOperation(OperationHandler[OpInput, OpOutput]):
@@ -156,7 +156,7 @@ async def start(
         StartOperationResultAsync,
     ]:
         if input.response_type.exception_in_operation_start:
-            # TODO(dan): don't think RPCError should be used here
+            # TODO(nexus-prerelease): don't think RPCError should be used here
             raise RPCError(
                 "RPCError INVALID_ARGUMENT in Nexus operation",
                 RPCStatusCode.INVALID_ARGUMENT,
@@ -381,7 +381,7 @@ class UntypedCallerWorkflow:
     def __init__(
         self, input: CallerWfInput, request_cancel: bool, task_queue: str
     ) -> None:
-        # TODO(dan): untyped caller cannot reference name of implementation. I think this is as it should be.
+        # TODO(nexus-prerelease): untyped caller cannot reference name of implementation. I think this is as it should be.
         service_name = "ServiceInterface"
         self.nexus_client = workflow.NexusClient(
             service=service_name,
@@ -427,9 +427,9 @@ async def run(
 #
 
 
-# TODO(dan): cross-namespace tests
-# TODO(dan): nexus endpoint pytest fixture?
-# TODO(dan): test headers
+# TODO(nexus-prerelease): cross-namespace tests
+# TODO(nexus-prerelease): nexus endpoint pytest fixture?
+# TODO(nexus-prerelease): test headers
 @pytest.mark.parametrize("exception_in_operation_start", [False, True])
 @pytest.mark.parametrize("request_cancel", [False, True])
 @pytest.mark.parametrize(
@@ -476,7 +476,7 @@ async def test_sync_response(
             task_queue=task_queue,
         )
 
-        # TODO(dan): check bidi links for sync operation
+        # TODO(nexus-prerelease): check bidi links for sync operation
 
         # The operation result is returned even when request_cancel=True, because the
         # response was synchronous and it could not be cancelled. See explanation below.
@@ -551,7 +551,7 @@ async def test_async_response(
             )
             return
 
-        # TODO(dan): race here? How do we know it hasn't been canceled already?
+        # TODO(nexus-prerelease): race here? How do we know it hasn't been canceled already?
         handler_wf_info = await handler_wf_handle.describe()
         assert handler_wf_info.status in [
             WorkflowExecutionStatus.RUNNING,
@@ -736,8 +736,8 @@ class ServiceClassNameOutput:
     name: str
 
 
-# TODO(dan): test interface op types not matching
-# TODO(dan): async and non-async cancel methods
+# TODO(nexus-prerelease): test interface op types not matching
+# TODO(nexus-prerelease): async and non-async cancel methods
 
 
 @nexusrpc.service
@@ -822,12 +822,12 @@ async def run(
             endpoint=make_nexus_endpoint_name(task_queue),
         )
 
-        # TODO(dan): maybe not surprising that this doesn't type check given complexity of
+        # TODO(nexus-prerelease): maybe not surprising that this doesn't type check given complexity of
         # the union?
         return await nexus_client.execute_operation(service_cls.op, None)  # type: ignore
 
 
-# TODO(dan): check missing decorator behavior
+# TODO(nexus-prerelease): check missing decorator behavior
 
 
 async def test_service_interface_and_implementation_names(client: Client):
@@ -979,8 +979,8 @@ async def test_workflow_run_operation_can_execute_workflow_before_starting_backi
         assert result == "result-1-result-2"
 
 
-# TODO(dan): test invalid service interface implementations
-# TODO(dan): test caller passing output_type
+# TODO(nexus-prerelease): test invalid service interface implementations
+# TODO(nexus-prerelease): test caller passing output_type
 
 
 async def assert_caller_workflow_has_link_to_handler_workflow(
@@ -1444,10 +1444,10 @@ def __init__(self, input: ErrorTestInput):
     async def run(self, input: ErrorTestInput) -> None:
         try:
             await self.nexus_client.execute_operation(
-                # TODO(nexus-preview): why wasn't this a type error?
+                # TODO(nexus-prerelease): why wasn't this a type error?
                 #            ErrorTestService.op, ErrorTestCallerWfInput()
                 ErrorTestService.op,
-                # TODO(nexus-preview): why wasn't this a type error?
+                # TODO(nexus-prerelease): why wasn't this a type error?
                 # None
                 input,
             )