PR feedback

Author: tconley1428

temporalio/contrib/openai_agents/__init__.py

@@ -9,7 +9,7 @@
 """
 
 from temporalio.contrib.openai_agents._model_parameters import ModelActivityParameters
-from temporalio.contrib.openai_agents._openai_runner import AgentsWorkflowFailure
+from temporalio.contrib.openai_agents._openai_runner import AgentsWorkflowError
 from temporalio.contrib.openai_agents._temporal_openai_agents import (
     OpenAIAgentsPlugin,
     TestModel,
@@ -22,7 +22,7 @@
 from . import workflow
 
 __all__ = [
-    "AgentsWorkflowFailure",
+    "AgentsWorkflowError",
     "OpenAIAgentsPlugin",
     "ModelActivityParameters",
     "workflow",

temporalio/contrib/openai_agents/_openai_runner.py

@@ -22,16 +22,7 @@
 from temporalio import workflow
 from temporalio.contrib.openai_agents._model_parameters import ModelActivityParameters
 from temporalio.contrib.openai_agents._temporal_model_stub import _TemporalModelStub
-from temporalio.exceptions import ApplicationError, TemporalError
-
-
-class AgentsWorkflowFailure(TemporalError):
-    """Error that occurs when the agents SDK raises an error which should terminate the calling workflow.
-
-    .. warning::
-        This exception is experimental and may change in future versions.
-        Use with caution in production environments.
-    """
+from temporalio.contrib.openai_agents.workflow import AgentsWorkflowError
 
 
 class TemporalOpenAIRunner(AgentRunner):
@@ -161,8 +152,8 @@ async def on_invoke(
         except AgentsException as e:
             # In order for workflow failures to properly fail the workflow, we need to rewrap them in
             # a Temporal error
-            if e.__cause__ and workflow.is_workflow_failure_exception(e.__cause__):
-                reraise = AgentsWorkflowFailure(
+            if e.__cause__ and workflow.is_failure_exception(e.__cause__):
+                reraise = AgentsWorkflowError(
                     f"Workflow failure exception in Agents Framework: {e}"
                 )
                 reraise.__traceback__ = e.__traceback__

temporalio/contrib/openai_agents/_temporal_openai_agents.py

@@ -28,7 +28,7 @@
 from temporalio.contrib.openai_agents._invoke_model_activity import ModelActivity
 from temporalio.contrib.openai_agents._model_parameters import ModelActivityParameters
 from temporalio.contrib.openai_agents._openai_runner import (
-    AgentsWorkflowFailure,
+    AgentsWorkflowError,
     TemporalOpenAIRunner,
 )
 from temporalio.contrib.openai_agents._temporal_trace_provider import (
@@ -289,7 +289,7 @@ def configure_worker(self, config: WorkerConfig) -> WorkerConfig:
         ]
         config["workflow_failure_exception_types"] = list(
             config.get("workflow_failure_exception_types") or []
-        ) + [AgentsWorkflowFailure]
+        ) + [AgentsWorkflowError]
         return self.next_worker_plugin.configure_worker(config)
 
     async def run_worker(self, worker: Worker) -> None:

temporalio/contrib/openai_agents/workflow.py

@@ -263,3 +263,12 @@ class ToolSerializationError(TemporalError):
     To fix this error, ensure your tool returns string-convertible values or
     modify the tool to return a string representation of the result.
     """
+
+
+class AgentsWorkflowError(TemporalError):
+    """Error that occurs when the agents SDK raises an error which should terminate the calling workflow.
+
+    .. warning::
+        This exception is experimental and may change in future versions.
+        Use with caution in production environments.
+    """

temporalio/worker/_workflow_instance.py

