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

azure/durable_functions/models/actions/CallSubOrchestratorAction.py

@@ -1,40 +1,40 @@
-from typing import Any, Dict, Optional, Union
-
-from .Action import Action
-from .ActionType import ActionType
-from ..utils.json_utils import add_attrib
-from json import dumps
-from azure.functions._durable_functions import _serialize_custom_object
-
-
-class CallSubOrchestratorAction(Action):
-    """Defines the structure of the Call SubOrchestrator object."""
-
-    def __init__(self, function_name: str, _input: Optional[Any] = None,
-                 instance_id: Optional[str] = None):
-        self.function_name: str = function_name
-        self._input: str = dumps(_input, default=_serialize_custom_object)
-        self.instance_id: Optional[str] = instance_id
-
-        if not self.function_name:
-            raise ValueError("function_name cannot be empty")
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.CALL_SUB_ORCHESTRATOR
-
-    def to_json(self) -> Dict[str, Union[str, int]]:
-        """Convert object into a json dictionary.
-
-        Returns
-        -------
-        Dict[str, Union(str, int)]
-            The instance of the class converted into a json dictionary
-        """
-        json_dict: Dict[str, Union[str, int]] = {}
-        add_attrib(json_dict, self, 'action_type', 'actionType')
-        add_attrib(json_dict, self, 'function_name', 'functionName')
-        add_attrib(json_dict, self, '_input', 'input')
-        add_attrib(json_dict, self, 'instance_id', 'instanceId')
-        return json_dict
+from typing import Any, Dict, Optional, Union
+
+from .Action import Action
+from .ActionType import ActionType
+from ..utils.json_utils import add_attrib
+from json import dumps
+from azure.functions._durable_functions import _serialize_custom_object
+
+
+class CallSubOrchestratorAction(Action):
+    """Defines the structure of the Call SubOrchestrator object."""
+
+    def __init__(self, function_name: str, _input: Optional[Any] = None,
+                 instance_id: Optional[str] = None):
+        self.function_name: str = function_name
+        self._input: str = dumps(_input, default=_serialize_custom_object)
+        self.instance_id: Optional[str] = instance_id
+
+        if not self.function_name:
+            raise ValueError("function_name cannot be empty")
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.CALL_SUB_ORCHESTRATOR
+
+    def to_json(self) -> Dict[str, Union[str, int]]:
+        """Convert object into a json dictionary.
+
+        Returns
+        -------
+        Dict[str, Union(str, int)]
+            The instance of the class converted into a json dictionary
+        """
+        json_dict: Dict[str, Union[str, int]] = {}
+        add_attrib(json_dict, self, 'action_type', 'actionType')
+        add_attrib(json_dict, self, 'function_name', 'functionName')
+        add_attrib(json_dict, self, '_input', 'input')
+        add_attrib(json_dict, self, 'instance_id', 'instanceId')
+        return json_dict

azure/durable_functions/models/actions/CallSubOrchestratorWithRetryAction.py

