Merge branch 'temporalio:main' into activity-info-retry-policy

Author: maciejdudko

.github/workflows/build-binaries.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - main
       - "releases/*"
+      - fix-build-binaries
 
 jobs:
   # Compile the binaries and upload artifacts
@@ -65,7 +66,7 @@ jobs:
           if [ "$RUNNER_OS" = "Windows" ]; then
             bindir=Scripts
           fi
-          ./.venv/$bindir/pip install 'protobuf>=3.20,<6' 'types-protobuf>=3.20,<6' 'typing-extensions>=4.2.0,<5' pytest pytest_asyncio grpcio 'nexus-rpc>=1.1.0' pydantic opentelemetry-api opentelemetry-sdk python-dateutil openai-agents
+          ./.venv/$bindir/pip install 'protobuf>=3.20,<6' 'types-protobuf>=3.20,<6' 'typing-extensions>=4.2.0,<5' pytest pytest_asyncio grpcio 'nexus-rpc>=1.1.0' pydantic opentelemetry-api opentelemetry-sdk python-dateutil 'openai-agents>=0.2.3,<=0.2.9'
           ./.venv/$bindir/pip install --no-index --find-links=../dist temporalio
           ./.venv/$bindir/python -m pytest -s -k test_workflow_hello
 

README.md

@@ -1489,21 +1489,21 @@ https://github.com/temporalio/samples-python/tree/nexus/hello_nexus).
 
 ### Plugins
 
-Plugins provide a way to extend and customize the behavior of Temporal clients and workers through a chain of 
-responsibility pattern. They allow you to intercept and modify client creation, service connections, worker 
+Plugins provide a way to extend and customize the behavior of Temporal clients and workers through a chain of
+responsibility pattern. They allow you to intercept and modify client creation, service connections, worker
 configuration, and worker execution. Common customizations may include but are not limited to:
 
 1. DataConverter
 2. Activities
 3. Workflows
 4. Interceptors
 
-A single plugin class can implement both client and worker plugin interfaces to share common logic between both 
+A single plugin class can implement both client and worker plugin interfaces to share common logic between both
 contexts. When used with a client, it will automatically be propagated to any workers created with that client.
 
 #### Client Plugins
 
-Client plugins can intercept and modify client configuration and service connections. They are useful for adding 
+Client plugins can intercept and modify client configuration and service connections. They are useful for adding
 authentication, modifying connection parameters, or adding custom behavior during client creation.
 
 Here's an example of a client plugin that adds custom authentication:
@@ -1515,7 +1515,7 @@ import temporalio.service
 class AuthenticationPlugin(Plugin):
     def __init__(self, api_key: str):
         self.api_key = api_key
-        
+
     def init_client_plugin(self, next: Plugin) -> None:
       self.next_client_plugin = next
 
