Add pyright type-checking to examples, fix discoveries (#159)

andystaples · web-flow · commit c115409cafca · 2026-06-25T12:45:06.000-07:00
* Add pyright type-checking to examples, fix discoveries

* Non-editable installs and examples requirements
diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml
@@ -30,8 +30,18 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
-          pip install -e ".[azure-blob-payloads,opentelemetry]"
-          pip install -e ./durabletask-azuremanaged
+          # Install third-party dependencies declared by the examples so they
+          # type-check cleanly. Each example's requirements.txt is the single
+          # source of truth for its dependencies.
+          for req in examples/requirements.txt examples/*/requirements.txt; do
+            pip install -r "$req"
+          done
+          # Install the packages under test from local source last (non-editable
+          # so the durabletask / durabletask.azuremanaged namespace packages are
+          # physically merged in site-packages, which pyright can resolve). This
+          # overrides any PyPI copy pulled in by the example requirements above.
+          pip install --force-reinstall --no-deps . ./durabletask-azuremanaged
+          pip install ".[azure-blob-payloads,opentelemetry]"
           pip install pyright
 
       - name: Run pyright (strict, Python 3.10)
diff --git a/examples/activity_sequence.py b/examples/activity_sequence.py
@@ -5,6 +5,8 @@
 that calls an activity function in a sequence and prints the outputs."""
 import logging
 import os
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -20,7 +22,7 @@ def hello(ctx: task.ActivityContext, name: str) -> str:
     return f'Hello {name}!'
 
 
-def sequence(ctx: task.OrchestrationContext, _):
+def sequence(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, list[str]]:
     """Orchestrator function that calls the 'hello' activity function in a sequence"""
     # Create a replay-safe logger to avoid duplicate log messages during replay
     replay_logger = ctx.create_replay_safe_logger(logger)
diff --git a/examples/distributed-tracing/app.py b/examples/distributed-tracing/app.py
@@ -16,7 +16,9 @@
 
 import os
 import time
+from collections.abc import Generator
 from datetime import timedelta
+from typing import Any
 
 from opentelemetry import trace
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
@@ -64,7 +66,7 @@ def get_weather(ctx: task.ActivityContext, city: str) -> str:
     return result
 
 
-def summarize(ctx: task.ActivityContext, reports: list) -> str:
+def summarize(ctx: task.ActivityContext, reports: list[str]) -> str:
     """Combine individual weather reports into a summary string."""
     summary = " | ".join(reports)
     print(f"  [Activity] summarize -> {summary}")
@@ -75,9 +77,9 @@ def summarize(ctx: task.ActivityContext, reports: list) -> str:
 # Sub-orchestration
 # ---------------------------------------------------------------------------
 
-def collect_weather(ctx: task.OrchestrationContext, cities: list):
+def collect_weather(ctx: task.OrchestrationContext, cities: list[str]) -> Generator[task.Task[Any], Any, list[str]]:
     """Sub-orchestration that collects weather for a list of cities."""
-    results = []
+    results: list[str] = []
     for city in cities:
         weather = yield ctx.call_activity(get_weather, input=city)
         results.append(f"{city}: {weather}")
@@ -88,7 +90,7 @@ def collect_weather(ctx: task.OrchestrationContext, cities: list):
 # Main orchestration
 # ---------------------------------------------------------------------------
 
-def weather_report_orchestrator(ctx: task.OrchestrationContext, cities: list):
+def weather_report_orchestrator(ctx: task.OrchestrationContext, cities: list[str]) -> Generator[task.Task[Any], Any, str]:
     """Top-level orchestration demonstrating timers, activities, and sub-orchestrations.
 
     Flow:
diff --git a/examples/entities/class_based_entity.py b/examples/entities/class_based_entity.py
@@ -4,6 +4,8 @@
 """End-to-end sample that demonstrates how to configure an orchestrator
 that calls an activity function in a sequence and prints the outputs."""
 import os
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -16,7 +18,7 @@ class Counter(entities.DurableEntity):
     def set(self, input: int):
         self.set_state(input)
 
-    def add(self, input: int):
+    def add(self, input: int | None = None):
         current_state = self.get_state(int, 0)
         new_state = current_state + (1 if input is None else input)
         self.set_state(new_state)
@@ -26,7 +28,7 @@ def get(self):
         return self.get_state(int, 0)
 
 
-def counter_orchestrator(ctx: task.OrchestrationContext, _):
+def counter_orchestrator(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, Any]:
     """Orchestrator function that demonstrates the behavior of the counter entity"""
 
     entity_id = task.EntityInstanceId("Counter", "myCounter")
diff --git a/examples/entities/class_based_entity_actions.py b/examples/entities/class_based_entity_actions.py
@@ -4,6 +4,8 @@
 """End-to-end sample that demonstrates how to configure an orchestrator
 that calls an activity function in a sequence and prints the outputs."""
 import os
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -16,7 +18,7 @@ class Counter(entities.DurableEntity):
     def set(self, input: int):
         self.set_state(input)
 
-    def add(self, input: int):
+    def add(self, input: int | None = None):
         current_state = self.get_state(int, 0)
         new_state = current_state + (1 if input is None else input)
         self.set_state(new_state)
@@ -35,7 +37,7 @@ def get(self):
         return self.get_state(int, 0)
 
 
-def counter_orchestrator(ctx: task.OrchestrationContext, _):
+def counter_orchestrator(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, Any]:
     """Orchestrator function that demonstrates the behavior of the counter entity"""
 
     entity_id = task.EntityInstanceId("Counter", "myCounter")
@@ -54,7 +56,7 @@ def counter_orchestrator(ctx: task.OrchestrationContext, _):
     return (yield ctx.call_entity(parent_entity_id, "get"))
 
 
-def hello_orchestrator(ctx: task.OrchestrationContext, _):
+def hello_orchestrator(ctx: task.OrchestrationContext, _: Any) -> str:
     return "Hello world!"
 
 
diff --git a/examples/entities/entity_locking.py b/examples/entities/entity_locking.py
@@ -4,6 +4,8 @@
 """End-to-end sample that demonstrates how to configure an orchestrator
 that calls an activity function in a sequence and prints the outputs."""
 import os
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -16,7 +18,7 @@ class Counter(entities.DurableEntity):
     def set(self, input: int):
         self.set_state(input)
 
-    def add(self, input: int):
+    def add(self, input: int | None = None):
         current_state = self.get_state(int, 0)
         new_state = current_state + (1 if input is None else input)
         self.set_state(new_state)
@@ -26,7 +28,7 @@ def get(self):
         return self.get_state(int, 0)
 
 
-def counter_orchestrator(ctx: task.OrchestrationContext, _):
+def counter_orchestrator(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, Any]:
     """Orchestrator function that demonstrates the behavior of the counter entity"""
 
     entity_id = entities.EntityInstanceId("Counter", "myCounter")
diff --git a/examples/entities/function_based_entity.py b/examples/entities/function_based_entity.py
@@ -4,6 +4,8 @@
 """End-to-end sample that demonstrates how to configure an orchestrator
 that calls an activity function in a sequence and prints the outputs."""
 import os
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -12,7 +14,7 @@
 from durabletask.azuremanaged.worker import DurableTaskSchedulerWorker
 
 
-def counter(ctx: entities.EntityContext, input: int) -> int | None:
+def counter(ctx: entities.EntityContext, input: int | None = None) -> int | None:
     if ctx.operation == "set":
         ctx.set_state(input)
     elif ctx.operation == "add":
@@ -26,7 +28,7 @@ def counter(ctx: entities.EntityContext, input: int) -> int | None:
         raise ValueError(f"Unknown operation '{ctx.operation}'")
 
 
-def counter_orchestrator(ctx: task.OrchestrationContext, _):
+def counter_orchestrator(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, Any]:
     """Orchestrator function that demonstrates the behavior of the counter entity"""
 
     entity_id = entities.EntityInstanceId("counter", "myCounter")
diff --git a/examples/entities/function_based_entity_actions.py b/examples/entities/function_based_entity_actions.py
@@ -4,6 +4,8 @@
 """End-to-end sample that demonstrates how to configure an orchestrator
 that calls an activity function in a sequence and prints the outputs."""
 import os
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -12,7 +14,7 @@
 from durabletask.azuremanaged.worker import DurableTaskSchedulerWorker
 
 
-def counter(ctx: entities.EntityContext, input: int) -> int | None:
+def counter(ctx: entities.EntityContext, input: int | None = None) -> int | None:
     if ctx.operation == "set":
         ctx.set_state(input)
     elif ctx.operation == "add":
@@ -33,7 +35,7 @@ def counter(ctx: entities.EntityContext, input: int) -> int | None:
         raise ValueError(f"Unknown operation '{ctx.operation}'")
 
 
-def counter_orchestrator(ctx: task.OrchestrationContext, _):
+def counter_orchestrator(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, Any]:
     """Orchestrator function that demonstrates the behavior of the counter entity"""
 
     entity_id = task.EntityInstanceId("counter", "myCounter")
@@ -52,7 +54,7 @@ def counter_orchestrator(ctx: task.OrchestrationContext, _):
     return (yield ctx.call_entity(parent_entity_id, "get"))
 
 
-def hello_orchestrator(ctx: task.OrchestrationContext, _):
+def hello_orchestrator(ctx: task.OrchestrationContext, _: Any) -> str:
     return "Hello world!"
 
 
diff --git a/examples/fanout_fanin.py b/examples/fanout_fanin.py
@@ -7,6 +7,8 @@
 import os
 import random
 import time
+from collections.abc import Generator
+from typing import Any
 
 from azure.identity import DefaultAzureCredential
 
@@ -15,7 +17,7 @@
 from durabletask.azuremanaged.worker import DurableTaskSchedulerWorker
 
 
-def get_work_items(ctx: task.ActivityContext, _) -> list[str]:
+def get_work_items(ctx: task.ActivityContext, _: Any) -> list[str]:
     """Activity function that returns a list of work items"""
     # return a random number of work items
     count = random.randint(2, 10)
@@ -34,15 +36,15 @@ def process_work_item(ctx: task.ActivityContext, item: str) -> int:
     return random.randint(0, 10)
 
 
-def orchestrator(ctx: task.OrchestrationContext, _):
+def orchestrator(ctx: task.OrchestrationContext, _: Any) -> Generator[task.Task[Any], Any, dict[str, Any]]:
     """Orchestrator function that calls the 'get_work_items' and 'process_work_item'
     activity functions in parallel, waits for them all to complete, and prints
     an aggregate summary of the outputs"""
 
     work_items: list[str] = yield ctx.call_activity(get_work_items)
 
     # execute the work-items in parallel and wait for them all to return
-    tasks = [ctx.call_activity(process_work_item, input=item) for item in work_items]
+    tasks: list[task.Task[int]] = [ctx.call_activity(process_work_item, input=item) for item in work_items]
     results: list[int] = yield task.when_all(tasks)
 
     # return an aggregate summary of the results
diff --git a/examples/history_export/app.py b/examples/history_export/app.py
@@ -19,7 +19,9 @@
 
 import os
 import time
+from collections.abc import Generator
 from datetime import datetime, timedelta, timezone
+from typing import Any
 
 from durabletask import client, task, worker
 from durabletask.extensions.history_export import (
@@ -50,7 +52,7 @@ def square(_: task.ActivityContext, n: int) -> int:
     return n * n
 
 
-def sample_orchestrator(ctx: task.OrchestrationContext, n: int):
+def sample_orchestrator(ctx: task.OrchestrationContext, n: int) -> Generator[task.Task[Any], Any, int]:
     result = yield ctx.call_activity(square, input=n)
     return result
 
diff --git a/examples/human_interaction.py b/examples/human_interaction.py
@@ -9,9 +9,10 @@
 import os
 import threading
 import time
-from collections import namedtuple
+from collections.abc import Generator
 from dataclasses import dataclass
 from datetime import timedelta
+from typing import Any, NamedTuple
 
 from azure.identity import DefaultAzureCredential
 
@@ -20,6 +21,11 @@
 from durabletask.azuremanaged.worker import DurableTaskSchedulerWorker
 
 
+class Approval(NamedTuple):
+    """Represents an approval event payload"""
+    approver: str
+
+
 @dataclass
 class Order:
     """Represents a purchase order"""
@@ -42,7 +48,7 @@ def place_order(_: task.ActivityContext, order: Order) -> None:
     print(f'*** Placing order: {order}')
 
 
-def purchase_order_workflow(ctx: task.OrchestrationContext, order: Order):
+def purchase_order_workflow(ctx: task.OrchestrationContext, order: Order) -> Generator[task.Task[Any], Any, str]:
     """Orchestrator function that represents a purchase order workflow"""
     # Orders under $1000 are auto-approved
     if order.Cost < 1000:
@@ -90,7 +96,7 @@ def purchase_order_workflow(ctx: task.OrchestrationContext, order: Order):
 
                 def prompt_for_approval():
                     input("Press [ENTER] to approve the order...\n")
-                    approval_event = namedtuple("Approval", ["approver"])(args.approver)
+                    approval_event = Approval(args.approver)
                     c.raise_orchestration_event(instance_id, "approval_received", data=approval_event)
 
                 # Prompt the user for approval on a background thread
@@ -136,7 +142,7 @@ def prompt_for_approval():
 
             def prompt_for_approval():
                 input("Press [ENTER] to approve the order...\n")
-                approval_event = namedtuple("Approval", ["approver"])(args.approver)
+                approval_event = Approval(args.approver)
                 c.raise_orchestration_event(instance_id, "approval_received", data=approval_event)
 
             # Prompt the user for approval on a background thread
diff --git a/examples/in_memory_backend_example/src/workflows.py b/examples/in_memory_backend_example/src/workflows.py
@@ -16,8 +16,10 @@
 access (``item["quantity"]``) for nested data.
 """
 
+from collections.abc import Generator
 from dataclasses import dataclass
 from datetime import timedelta
+from typing import Any
 
 from durabletask import task
 
@@ -50,7 +52,7 @@ class Order:
 # ---------------------------------------------------------------------------
 
 
-def validate_order(ctx: task.ActivityContext, order) -> None:
+def validate_order(ctx: task.ActivityContext, order: Any) -> None:
     """Validate that the order has items and all quantities/prices are valid.
 
     Raises ``ValueError`` on invalid input.
@@ -66,7 +68,7 @@ def validate_order(ctx: task.ActivityContext, order) -> None:
                 f"Invalid price for '{item['name']}': {item['unit_price']}")
 
 
-def calculate_total(ctx: task.ActivityContext, items: list) -> float:
+def calculate_total(ctx: task.ActivityContext, items: list[Any]) -> float:
     """Return the total cost for a list of item dicts."""
     return sum(item["quantity"] * item["unit_price"] for item in items)
 
@@ -95,7 +97,7 @@ def ship_item(ctx: task.ActivityContext, item_name: str) -> str:
 # ---------------------------------------------------------------------------
 
 
-def process_order(ctx: task.OrchestrationContext, order):
+def process_order(ctx: task.OrchestrationContext, order: Any) -> Generator[task.Task[Any], Any, dict[str, Any]]:
     """Process a complete order: validate, pay, ship items in parallel, confirm.
 
     Demonstrates:
@@ -135,7 +137,7 @@ def process_order(ctx: task.OrchestrationContext, order):
     }
 
 
-def order_with_approval(ctx: task.OrchestrationContext, order):
+def order_with_approval(ctx: task.OrchestrationContext, order: Any) -> Generator[task.Task[Any], Any, dict[str, Any]]:
     """Order workflow that requires manager approval for high-value orders.
 
     Demonstrates:
diff --git a/examples/large_payload/app.py b/examples/large_payload/app.py
diff --git a/examples/sandboxes/main_app.py b/examples/sandboxes/main_app.py
diff --git a/examples/sub-orchestrations-with-fan-out-fan-in/worker.py b/examples/sub-orchestrations-with-fan-out-fan-in/worker.py
diff --git a/examples/version_aware_orchestrator.py b/examples/version_aware_orchestrator.py
diff --git a/examples/work_item_filtering.py b/examples/work_item_filtering.py
diff --git a/pyrightconfig.json b/pyrightconfig.json