@@ -1,44 +1,44 @@
-from typing import Any, Dict, Union, Optional
-
-from .Action import Action
-from .ActionType import ActionType
-from ..utils.json_utils import add_attrib, add_json_attrib
-from json import dumps
-from ..RetryOptions import RetryOptions
-from azure.functions._durable_functions import _serialize_custom_object
-
-
-class CallSubOrchestratorWithRetryAction(Action):
-    """Defines the structure of the Call SubOrchestrator object."""
-
-    def __init__(self, function_name: str, retry_options: RetryOptions,
-                 _input: Optional[Any] = None,
-                 instance_id: Optional[str] = None):
-        self.function_name: str = function_name
-        self._input: str = dumps(_input, default=_serialize_custom_object)
-        self.retry_options: RetryOptions = retry_options
-        self.instance_id: Optional[str] = instance_id
-
-        if not self.function_name:
-            raise ValueError("function_name cannot be empty")
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.CALL_SUB_ORCHESTRATOR_WITH_RETRY
-
-    def to_json(self) -> Dict[str, Union[str, int]]:
-        """Convert object into a json dictionary.
-
-        Returns
-        -------
-        Dict[str, Union(str, int)]
-            The instance of the class converted into a json dictionary
-        """
-        json_dict: Dict[str, Union[str, int]] = {}
-        add_attrib(json_dict, self, 'action_type', 'actionType')
-        add_attrib(json_dict, self, 'function_name', 'functionName')
-        add_attrib(json_dict, self, '_input', 'input')
-        add_json_attrib(json_dict, self, 'retry_options', 'retryOptions')
-        add_attrib(json_dict, self, 'instance_id', 'instanceId')
-        return json_dict
+from typing import Any, Dict, Union, Optional
+
+from .Action import Action
+from .ActionType import ActionType
+from ..utils.json_utils import add_attrib, add_json_attrib
+from json import dumps
+from ..RetryOptions import RetryOptions
+from azure.functions._durable_functions import _serialize_custom_object
+
+
+class CallSubOrchestratorWithRetryAction(Action):
+    """Defines the structure of the Call SubOrchestrator object."""
+
+    def __init__(self, function_name: str, retry_options: RetryOptions,
+                 _input: Optional[Any] = None,
+                 instance_id: Optional[str] = None):
+        self.function_name: str = function_name
+        self._input: str = dumps(_input, default=_serialize_custom_object)
+        self.retry_options: RetryOptions = retry_options
+        self.instance_id: Optional[str] = instance_id
+
+        if not self.function_name:
+            raise ValueError("function_name cannot be empty")
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.CALL_SUB_ORCHESTRATOR_WITH_RETRY
+
+    def to_json(self) -> Dict[str, Union[str, int]]:
+        """Convert object into a json dictionary.
+
+        Returns
+        -------
+        Dict[str, Union(str, int)]
+            The instance of the class converted into a json dictionary
+        """
+        json_dict: Dict[str, Union[str, int]] = {}
+        add_attrib(json_dict, self, 'action_type', 'actionType')
+        add_attrib(json_dict, self, 'function_name', 'functionName')
+        add_attrib(json_dict, self, '_input', 'input')
+        add_json_attrib(json_dict, self, 'retry_options', 'retryOptions')
+        add_attrib(json_dict, self, 'instance_id', 'instanceId')
+        return json_dict

azure/durable_functions/models/actions/CompoundAction.py

@@ -1,35 +1,35 @@
-from typing import Dict, Union
-
-from .Action import Action
-from ..utils.json_utils import add_attrib
-from typing import List
-from abc import abstractmethod
-
-
-class CompoundAction(Action):
-    """Defines the structure of the WhenAll Action object.
-
-    Provides the information needed by the durable extension to be able to invoke WhenAll tasks.
-    """
-
-    def __init__(self, compound_tasks: List[Action]):
-        self.compound_tasks = compound_tasks
-
-    @property
-    @abstractmethod
-    def action_type(self) -> int:
-        """Get this object's action type as an integer."""
-        ...
-
-    def to_json(self) -> Dict[str, Union[str, int]]:
-        """Convert object into a json dictionary.
-
-        Returns
-        -------
-        Dict[str, Union[str, int]]
-            The instance of the class converted into a json dictionary
-        """
-        json_dict: Dict[str, Union[str, int]] = {}
-        add_attrib(json_dict, self, 'action_type', 'actionType')
-        json_dict['compoundActions'] = list(map(lambda x: x.to_json(), self.compound_tasks))
-        return json_dict
+from typing import Dict, Union
+
+from .Action import Action
+from ..utils.json_utils import add_attrib
+from typing import List
+from abc import abstractmethod
+
+
+class CompoundAction(Action):
+    """Defines the structure of the WhenAll Action object.
+
+    Provides the information needed by the durable extension to be able to invoke WhenAll tasks.
+    """
+
+    def __init__(self, compound_tasks: List[Action]):
+        self.compound_tasks = compound_tasks
+
+    @property
+    @abstractmethod
+    def action_type(self) -> int:
+        """Get this object's action type as an integer."""
+        ...
+
+    def to_json(self) -> Dict[str, Union[str, int]]:
+        """Convert object into a json dictionary.
+
+        Returns
+        -------
+        Dict[str, Union[str, int]]
+            The instance of the class converted into a json dictionary
+        """
+        json_dict: Dict[str, Union[str, int]] = {}
+        add_attrib(json_dict, self, 'action_type', 'actionType')
+        json_dict['compoundActions'] = list(map(lambda x: x.to_json(), self.compound_tasks))
+        return json_dict

azure/durable_functions/models/actions/ContinueAsNewAction.py