@@ -414,7 +414,7 @@ def activate(
             # We want some errors during activation, like those that can happen
             # during payload conversion, to be able to fail the workflow not the
             # task
-            if self.is_workflow_failure_exception(err):
+            if self.workflow_is_failure_exception(err):
                 try:
                     self._set_workflow_failure(err)
                 except Exception as inner_err:
@@ -629,7 +629,7 @@ async def run_update() -> None:
                 # Validation failures are always update failures. We reuse
                 # workflow failure logic to decide task failure vs update
                 # failure after validation.
-                if not past_validation or self.is_workflow_failure_exception(err):
+                if not past_validation or self.workflow_is_failure_exception(err):
                     if command is None:
                         command = self._add_command()
                         command.update_response.protocol_instance_id = (
@@ -1686,6 +1686,23 @@ def workflow_set_current_details(self, details: str):
         self._assert_not_read_only("set current details")
         self._current_details = details
 
+    def workflow_is_failure_exception(self, err: BaseException) -> bool:
+        # An exception is a failure instead of a task fail if it's already a
+        # failure error or if it is a timeout error or if it is an instance of
+        # any of the failure types in the worker or workflow-level setting
+        wf_failure_exception_types = self._defn.failure_exception_types
+        if self._dynamic_failure_exception_types is not None:
+            wf_failure_exception_types = self._dynamic_failure_exception_types
+        return (
+            isinstance(err, temporalio.exceptions.FailureError)
+            or isinstance(err, asyncio.TimeoutError)
+            or any(isinstance(err, typ) for typ in wf_failure_exception_types)
+            or any(
+                isinstance(err, typ)
+                for typ in self._worker_level_failure_exception_types
+            )
+        )
+
     #### Calls from outbound impl ####
     # These are in alphabetical order and all start with "_outbound_".
 
@@ -1939,7 +1956,7 @@ def _convert_payloads(
             # Don't wrap payload conversion errors that would fail the workflow
             raise
         except Exception as err:
-            if self.is_workflow_failure_exception(err):
+            if self.workflow_is_failure_exception(err):
                 raise
             raise RuntimeError("Failed decoding arguments") from err
 
@@ -1982,23 +1999,6 @@ def _instantiate_workflow_object(self) -> Any:
 
         return workflow_instance
 
-    def is_workflow_failure_exception(self, err: BaseException) -> bool:
-        # An exception is a failure instead of a task fail if it's already a
-        # failure error or if it is a timeout error or if it is an instance of
-        # any of the failure types in the worker or workflow-level setting
-        wf_failure_exception_types = self._defn.failure_exception_types
-        if self._dynamic_failure_exception_types is not None:
-            wf_failure_exception_types = self._dynamic_failure_exception_types
-        return (
-            isinstance(err, temporalio.exceptions.FailureError)
-            or isinstance(err, asyncio.TimeoutError)
-            or any(isinstance(err, typ) for typ in wf_failure_exception_types)
-            or any(
-                isinstance(err, typ)
-                for typ in self._worker_level_failure_exception_types
-            )
-        )
-
     def _warn_if_unfinished_handlers(self) -> None:
         def warnable(handler_executions: Iterable[HandlerExecution]):
             return [
@@ -2192,7 +2192,7 @@ async def _run_top_level_workflow_function(self, coro: Awaitable[None]) -> None:
                 err
             ):
                 self._add_command().cancel_workflow_execution.SetInParent()
-            elif self.is_workflow_failure_exception(err):
+            elif self.workflow_is_failure_exception(err):
                 # All other failure errors fail the workflow
                 self._set_workflow_failure(err)
             else:

temporalio/workflow.py

@@ -898,7 +898,7 @@ def workflow_get_current_details(self) -> str: ...
     def workflow_set_current_details(self, details: str): ...
 
     @abstractmethod
-    def is_workflow_failure_exception(self, err: BaseException) -> bool: ...
+    def workflow_is_failure_exception(self, err: BaseException) -> bool: ...
 
 
 _current_update_info: contextvars.ContextVar[UpdateInfo] = contextvars.ContextVar(
@@ -984,13 +984,13 @@ def memo() -> Mapping[str, Any]:
     return _Runtime.current().workflow_memo()
 
 
-def is_workflow_failure_exception(err: BaseException) -> bool:
+def is_failure_exception(err: BaseException) -> bool:
     """Checks if the given exception is a workflow failure in the current workflow.
 
     Returns:
         True if the given exception is a workflow failure in the current workflow.
     """
-    return _Runtime.current().is_workflow_failure_exception(err)
+    return _Runtime.current().workflow_is_failure_exception(err)
 
 
 @overload