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

azure/durable_functions/models/OrchestratorState.py

@@ -1,116 +1,117 @@
-import json
-from typing import List, Any, Dict, Optional, Union
-
-from azure.durable_functions.models.ReplaySchema import ReplaySchema
-
-from .utils.json_utils import add_attrib
-from azure.durable_functions.models.actions.Action import Action
-
-
-class OrchestratorState:
-    """Orchestration State.
-
-    Used to communicate the state of the orchestration back to the durable
-    extension
-    """
-
-    def __init__(self,
-                 is_done: bool,
-                 actions: List[List[Action]],
-                 output: Any,
-                 replay_schema: ReplaySchema,
-                 error: str = None,
-                 custom_status: Any = None):
-        self._is_done: bool = is_done
-        self._actions: List[List[Action]] = actions
-        self._output: Any = output
-        self._error: Optional[str] = error
-        self._custom_status: Any = custom_status
-        self._replay_schema: ReplaySchema = replay_schema
-
-    @property
-    def actions(self) -> List[List[Action]]:
-        """Get the ordered list of async actions the orchestrator function should perform.
-
-        This list is append-only; it must contain all scheduled async actions up to the latest
-        requested work, even actions that have already been completed.
-
-        Actions are grouped by execution. Each subsequent orchestrator execution should add a
-        new array of action objects to the collection.
-        """
-        return self._actions
-
-    @property
-    def is_done(self) -> bool:
-        """Get indicator of whether this is the last execution of this orchestrator instance.
-
-        When this value is true, the Durable Functions extension will consider the orchestration
-        instance completed and will attempt to return the output value.
-        """
-        return self._is_done
-
-    @property
-    def output(self):
-        """Get the JSON-serializable value returned by the orchestrator instance completion.
-
-        Optional.
-        """
-        return self._output
-
-    @property
-    def error(self) -> Optional[str]:
-        """Get the error received when running the orchestration.
-
-        Optional.
-        """
-        return self._error
-
-    @property
-    def custom_status(self):
-        """Get the JSON-serializable value used by DurableOrchestrationContext.SetCustomStatus."""
-        return self._custom_status
-
-    @property
-    def schema_version(self):
-        """Get the Replay Schema represented in this OrchestratorState payload."""
-        return self._replay_schema.value
-
-    def to_json(self) -> Dict[str, Union[str, int]]:
-        """Convert object into a json dictionary.
-
-        Returns
-        -------
-        Dict[str, Any]
-            The instance of the class converted into a json dictionary
-        """
-        json_dict: Dict[str, Union[str, int]] = {}
-        add_attrib(json_dict, self, '_is_done', 'isDone')
-        if self._replay_schema != ReplaySchema.V1:
-            add_attrib(json_dict, self, 'schema_version', 'schemaVersion')
-        self._add_actions(json_dict)
-        if not (self._output is None):
-            json_dict['output'] = self._output
-        if self._error:
-            json_dict['error'] = self._error
-        if self._custom_status:
-            json_dict['customStatus'] = self._custom_status
-        return json_dict
-
-    def _add_actions(self, json_dict):
-        json_dict['actions'] = []
-        for action_list in self._actions:
-            action_result_list = []
-            for action_obj in action_list:
-                action_result_list.append(action_obj.to_json())
-            json_dict['actions'].append(action_result_list)
-
-    def to_json_string(self) -> str:
-        """Convert object into a json string.
-
-        Returns
-        -------
-        str
-            The instance of the object in json string format
-        """
-        json_dict = self.to_json()
-        return json.dumps(json_dict)
+import json
+from typing import List, Any, Dict, Optional
+
+from azure.durable_functions.models.ReplaySchema import ReplaySchema
+
+from .utils.json_utils import add_attrib
+from azure.durable_functions.models.actions.Action import Action
+from azure.functions._durable_functions import _serialize_custom_object
+
+
+class OrchestratorState:
+    """Orchestration State.
+
+    Used to communicate the state of the orchestration back to the durable
+    extension
+    """
+
+    def __init__(self,
+                 is_done: bool,
+                 actions: List[List[Action]],
+                 output: Any,
+                 replay_schema: ReplaySchema,
+                 error: str = None,
+                 custom_status: Any = None):
+        self._is_done: bool = is_done
+        self._actions: List[List[Action]] = actions
+        self._output: Any = output
+        self._error: Optional[str] = error
+        self._custom_status: Any = custom_status
+        self._replay_schema: ReplaySchema = replay_schema
+
+    @property
+    def actions(self) -> List[List[Action]]:
+        """Get the ordered list of async actions the orchestrator function should perform.
+
+        This list is append-only; it must contain all scheduled async actions up to the latest
+        requested work, even actions that have already been completed.
+
+        Actions are grouped by execution. Each subsequent orchestrator execution should add a
+        new array of action objects to the collection.
+        """
+        return self._actions
+
+    @property
+    def is_done(self) -> bool:
+        """Get indicator of whether this is the last execution of this orchestrator instance.
+
+        When this value is true, the Durable Functions extension will consider the orchestration
+        instance completed and will attempt to return the output value.
+        """
+        return self._is_done
+
+    @property
+    def output(self):
+        """Get the JSON-serializable value returned by the orchestrator instance completion.
+
+        Optional.
+        """
+        return self._output
+
+    @property
+    def error(self) -> Optional[str]:
+        """Get the error received when running the orchestration.
+
+        Optional.
+        """
+        return self._error
+
+    @property
+    def custom_status(self):
+        """Get the JSON-serializable value used by DurableOrchestrationContext.SetCustomStatus."""
+        return self._custom_status
+
+    @property
+    def schema_version(self):
+        """Get the Replay Schema represented in this OrchestratorState payload."""
+        return self._replay_schema.value
+
+    def to_json(self) -> Dict[str, Any]:
+        """Convert object into a json dictionary.
+
+        Returns
+        -------
+        Dict[str, Any]
+            The instance of the class converted into a json dictionary
+        """
+        json_dict: Dict[str, Any] = {}
+        add_attrib(json_dict, self, '_is_done', 'isDone')
+        if self._replay_schema != ReplaySchema.V1:
+            add_attrib(json_dict, self, 'schema_version', 'schemaVersion')
+        self._add_actions(json_dict)
+        if not (self._output is None):
+            json_dict['output'] = self._output
+        if self._error:
+            json_dict['error'] = self._error
+        if self._custom_status:
+            json_dict['customStatus'] = self._custom_status
+        return json_dict
+
+    def _add_actions(self, json_dict):
+        json_dict['actions'] = []
+        for action_list in self._actions:
+            action_result_list = []
+            for action_obj in action_list:
+                action_result_list.append(action_obj.to_json())
+            json_dict['actions'].append(action_result_list)
+
+    def to_json_string(self) -> str:
+        """Convert object into a json string.
+
+        Returns
+        -------
+        str
+            The instance of the object in json string format
+        """
+        json_dict = self.to_json()
+        return json.dumps(json_dict, default=_serialize_custom_object)