@@ -1,36 +1,36 @@
-from typing import Dict, Union
-
-from .Action import Action
-from .ActionType import ActionType
-from ..utils.json_utils import add_attrib
-from json import dumps
-from azure.functions._durable_functions import _serialize_custom_object
-
-
-class ContinueAsNewAction(Action):
-    """Defines the structure of the Continue As New object.
-
-    Provides the information needed by the durable extension to be able to reset the orchestration
-    and continue as new.
-    """
-
-    def __init__(self, input_=None):
-        self.input_ = dumps(input_, default=_serialize_custom_object)
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.CONTINUE_AS_NEW
-
-    def to_json(self) -> Dict[str, Union[int, str]]:
-        """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[int, str]] = {}
-        add_attrib(json_dict, self, 'action_type', 'actionType')
-        add_attrib(json_dict, self, 'input_', 'input')
-        return json_dict
+from typing import Dict, Union
+
+from .Action import Action
+from .ActionType import ActionType
+from ..utils.json_utils import add_attrib
+from json import dumps
+from azure.functions._durable_functions import _serialize_custom_object
+
+
+class ContinueAsNewAction(Action):
+    """Defines the structure of the Continue As New object.
+
+    Provides the information needed by the durable extension to be able to reset the orchestration
+    and continue as new.
+    """
+
+    def __init__(self, input_=None):
+        self.input_ = dumps(input_, default=_serialize_custom_object)
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.CONTINUE_AS_NEW
+
+    def to_json(self) -> Dict[str, Union[int, str]]:
+        """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[int, str]] = {}
+        add_attrib(json_dict, self, 'action_type', 'actionType')
+        add_attrib(json_dict, self, 'input_', 'input')
+        return json_dict

azure/durable_functions/models/actions/CreateTimerAction.py

@@ -1,48 +1,48 @@
-from typing import Any, Dict, Union
-
-from .ActionType import ActionType
-from .Action import Action
-from ..utils.json_utils import add_attrib, add_datetime_attrib
-import datetime
-
-
-class CreateTimerAction(Action):
-    """Defines the structure of the Create Timer object.
-
-    Returns
-    -------
-        Information needed by durable extension to schedule the activity
-
-    Raises
-    ------
-    ValueError
-        if the event fired is not of valid datetime object
-    """
-
-    def __init__(self, fire_at: datetime.datetime, is_cancelled: bool = False):
-        self._action_type: ActionType = ActionType.CREATE_TIMER
-        self.fire_at: datetime.datetime = fire_at
-        self.is_cancelled: bool = is_cancelled
-
-        if not isinstance(self.fire_at, datetime.date):
-            raise ValueError("fireAt: Expected valid datetime object but got ", self.fire_at)
-
-    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, Union[int, str]] = {}
-        add_attrib(json_dict, self, 'action_type', 'actionType')
-        add_datetime_attrib(json_dict, self, 'fire_at', 'fireAt')
-        add_attrib(json_dict, self, 'is_cancelled', 'isCanceled')
-        return json_dict
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.CREATE_TIMER
+from typing import Any, Dict, Union
+
+from .ActionType import ActionType
+from .Action import Action
+from ..utils.json_utils import add_attrib, add_datetime_attrib
+import datetime
+
+
+class CreateTimerAction(Action):
+    """Defines the structure of the Create Timer object.
+
+    Returns
+    -------
+        Information needed by durable extension to schedule the activity
+
+    Raises
+    ------
+    ValueError
+        if the event fired is not of valid datetime object
+    """
+
+    def __init__(self, fire_at: datetime.datetime, is_cancelled: bool = False):
+        self._action_type: ActionType = ActionType.CREATE_TIMER
+        self.fire_at: datetime.datetime = fire_at
+        self.is_cancelled: bool = is_cancelled
+
+        if not isinstance(self.fire_at, datetime.date):
+            raise ValueError("fireAt: Expected valid datetime object but got ", self.fire_at)
+
+    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, Union[int, str]] = {}
+        add_attrib(json_dict, self, 'action_type', 'actionType')
+        add_datetime_attrib(json_dict, self, 'fire_at', 'fireAt')
+        add_attrib(json_dict, self, 'is_cancelled', 'isCanceled')
+        return json_dict
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.CREATE_TIMER

azure/durable_functions/models/actions/NoOpAction.py

