azure-functions-durable 1.2.7__py3-none-any.whl → 1.2.9__py3-none-any.whl

azure/durable_functions/decorators/durable_app.py

@@ -7,9 +7,17 @@ from azure.durable_functions.entity import Entity
 from azure.durable_functions.orchestrator import Orchestrator
 from azure.durable_functions import DurableOrchestrationClient
 from typing import Union
-from azure.functions import FunctionRegister, TriggerApi, BindingApi, AuthLevel, SettingsApi
+from azure.functions import FunctionRegister, TriggerApi, BindingApi, AuthLevel
 from functools import wraps
 
+try:
+    from azure.functions import SettingsApi
+except ImportError:  # backwards compatibility path
+    class SettingsApi:
+        """Backwards compatibility mock of SettingsApi."""
+
+        pass
+
 
 class Blueprint(TriggerApi, BindingApi, SettingsApi):
     """Durable Functions (DF) Blueprint container.

azure/durable_functions/models/DurableOrchestrationClient.py

@@ -709,3 +709,73 @@ class DurableOrchestrationClient:
         else:
             ex_msg = "Received unexpected payload from the durable-extension: " + str(response)
             raise Exception(ex_msg)
+
+    async def suspend(self, instance_id: str, reason: str) -> None:
+        """Suspend the specified orchestration instance.
+
+        Parameters
+        ----------
+        instance_id : str
+            The ID of the orchestration instance to suspend.
+        reason: str
+            The reason for suspending the instance.
+
+        Raises
+        ------
+        Exception:
+            When the suspend call failed with an unexpected status code
+
+        Returns
+        -------
+        None
+        """
+        request_url = f"{self._orchestration_bindings.rpc_base_url}instances/{instance_id}/" \
+                      f"suspend?reason={quote(reason)}"
+        response = await self._post_async_request(request_url, None)
+        switch_statement = {
+            202: lambda: None,  # instance is suspended
+            410: lambda: None,  # instance completed
+            404: lambda: f"No instance with ID '{instance_id}' found.",
+        }
+
+        has_error_message = switch_statement.get(
+            response[0],
+            lambda: f"The operation failed with an unexpected status code {response[0]}")
+        error_message = has_error_message()
+        if error_message:
+            raise Exception(error_message)
+
+    async def resume(self, instance_id: str, reason: str) -> None:
+        """Resume the specified orchestration instance.
+
+        Parameters
+        ----------
+        instance_id : str
+            The ID of the orchestration instance to query.
+        reason: str
+            The reason for resuming the instance.
+
+        Raises
+        ------
+        Exception:
+            When the resume call failed with an unexpected status code
+
+        Returns
+        -------
+        None
+        """
+        request_url = f"{self._orchestration_bindings.rpc_base_url}instances/{instance_id}/" \
+                      f"resume?reason={quote(reason)}"
+        response = await self._post_async_request(request_url, None)
+        switch_statement = {
+            202: lambda: None,  # instance is resumed
+            410: lambda: None,  # instance completed
+            404: lambda: f"No instance with ID '{instance_id}' found.",
+        }
+
+        has_error_message = switch_statement.get(
+            response[0],
+            lambda: f"The operation failed with an unexpected status code {response[0]}")
+        error_message = has_error_message()
+        if error_message:
+            raise Exception(error_message)

azure/durable_functions/models/OrchestrationRuntimeStatus.py

@@ -27,3 +27,6 @@ class OrchestrationRuntimeStatus(Enum):
 
     Pending = 'Pending'
     """The orchestration instance has been scheduled but has not yet started running."""
+
+    Suspended = 'Suspended'
+    """The orchestration instance has been suspended and may go back to running at a later time."""

azure/durable_functions/models/TaskOrchestrationExecutor.py

@@ -165,11 +165,14 @@ class TaskOrchestrationExecutor:
 
             # We provide the ability to deserialize custom objects, because the output of this
             # will be passed directly to the orchestrator as the output of some activity
-            if event_type == HistoryEventType.SUB_ORCHESTRATION_INSTANCE_COMPLETED:
+            if (event_type == HistoryEventType.SUB_ORCHESTRATION_INSTANCE_COMPLETED
+                    and directive_result.Result is not None):
                 return json.loads(directive_result.Result, object_hook=_deserialize_custom_object)
-            if event_type == HistoryEventType.TASK_COMPLETED:
+            if (event_type == HistoryEventType.TASK_COMPLETED
+                    and directive_result.Result is not None):
                 return json.loads(directive_result.Result, object_hook=_deserialize_custom_object)
-            if event_type == HistoryEventType.EVENT_RAISED:
+            if (event_type == HistoryEventType.EVENT_RAISED
+                    and directive_result.Input is not None):
                 # TODO: Investigate why the payload is in "Input" instead of "Result"
                 response = json.loads(directive_result.Input,
                                       object_hook=_deserialize_custom_object)

azure/durable_functions/models/history/HistoryEventType.py

@@ -23,3 +23,5 @@ class HistoryEventType(IntEnum):
     CONTINUE_AS_NEW = 16
     GENERIC_EVENT = 17
     HISTORY_STATE = 18
+    EXECUTION_SUSPENDED = 19
+    EXECUTION_RESUMED = 20

{azure_functions_durable-1.2.7.data → azure_functions_durable-1.2.9.data}/data/_manifest/bsi.json

@@ -1 +1 @@
-{"Source":"InternalBuild","Data":{"System.CollectionId":"d1c51fbc-4477-4a0f-b99f-fc9013009a58","System.DefinitionId":"58","System.TeamProjectId":"e6a70c92-4128-439f-8012-382fe78d6396","System.TeamProject":"Azure Functions","Build.BuildId":"157178","Build.BuildNumber":"20231103.3","Build.DefinitionName":"Azure.azure-functions-durable-python","Build.DefinitionRevision":"2","Build.Repository.Name":"Azure/azure-functions-durable-python","Build.Repository.Provider":"GitHub","Build.Repository.Id":"Azure/azure-functions-durable-python","Build.SourceBranch":"refs/tags/v1.2.7","Build.SourceBranchName":"v1.2.7","Build.SourceVersion":"8ca9004069696ef1d5f49bb6cd533abb8cf0bbbc"},"Feed":null}
+{"Source":"InternalBuild","Data":{"System.CollectionId":"d1c51fbc-4477-4a0f-b99f-fc9013009a58","System.DefinitionId":"58","System.TeamProjectId":"e6a70c92-4128-439f-8012-382fe78d6396","System.TeamProject":"Azure Functions","Build.BuildId":"161393","Build.BuildNumber":"20240214.1","Build.DefinitionName":"Azure.azure-functions-durable-python","Build.DefinitionRevision":"2","Build.Repository.Name":"Azure/azure-functions-durable-python","Build.Repository.Provider":"GitHub","Build.Repository.Id":"Azure/azure-functions-durable-python","Build.SourceBranch":"refs/tags/v1.2.9","Build.SourceBranchName":"v1.2.9","Build.SourceVersion":"34112b1c6a6100bf602eff0ae3f57918fac61935"},"Feed":null}