azure/durable_functions/models/PurgeHistoryResult.py

@@ -1,33 +1,33 @@
-from typing import Dict, Any
-
-
-class PurgeHistoryResult:
-    """Information provided when the request to purge history has been made."""
-
-    # parameter names are as defined by JSON schema and do not conform to PEP8 naming conventions
-    def __init__(self, instancesDeleted: int, **kwargs):
-        self._instances_deleted: int = instancesDeleted
-        if kwargs is not None:
-            for key, value in kwargs.items():
-                self.__setattr__(key, value)
-
-    @classmethod
-    def from_json(cls, json_obj: Dict[Any, Any]):
-        """Convert the value passed into a new instance of the class.
-
-        Parameters
-        ----------
-        json_obj: Dict[Any, Any]
-            JSON object to be converted into an instance of the class
-
-        Returns
-        -------
-        PurgeHistoryResult
-            New instance of the durable orchestration status class
-        """
-        return cls(**json_obj)
-
-    @property
-    def instances_deleted(self):
-        """Get the number of deleted instances."""
-        return self._instances_deleted
+from typing import Dict, Any
+
+
+class PurgeHistoryResult:
+    """Information provided when the request to purge history has been made."""
+
+    # parameter names are as defined by JSON schema and do not conform to PEP8 naming conventions
+    def __init__(self, instancesDeleted: int, **kwargs):
+        self._instances_deleted: int = instancesDeleted
+        if kwargs is not None:
+            for key, value in kwargs.items():
+                self.__setattr__(key, value)
+
+    @classmethod
+    def from_json(cls, json_obj: Dict[Any, Any]):
+        """Convert the value passed into a new instance of the class.
+
+        Parameters
+        ----------
+        json_obj: Dict[Any, Any]
+            JSON object to be converted into an instance of the class
+
+        Returns
+        -------
+        PurgeHistoryResult
+            New instance of the durable orchestration status class
+        """
+        return cls(**json_obj)
+
+    @property
+    def instances_deleted(self):
+        """Get the number of deleted instances."""
+        return self._instances_deleted

