Make client.py typecheck under pyright (#628)

Author: dandavison

pyproject.toml

@@ -183,7 +183,6 @@ exclude = [
   "temporalio/bridge/proto",
   "tests/worker/workflow_sandbox/testmodules/proto",
   "temporalio/bridge/worker.py",
-  "temporalio/client.py",
   "temporalio/contrib/opentelemetry.py",
   "temporalio/converter.py",
   "temporalio/testing/_workflow.py",

temporalio/client.py

@@ -35,7 +35,7 @@
 import google.protobuf.duration_pb2
 import google.protobuf.json_format
 import google.protobuf.timestamp_pb2
-from typing_extensions import Concatenate, TypedDict
+from typing_extensions import Concatenate, Required, TypedDict
 
 import temporalio.api.common.v1
 import temporalio.api.enums.v1
@@ -1112,12 +1112,12 @@ async def get_worker_task_reachability(
 class ClientConfig(TypedDict, total=False):
     """TypedDict of config originally passed to :py:meth:`Client`."""
 
-    service_client: temporalio.service.ServiceClient
-    namespace: str
-    data_converter: temporalio.converter.DataConverter
-    interceptors: Sequence[Interceptor]
-    default_workflow_query_reject_condition: Optional[
-        temporalio.common.QueryRejectCondition
+    service_client: Required[temporalio.service.ServiceClient]
+    namespace: Required[str]
+    data_converter: Required[temporalio.converter.DataConverter]
+    interceptors: Required[Sequence[Interceptor]]
+    default_workflow_query_reject_condition: Required[
+        Optional[temporalio.common.QueryRejectCondition]
     ]
 
 
@@ -1797,7 +1797,7 @@ async def execute_update(
             MultiParamSpec, LocalReturnType
         ],
         *,
-        args: MultiParamSpec.args,
+        args: MultiParamSpec.args,  # pyright: ignore
         id: Optional[str] = None,
         rpc_metadata: Mapping[str, str] = {},
         rpc_timeout: Optional[timedelta] = None,
@@ -1906,7 +1906,7 @@ async def start_update(
             MultiParamSpec, LocalReturnType
         ],
         *,
-        args: MultiParamSpec.args,
+        args: MultiParamSpec.args,  # pyright: ignore
         wait_for_stage: WorkflowUpdateStage,
         id: Optional[str] = None,
         rpc_metadata: Mapping[str, str] = {},
@@ -3233,7 +3233,7 @@ class ScheduleActionStartWorkflow(ScheduleAction):
     headers: Optional[Mapping[str, temporalio.api.common.v1.Payload]]
 
     @staticmethod
-    def _from_proto(
+    def _from_proto(  # pyright: ignore
         info: temporalio.api.workflow.v1.NewWorkflowExecutionInfo,  # type: ignore[override]
     ) -> ScheduleActionStartWorkflow:
         return ScheduleActionStartWorkflow("<unset>", raw_info=info)
@@ -3482,7 +3482,6 @@ async def _to_proto(
         return action
 
 
-@dataclass
 class ScheduleOverlapPolicy(IntEnum):
     """Controls what happens when a workflow would be started by a schedule but
     one is already running.

temporalio/worker/_workflow.py

@@ -8,18 +8,15 @@
 import os
 import sys
 from datetime import timezone
-from threading import get_ident
 from types import TracebackType
 from typing import (
     Callable,
     Dict,
     List,
-    Literal,
     MutableMapping,
     Optional,
     Sequence,
     Set,
-    Tuple,
     Type,
 )
 

temporalio/worker/_workflow_instance.py

@@ -587,7 +587,7 @@ async def run_update() -> None:
                 else:
                     self._current_activation_error = err
                     return
-            except BaseException as err:
+            except BaseException:
                 if self._deleting:
                     if LOG_IGNORE_DURING_DELETE:
                         logger.debug(
@@ -883,7 +883,7 @@ async def run_workflow(input: ExecuteWorkflowInput) -> None:
         )
         self._primary_task = self.create_task(
             self._run_top_level_workflow_function(run_workflow(input)),
-            name=f"run",
+            name="run",
         )
 
     def _apply_update_random_seed(

tests/helpers/external_coroutine.py

@@ -2,17 +2,17 @@
 File used in conjunction with external_stack_trace.py to test filenames in multi-file workflows.
 """
 
-from asyncio import sleep
+from typing import List
 
 from temporalio import workflow
 
 
-async def never_completing_coroutine(status) -> None:
+async def never_completing_coroutine(status: List[str]) -> None:
     status[0] = "waiting"  # external coroutine test
     await workflow.wait_condition(lambda: False)
 
 
-async def wait_on_timer(status) -> None:
+async def wait_on_timer(status: List[str]) -> None:
     status[0] = "waiting"  # multifile test
     print("Coroutine executed, waiting.")
     await workflow.wait_condition(lambda: False)