@@ -1,35 +1,35 @@
-from azure.durable_functions.models.actions.Action import Action
-from typing import Any, Dict, Optional
-
-
-class NoOpAction(Action):
-    """A no-op action, for anonymous tasks only."""
-
-    def __init__(self, metadata: Optional[str] = None):
-        """Create a NoOpAction object.
-
-        This is an internal-only action class used to represent cases when intermediate
-        tasks are used to implement some API. For example, in -WithRetry APIs, intermediate
-        timers are created. We create this NoOp action to track those the backing actions
-        of those tasks, which is necessary because we mimic the DF-internal replay algorithm.
-
-        Parameters
-        ----------
-        metadata : Optional[str]
-            Used for internal debugging: metadata about the action being represented.
-        """
-        self.metadata = metadata
-
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        raise Exception("Attempted to get action type of an anonymous Action")
-
-    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
-        """
-        raise Exception("Attempted to convert an anonymous Action to JSON")
+from azure.durable_functions.models.actions.Action import Action
+from typing import Any, Dict, Optional
+
+
+class NoOpAction(Action):
+    """A no-op action, for anonymous tasks only."""
+
+    def __init__(self, metadata: Optional[str] = None):
+        """Create a NoOpAction object.
+
+        This is an internal-only action class used to represent cases when intermediate
+        tasks are used to implement some API. For example, in -WithRetry APIs, intermediate
+        timers are created. We create this NoOp action to track those the backing actions
+        of those tasks, which is necessary because we mimic the DF-internal replay algorithm.
+
+        Parameters
+        ----------
+        metadata : Optional[str]
+            Used for internal debugging: metadata about the action being represented.
+        """
+        self.metadata = metadata
+
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        raise Exception("Attempted to get action type of an anonymous Action")
+
+    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
+        """
+        raise Exception("Attempted to convert an anonymous Action to JSON")

azure/durable_functions/models/actions/SignalEntityAction.py

@@ -1,47 +1,47 @@
-from typing import Any, Dict
-
-from .Action import Action
-from .ActionType import ActionType
-from ..utils.json_utils import add_attrib
-from json import dumps
-from azure.functions._durable_functions import _serialize_custom_object
-from ..utils.entity_utils import EntityId
-
-
-class SignalEntityAction(Action):
-    """Defines the structure of the Signal Entity object.
-
-    Provides the information needed by the durable extension to be able to signal an entity
-    """
-
-    def __init__(self, entity_id: EntityId, operation: str, input_=None):
-        self.entity_id: EntityId = entity_id
-
-        # Validating that EntityId exists before trying to parse its instanceId
-        if not self.entity_id:
-            raise ValueError("entity_id cannot be empty")
-
-        self.instance_id: str = EntityId.get_scheduler_id(entity_id)
-        self.operation: str = operation
-        self.input_: str = dumps(input_, default=_serialize_custom_object)
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.SIGNAL_ENTITY
-
-    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, "action_type", "actionType")
-        add_attrib(json_dict, self, 'instance_id', 'instanceId')
-        add_attrib(json_dict, self, 'operation', 'operation')
-        add_attrib(json_dict, self, 'input_', 'input')
-
-        return json_dict
+from typing import Any, Dict
+
+from .Action import Action
+from .ActionType import ActionType
+from ..utils.json_utils import add_attrib
+from json import dumps
+from azure.functions._durable_functions import _serialize_custom_object
+from ..utils.entity_utils import EntityId
+
+
+class SignalEntityAction(Action):
+    """Defines the structure of the Signal Entity object.
+
+    Provides the information needed by the durable extension to be able to signal an entity
+    """
+
+    def __init__(self, entity_id: EntityId, operation: str, input_=None):
+        self.entity_id: EntityId = entity_id
+
+        # Validating that EntityId exists before trying to parse its instanceId
+        if not self.entity_id:
+            raise ValueError("entity_id cannot be empty")
+
+        self.instance_id: str = EntityId.get_scheduler_id(entity_id)
+        self.operation: str = operation
+        self.input_: str = dumps(input_, default=_serialize_custom_object)
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.SIGNAL_ENTITY
+
+    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, "action_type", "actionType")
+        add_attrib(json_dict, self, 'instance_id', 'instanceId')
+        add_attrib(json_dict, self, 'operation', 'operation')
+        add_attrib(json_dict, self, 'input_', 'input')
+
+        return json_dict