azure/durable_functions/models/ReplaySchema.py

@@ -1,8 +1,9 @@
-from enum import Enum
-
-
-class ReplaySchema(Enum):
-    """Enum representing the ReplaySchemas supported by this SDK version."""
-
-    V1 = 0
-    V2 = 1
+from enum import Enum
+
+
+class ReplaySchema(Enum):
+    """Enum representing the ReplaySchemas supported by this SDK version."""
+
+    V1 = 0
+    V2 = 1
+    V3 = 2

azure/durable_functions/models/RetryOptions.py

@@ -1,69 +1,69 @@
-from typing import Dict, Union
-
-from .utils.json_utils import add_attrib
-
-
-class RetryOptions:
-    """Retry Options.
-
-    Defines retry policies that can be passed as parameters to various
-    operations.
-    """
-
-    def __init__(
-            self,
-            first_retry_interval_in_milliseconds: int,
-            max_number_of_attempts: int):
-        self._first_retry_interval_in_milliseconds: int = \
-            first_retry_interval_in_milliseconds
-        self._max_number_of_attempts: int = max_number_of_attempts
-
-        if self._first_retry_interval_in_milliseconds <= 0:
-            raise ValueError("first_retry_interval_in_milliseconds value"
-                             "must be greater than 0.")
-
-    @property
-    def first_retry_interval_in_milliseconds(self) -> int:
-        """Get the first retry interval (ms).
-
-        Must be greater than 0
-
-        Returns
-        -------
-        int
-            The value indicating the first retry interval
-        """
-        return self._first_retry_interval_in_milliseconds
-
-    @property
-    def max_number_of_attempts(self) -> int:
-        """Get Max Number of Attempts.
-
-        Returns
-        -------
-        int
-            Value indicating the max number of attempts to retry
-        """
-        return self._max_number_of_attempts
-
-    def to_json(self) -> Dict[str, Union[str, int]]:
-        """Convert object into a json dictionary.
-
-        Returns
-        -------
-        Dict[str, Any]
-            The instance of the class converted into a json dictionary
-        """
-        json_dict: Dict[str, Union[str, int]] = {}
-
-        add_attrib(
-            json_dict,
-            self,
-            'first_retry_interval_in_milliseconds',
-            'firstRetryIntervalInMilliseconds')
-        add_attrib(
-            json_dict,
-            self,
-            'max_number_of_attempts',
-            'maxNumberOfAttempts')
-        return json_dict
+from typing import Dict, Union
+
+from .utils.json_utils import add_attrib
+
+
+class RetryOptions:
+    """Retry Options.
+
+    Defines retry policies that can be passed as parameters to various
+    operations.
+    """
+
+    def __init__(
+            self,
+            first_retry_interval_in_milliseconds: int,
+            max_number_of_attempts: int):
+        self._first_retry_interval_in_milliseconds: int = \
+            first_retry_interval_in_milliseconds
+        self._max_number_of_attempts: int = max_number_of_attempts
+
+        if self._first_retry_interval_in_milliseconds <= 0:
+            raise ValueError("first_retry_interval_in_milliseconds value"
+                             "must be greater than 0.")
+
+    @property
+    def first_retry_interval_in_milliseconds(self) -> int:
+        """Get the first retry interval (ms).
+
+        Must be greater than 0
+
+        Returns
+        -------
+        int
+            The value indicating the first retry interval
+        """
+        return self._first_retry_interval_in_milliseconds
+
+    @property
+    def max_number_of_attempts(self) -> int:
+        """Get Max Number of Attempts.
+
+        Returns
+        -------
+        int
+            Value indicating the max number of attempts to retry
+        """
+        return self._max_number_of_attempts
+
+    def to_json(self) -> Dict[str, Union[str, int]]:
+        """Convert object into a json dictionary.
+
+        Returns
+        -------
+        Dict[str, Any]
+            The instance of the class converted into a json dictionary
+        """
+        json_dict: Dict[str, Union[str, int]] = {}
+
+        add_attrib(
+            json_dict,
+            self,
+            'first_retry_interval_in_milliseconds',
+            'firstRetryIntervalInMilliseconds')
+        add_attrib(
+            json_dict,
+            self,
+            'max_number_of_attempts',
+            'maxNumberOfAttempts')
+        return json_dict