@@ -1540,10 +1540,10 @@ client = await Client.connect(
 
 #### Worker Plugins
 
-Worker plugins can modify worker configuration and intercept worker execution. They are useful for adding monitoring, 
-custom lifecycle management, or modifying worker settings. Worker plugins can also configure replay. 
-They should do this in the case that they modified the worker in a way which would also need to be present 
-for replay to function. For instance, changing the data converter or adding workflows. 
+Worker plugins can modify worker configuration and intercept worker execution. They are useful for adding monitoring,
+custom lifecycle management, or modifying worker settings. Worker plugins can also configure replay.
+They should do this in the case that they modified the worker in a way which would also need to be present
+for replay to function. For instance, changing the data converter or adding workflows.
 
 Here's an example of a worker plugin that adds custom monitoring:
 
@@ -1560,7 +1560,7 @@ class MonitoringPlugin(Plugin):
 
     def init_worker_plugin(self, next: Plugin) -> None:
         self.next_worker_plugin = next
-        
+
     def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
         # Modify worker configuration
         original_task_queue = config["task_queue"]
@@ -1574,22 +1574,22 @@ class MonitoringPlugin(Plugin):
             await self.next_worker_plugin.run_worker(worker)
         finally:
             self.logger.info("Worker execution completed")
-      
-  def configure_replayer(self, config: ReplayerConfig) -> ReplayerConfig:
-      return self.next_worker_plugin.configure_replayer(config)
-  
-  @asynccontextmanager
-  async def run_replayer(
-      self,
-      replayer: Replayer,
-      histories: AsyncIterator[temporalio.client.WorkflowHistory],
-  ) -> AsyncIterator[AsyncIterator[WorkflowReplayResult]]:
-        self.logger.info("Starting replay execution")
-        try:
-          async with self.next_worker_plugin.run_replayer(replayer, histories) as results:
-              yield results
-        finally:
-            self.logger.info("Replay execution completed")
+
+    def configure_replayer(self, config: ReplayerConfig) -> ReplayerConfig:
+        return self.next_worker_plugin.configure_replayer(config)
+
+    @asynccontextmanager
+    async def run_replayer(
+        self,
+        replayer: Replayer,
+        histories: AsyncIterator[temporalio.client.WorkflowHistory],
+    ) -> AsyncIterator[AsyncIterator[WorkflowReplayResult]]:
+          self.logger.info("Starting replay execution")
+          try:
+            async with self.next_worker_plugin.run_replayer(replayer, histories) as results:
+                yield results
+          finally:
+              self.logger.info("Replay execution completed")
 
 # Use the plugin when creating a worker
 worker = Worker(
@@ -1617,38 +1617,38 @@ class UnifiedPlugin(ClientPlugin, WorkerPlugin):
 
     def init_worker_plugin(self, next: WorkerPlugin) -> None:
         self.next_worker_plugin = next
-  
+
     def configure_client(self, config: ClientConfig) -> ClientConfig:
         # Client-side customization
         config["data_converter"] = pydantic_data_converter
         return self.next_client_plugin.configure_client(config)
-  
+
     async def connect_service_client(
         self, config: temporalio.service.ConnectConfig
     ) -> temporalio.service.ServiceClient:
         # Add authentication to the connection
         config.api_key = self.api_key
         return await self.next_client_plugin.connect_service_client(config)
-        
+
     def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
         # Worker-side customization
         return self.next_worker_plugin.configure_worker(config)
-  
+
     async def run_worker(self, worker: Worker) -> None:
         print("Starting unified worker")
         await self.next_worker_plugin.run_worker(worker)
-        
+
     def configure_replayer(self, config: ReplayerConfig) -> ReplayerConfig:
         config["data_converter"] = pydantic_data_converter
         return self.next_worker_plugin.configure_replayer(config)
-    
-    def run_replayer(
+
+    async def run_replayer(
         self,
         replayer: Replayer,
         histories: AsyncIterator[temporalio.client.WorkflowHistory],
     ) -> AbstractAsyncContextManager[AsyncIterator[WorkflowReplayResult]]:
         return self.next_worker_plugin.run_replayer(replayer, histories)
-              
+
 # Create client with the unified plugin
 client = await Client.connect(
     "localhost:7233",
@@ -1902,20 +1902,18 @@ poe test -s --log-cli-level=DEBUG -k test_sync_activity_thread_cancel_caught
 
 #### Proto Generation and Testing
 
-To allow for backwards compatibility, protobuf code is generated on the 3.x series of the protobuf library. To generate
-protobuf code, you must be on Python <= 3.10, and then run `uv add "protobuf<4"` + `uv sync --all-extras`. Then the
-protobuf files can be generated via `poe gen-protos`. Tests can be run for protobuf version 3 by setting the
-`TEMPORAL_TEST_PROTO3` env var to `1` prior to running tests.
-
-Do not commit `uv.lock` or `pyproject.toml` changes. To go back from this downgrade, restore both of those files and run
-`uv sync --all-extras`. Make sure you `poe format` the results.
+If you have docker available, run
 
-For a less system-intrusive approach, you can:
-```shell
-docker build -f scripts/_proto/Dockerfile .
-docker run --rm -v "${PWD}/temporalio/api:/api_new" -v "${PWD}/temporalio/bridge/proto:/bridge_new" <just built image sha>
-poe format
 ```
+poe gen-protos-docker
+```
+
+Alternatively: to generate protobuf code, you must be on Python <= 3.10, and then run `uv add
+"protobuf<4"` + `uv sync --all-extras`. Then the protobuf files can be generated via `poe
+gen-protos` followed by `poe format`. Do not commit `uv.lock` or `pyproject.toml` changes. To go
+back from this downgrade, restore both of those files and run `uv sync --all-extras`. Tests can be
+run for protobuf version 3 by setting the `TEMPORAL_TEST_PROTO3` env var to `1` prior to running
+tests.
 
 ### Style
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "temporalio"
-version = "1.16.0"
+version = "1.17.0"
 description = "Temporal.io Python SDK"
 authors = [{ name = "Temporal Technologies Inc", email = "[email protected]" }]
 requires-python = ">=3.9"
@@ -26,7 +26,7 @@ opentelemetry = [
 ]
 pydantic = ["pydantic>=2.0.0,<3"]
 openai-agents = [
-    "openai-agents >= 0.2.3,<0.3",
+    "openai-agents>=0.2.3,<=0.2.9", # 0.2.10 doesn't work: https://github.com/openai/openai-agents-python/issues/1639
     "eval-type-backport>=0.2.2; python_version < '3.10'"
 ]
 
@@ -57,15 +57,16 @@ dev = [
     "pytest-cov>=6.1.1",
     "httpx>=0.28.1",
     "pytest-pretty>=1.3.0",
-    "openai-agents[litellm] >= 0.2.3,<0.3"
+    "openai-agents[litellm]>=0.2.3,<=0.2.9", # 0.2.10 doesn't work: https://github.com/openai/openai-agents-python/issues/1639
 ]
 
 [tool.poe.tasks]
 build-develop = "uv run maturin develop --uv"
 build-develop-with-release = { cmd = "uv run maturin develop --release --uv" }
 format = [{cmd = "uv run ruff check --select I --fix"}, {cmd = "uv run ruff format"}, ]
-gen-docs = "uv run python scripts/gen_docs.py"
-gen-protos = "uv run python scripts/gen_protos.py"
+gen-docs = "uv run scripts/gen_docs.py"
+gen-protos = "uv run scripts/gen_protos.py"
+gen-protos-docker = "uv run scripts/gen_protos_docker.py"
 lint = [
   {cmd = "uv run ruff check --select I"},
   {cmd = "uv run ruff format --check"},

scripts/_proto/Dockerfile

@@ -12,4 +12,4 @@ RUN uv add "protobuf<4"
 RUN uv sync --all-extras
 RUN poe gen-protos
 
-CMD cp -r ./temporalio/api/* /api_new && cp -r ./temporalio/bridge/proto/* /bridge_new
+CMD ["sh", "-c", "cp -r ./temporalio/api/* /api_new && cp -r ./temporalio/bridge/proto/* /bridge_new"]

scripts/gen_protos_docker.py

@@ -0,0 +1,26 @@
+import os
+import subprocess
+
+# Build the Docker image and capture its ID
+result = subprocess.run(
+    ["docker", "build", "-q", "-f", "scripts/_proto/Dockerfile", "."],
+    capture_output=True,
+    text=True,
+    check=True,
+)
+image_id = result.stdout.strip()
+
+subprocess.run(
+    [
+        "docker",
+        "run",
+        "--rm",
+        "-v",
+        f"{os.getcwd()}/temporalio/api:/api_new",
+        "-v",
+        f"{os.getcwd()}/temporalio/bridge/proto:/bridge_new",
+        image_id,
+    ],
+    check=True,
+)
+subprocess.run(["uv", "run", "poe", "format"], check=True)

temporalio/activity.py

@@ -161,6 +161,7 @@ class ActivityCancellationDetails:
     not_found: bool = False
     cancel_requested: bool = False
     paused: bool = False
+    reset: bool = False
     timed_out: bool = False
     worker_shutdown: bool = False
 
@@ -174,6 +175,7 @@ def _from_proto(
             paused=proto.is_paused,
             timed_out=proto.is_timed_out,
             worker_shutdown=proto.is_worker_shutdown,
+            reset=proto.is_reset,
         )