azure/durable_functions/models/RpcManagementOptions.py

@@ -1,86 +1,86 @@
-from datetime import datetime
-from typing import Any, List, Optional
-
-from azure.durable_functions.constants import DATETIME_STRING_FORMAT
-from azure.durable_functions.models.OrchestrationRuntimeStatus import OrchestrationRuntimeStatus
-
-from .utils.entity_utils import EntityId
-
-
-class RpcManagementOptions:
-    """Class used to collect the options for getting orchestration status."""
-
-    def __init__(self, instance_id: str = None, task_hub_name: str = None,
-                 connection_name: str = None, show_history: bool = None,
-                 show_history_output: bool = None, created_time_from: datetime = None,
-                 created_time_to: datetime = None,
-                 runtime_status: List[OrchestrationRuntimeStatus] = None, show_input: bool = None,
-                 operation_name: str = None,
-                 entity_Id: EntityId = None):
-        self._instance_id = instance_id
-        self._task_hub_name = task_hub_name
-        self._connection_name = connection_name
-        self._show_history = show_history
-        self._show_history_output = show_history_output
-        self._created_time_from = created_time_from
-        self._created_time_to = created_time_to
-        self._runtime_status = runtime_status
-        self._show_input = show_input
-        self.operation_name = operation_name
-        self.entity_Id = entity_Id
-
-    @staticmethod
-    def _add_arg(query: List[str], name: str, value: Any):
-        if value:
-            query.append(f'{name}={value}')
-
-    @staticmethod
-    def _add_date_arg(query: List[str], name: str, value: Optional[datetime]):
-        if value:
-            date_as_string = value.strftime(DATETIME_STRING_FORMAT)
-            RpcManagementOptions._add_arg(query, name, date_as_string)
-
-    def to_url(self, base_url: Optional[str]) -> str:
-        """Get the url based on the options selected.
-
-        Parameters
-        ----------
-        base_url: str
-            The base url to prepend to the url path
-
-        Raises
-        ------
-        ValueError
-            When the `base_url` argument is None
-
-        Returns
-        -------
-        str
-            The Url used to get orchestration status information
-        """
-        if base_url is None:
-            raise ValueError("orchestration bindings has not RPC base url")
-
-        if self.entity_Id:
-            url = f'{base_url}{EntityId.get_entity_id_url_path(self.entity_Id)}'
-        else:
-            url = f"{base_url}instances/{self._instance_id if self._instance_id else ''}"
-
-        query: List[str] = []
-
-        self._add_arg(query, 'taskHub', self._task_hub_name)
-        self._add_arg(query, 'connectionName', self._connection_name)
-        self._add_arg(query, 'showInput', self._show_input)
-        self._add_arg(query, 'showHistory', self._show_history)
-        self._add_arg(query, 'showHistoryOutput', self._show_history_output)
-        self._add_date_arg(query, 'createdTimeFrom', self._created_time_from)
-        self._add_date_arg(query, 'createdTimeTo', self._created_time_to)
-        self._add_arg(query, 'op', self.operation_name)
-        if self._runtime_status is not None and len(self._runtime_status) > 0:
-            runtime_status = ",".join(r.value for r in self._runtime_status)
-            self._add_arg(query, 'runtimeStatus', runtime_status)
-
-        if len(query) > 0:
-            url += "?" + "&".join(query)
-
-        return url
+from datetime import datetime
+from typing import Any, List, Optional
+
+from azure.durable_functions.constants import DATETIME_STRING_FORMAT
+from azure.durable_functions.models.OrchestrationRuntimeStatus import OrchestrationRuntimeStatus
+
+from .utils.entity_utils import EntityId
+
+
+class RpcManagementOptions:
+    """Class used to collect the options for getting orchestration status."""
+
+    def __init__(self, instance_id: str = None, task_hub_name: str = None,
+                 connection_name: str = None, show_history: bool = None,
+                 show_history_output: bool = None, created_time_from: datetime = None,
+                 created_time_to: datetime = None,
+                 runtime_status: List[OrchestrationRuntimeStatus] = None, show_input: bool = None,
+                 operation_name: str = None,
+                 entity_Id: EntityId = None):
+        self._instance_id = instance_id
+        self._task_hub_name = task_hub_name
+        self._connection_name = connection_name
+        self._show_history = show_history
+        self._show_history_output = show_history_output
+        self._created_time_from = created_time_from
+        self._created_time_to = created_time_to
+        self._runtime_status = runtime_status
+        self._show_input = show_input
+        self.operation_name = operation_name
+        self.entity_Id = entity_Id
+
+    @staticmethod
+    def _add_arg(query: List[str], name: str, value: Any):
+        if value:
+            query.append(f'{name}={value}')
+
+    @staticmethod
+    def _add_date_arg(query: List[str], name: str, value: Optional[datetime]):
+        if value:
+            date_as_string = value.strftime(DATETIME_STRING_FORMAT)
+            RpcManagementOptions._add_arg(query, name, date_as_string)
+
+    def to_url(self, base_url: Optional[str]) -> str:
+        """Get the url based on the options selected.
+
+        Parameters
+        ----------
+        base_url: str
+            The base url to prepend to the url path
+
+        Raises
+        ------
+        ValueError
+            When the `base_url` argument is None
+
+        Returns
+        -------
+        str
+            The Url used to get orchestration status information
+        """
+        if base_url is None:
+            raise ValueError("orchestration bindings has not RPC base url")
+
+        if self.entity_Id:
+            url = f'{base_url}{EntityId.get_entity_id_url_path(self.entity_Id)}'
+        else:
+            url = f"{base_url}instances/{self._instance_id if self._instance_id else ''}"
+
+        query: List[str] = []
+
+        self._add_arg(query, 'taskHub', self._task_hub_name)
+        self._add_arg(query, 'connectionName', self._connection_name)
+        self._add_arg(query, 'showInput', self._show_input)
+        self._add_arg(query, 'showHistory', self._show_history)
+        self._add_arg(query, 'showHistoryOutput', self._show_history_output)
+        self._add_date_arg(query, 'createdTimeFrom', self._created_time_from)
+        self._add_date_arg(query, 'createdTimeTo', self._created_time_to)
+        self._add_arg(query, 'op', self.operation_name)
+        if self._runtime_status is not None and len(self._runtime_status) > 0:
+            runtime_status = ",".join(r.value for r in self._runtime_status)
+            self._add_arg(query, 'runtimeStatus', runtime_status)
+
+        if len(query) > 0:
+            url += "?" + "&".join(query)
+
+        return url