azure-functions-durable 1.2.8__py3-none-any.whl → 1.2.10__py3-none-any.whl

azure/durable_functions/models/actions/WaitForExternalEventAction.py

@@ -1,63 +1,63 @@
-from typing import Any, Dict, Union
-
-from .Action import Action
-from .ActionType import ActionType
-from ..utils.json_utils import add_attrib
-
-
-class WaitForExternalEventAction(Action):
-    """Defines the structure of Wait for External Event object.
-
-    Returns
-    -------
-    WaitForExternalEventAction
-        Returns a WaitForExternalEventAction Class.
-
-    Raises
-    ------
-    ValueError
-        Raises error if external_event_name is not defined.
-    """
-
-    def __init__(self, external_event_name: str):
-        self.external_event_name: str = external_event_name
-        self.reason = "ExternalEvent"
-
-        if not self.external_event_name:
-            raise ValueError("external_event_name cannot be empty")
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.WAIT_FOR_EXTERNAL_EVENT
-
-    def to_json(self) -> Dict[str, Any]:
-        """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, 'external_event_name', 'externalEventName')
-        add_attrib(json_dict, self, 'reason', 'reason')
-        return json_dict
-
-    def __eq__(self, other):
-        """Override the default __eq__ method.
-
-        Returns
-        -------
-        Bool
-            Returns True if two class instances has same values at all properties,
-            and returns False otherwise.
-        """
-        if not isinstance(other, WaitForExternalEventAction):
-            return False
-        else:
-            return self.action_type == other.action_type \
-                and self.external_event_name == other.external_event_name \
-                and self.reason == other.reason
+from typing import Any, Dict, Union
+
+from .Action import Action
+from .ActionType import ActionType
+from ..utils.json_utils import add_attrib
+
+
+class WaitForExternalEventAction(Action):
+    """Defines the structure of Wait for External Event object.
+
+    Returns
+    -------
+    WaitForExternalEventAction
+        Returns a WaitForExternalEventAction Class.
+
+    Raises
+    ------
+    ValueError
+        Raises error if external_event_name is not defined.
+    """
+
+    def __init__(self, external_event_name: str):
+        self.external_event_name: str = external_event_name
+        self.reason = "ExternalEvent"
+
+        if not self.external_event_name:
+            raise ValueError("external_event_name cannot be empty")
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.WAIT_FOR_EXTERNAL_EVENT
+
+    def to_json(self) -> Dict[str, Any]:
+        """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, 'external_event_name', 'externalEventName')
+        add_attrib(json_dict, self, 'reason', 'reason')
+        return json_dict
+
+    def __eq__(self, other):
+        """Override the default __eq__ method.
+
+        Returns
+        -------
+        Bool
+            Returns True if two class instances has same values at all properties,
+            and returns False otherwise.
+        """
+        if not isinstance(other, WaitForExternalEventAction):
+            return False
+        else:
+            return self.action_type == other.action_type \
+                and self.external_event_name == other.external_event_name \
+                and self.reason == other.reason

azure/durable_functions/models/actions/WhenAllAction.py

@@ -1,14 +1,14 @@
-from .ActionType import ActionType
-from azure.durable_functions.models.actions.CompoundAction import CompoundAction
-
-
-class WhenAllAction(CompoundAction):
-    """Defines the structure of the WhenAll Action object.
-
-    Provides the information needed by the durable extension to be able to invoke WhenAll tasks.
-    """
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.WHEN_ALL
+from .ActionType import ActionType
+from azure.durable_functions.models.actions.CompoundAction import CompoundAction
+
+
+class WhenAllAction(CompoundAction):
+    """Defines the structure of the WhenAll Action object.
+
+    Provides the information needed by the durable extension to be able to invoke WhenAll tasks.
+    """
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.WHEN_ALL

azure/durable_functions/models/actions/WhenAnyAction.py

@@ -1,14 +1,14 @@
-from azure.durable_functions.models.actions.CompoundAction import CompoundAction
-from .ActionType import ActionType
-
-
-class WhenAnyAction(CompoundAction):
-    """Defines the structure of the WhenAll Action object.
-
-    Provides the information needed by the durable extension to be able to invoke WhenAll tasks.
-    """
-
-    @property
-    def action_type(self) -> int:
-        """Get the type of action this class represents."""
-        return ActionType.WHEN_ANY
+from azure.durable_functions.models.actions.CompoundAction import CompoundAction
+from .ActionType import ActionType
+
+
+class WhenAnyAction(CompoundAction):
+    """Defines the structure of the WhenAll Action object.
+
+    Provides the information needed by the durable extension to be able to invoke WhenAll tasks.
+    """
+
+    @property
+    def action_type(self) -> int:
+        """Get the type of action this class represents."""
+        return ActionType.WHEN_ANY

azure/durable_functions/models/actions/__init__.py

@@ -1,24 +1,24 @@
-"""Defines the models for the different forms of Activities that can be scheduled."""
-from .Action import Action
-from .ActionType import ActionType
-from .CallActivityAction import CallActivityAction
-from .CallActivityWithRetryAction import CallActivityWithRetryAction
-from .CallSubOrchestratorAction import CallSubOrchestratorAction
-from .WaitForExternalEventAction import WaitForExternalEventAction
-from .CallHttpAction import CallHttpAction
-from .CreateTimerAction import CreateTimerAction
-from .WhenAllAction import WhenAllAction
-from .WhenAnyAction import WhenAnyAction
-
-__all__ = [
-    'Action',
-    'ActionType',
-    'CallActivityAction',
-    'CallActivityWithRetryAction',
-    'CallSubOrchestratorAction',
-    'CallHttpAction',
-    'WaitForExternalEventAction',
-    'CreateTimerAction',
-    'WhenAnyAction',
-    'WhenAllAction'
-]
+"""Defines the models for the different forms of Activities that can be scheduled."""
+from .Action import Action
+from .ActionType import ActionType
+from .CallActivityAction import CallActivityAction
+from .CallActivityWithRetryAction import CallActivityWithRetryAction
+from .CallSubOrchestratorAction import CallSubOrchestratorAction
+from .WaitForExternalEventAction import WaitForExternalEventAction
+from .CallHttpAction import CallHttpAction
+from .CreateTimerAction import CreateTimerAction
+from .WhenAllAction import WhenAllAction
+from .WhenAnyAction import WhenAnyAction
+
+__all__ = [
+    'Action',
+    'ActionType',
+    'CallActivityAction',
+    'CallActivityWithRetryAction',
+    'CallSubOrchestratorAction',
+    'CallHttpAction',
+    'WaitForExternalEventAction',
+    'CreateTimerAction',
+    'WhenAnyAction',
+    'WhenAllAction'
+]

azure/durable_functions/models/entities/EntityState.py

@@ -1,74 +1,74 @@
-from typing import List, Optional, Dict, Any
-from .Signal import Signal
-from azure.functions._durable_functions import _serialize_custom_object
-from .OperationResult import OperationResult
-import json
-
-
-class EntityState:
-    """Entity State.
-
-    Used to communicate the state of the entity back to the durable extension
-    """
-
-    def __init__(self,
-                 results: List[OperationResult],
-                 signals: List[Signal],
-                 entity_exists: bool = False,
-                 state: Optional[str] = None):
-        self.entity_exists = entity_exists
-        self.state = state
-        self._results = results
-        self._signals = signals
-
-    @property
-    def results(self) -> List[OperationResult]:
-        """Get list of results of the entity.
-
-        Returns
-        -------
-        List[OperationResult]:
-            The results of the entity
-        """
-        return self._results
-
-    @property
-    def signals(self) -> List[Signal]:
-        """Get list of signals to the entity.
-
-        Returns
-        -------
-        List[Signal]:
-            The signals of the entity
-        """
-        return self._signals
-
-    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] = {}
-        # Serialize the OperationResult list
-        serialized_results = list(map(lambda x: x.to_json(), self.results))
-
-        json_dict["entityExists"] = self.entity_exists
-        json_dict["entityState"] = json.dumps(self.state, default=_serialize_custom_object)
-        json_dict["results"] = serialized_results
-        json_dict["signals"] = self.signals
-        return json_dict
-
-    def to_json_string(self) -> str:
-        """Convert object into a json string.
-
-        Returns
-        -------
-        str
-            The instance of the object in json string format
-        """
-        # TODO: Same implementation as in Orchestrator.py, we should refactor to shared a base
-        json_dict = self.to_json()
-        return json.dumps(json_dict)
+from typing import List, Optional, Dict, Any
+from .Signal import Signal
+from azure.functions._durable_functions import _serialize_custom_object
+from .OperationResult import OperationResult
+import json
+
+
+class EntityState:
+    """Entity State.
+
+    Used to communicate the state of the entity back to the durable extension
+    """
+
+    def __init__(self,
+                 results: List[OperationResult],
+                 signals: List[Signal],
+                 entity_exists: bool = False,
+                 state: Optional[str] = None):
+        self.entity_exists = entity_exists
+        self.state = state
+        self._results = results
+        self._signals = signals
+
+    @property
+    def results(self) -> List[OperationResult]:
+        """Get list of results of the entity.
+
+        Returns
+        -------
+        List[OperationResult]:
+            The results of the entity
+        """
+        return self._results
+
+    @property
+    def signals(self) -> List[Signal]:
+        """Get list of signals to the entity.
+
+        Returns
+        -------
+        List[Signal]:
+            The signals of the entity
+        """
+        return self._signals
+
+    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] = {}
+        # Serialize the OperationResult list
+        serialized_results = list(map(lambda x: x.to_json(), self.results))
+
+        json_dict["entityExists"] = self.entity_exists
+        json_dict["entityState"] = json.dumps(self.state, default=_serialize_custom_object)
+        json_dict["results"] = serialized_results
+        json_dict["signals"] = self.signals
+        return json_dict
+
+    def to_json_string(self) -> str:
+        """Convert object into a json string.
+
+        Returns
+        -------
+        str
+            The instance of the object in json string format
+        """
+        # TODO: Same implementation as in Orchestrator.py, we should refactor to shared a base
+        json_dict = self.to_json()
+        return json.dumps(json_dict)

azure/durable_functions/models/entities/OperationResult.py

@@ -1,76 +1,76 @@
-from typing import Optional, Dict, Any
-from azure.functions._durable_functions import _serialize_custom_object
-import json
-
-
-class OperationResult:
-    """OperationResult.
-
-    The result of an Entity operation.
-    """
-
-    def __init__(self,
-                 is_error: bool,
-                 duration: int,
-                 result: Optional[str] = None):
-        """Instantiate an OperationResult.
-
-        Parameters
-        ----------
-        is_error: bool
-            Whether or not the operation resulted in an exception.
-        duration: int
-            How long the operation took, in milliseconds.
-        result: Optional[str]
-            The operation result. Defaults to None.
-        """
-        self._is_error: bool = is_error
-        self._duration: int = duration
-        self._result: Optional[str] = result
-
-    @property
-    def is_error(self) -> bool:
-        """Determine if the operation resulted in an error.
-
-        Returns
-        -------
-        bool
-            True if the operation resulted in error. Otherwise False.
-        """
-        return self._is_error
-
-    @property
-    def duration(self) -> int:
-        """Get the duration of this operation.
-
-        Returns
-        -------
-        int:
-            The duration of this operation, in milliseconds
-        """
-        return self._duration
-
-    @property
-    def result(self) -> Any:
-        """Get the operation's result.
-
-        Returns
-        -------
-        Any
-            The operation's result
-        """
-        return self._result
-
-    def to_json(self) -> Dict[str, Any]:
-        """Represent OperationResult as a JSON-serializable Dict.
-
-        Returns
-        -------
-        Dict[str, Any]
-            A JSON-serializable Dict of the OperationResult
-        """
-        to_json: Dict[str, Any] = {}
-        to_json["isError"] = self.is_error
-        to_json["duration"] = self.duration
-        to_json["result"] = json.dumps(self.result, default=_serialize_custom_object)
-        return to_json
+from typing import Optional, Dict, Any
+from azure.functions._durable_functions import _serialize_custom_object
+import json
+
+
+class OperationResult:
+    """OperationResult.
+
+    The result of an Entity operation.
+    """
+
+    def __init__(self,
+                 is_error: bool,
+                 duration: int,
+                 result: Optional[str] = None):
+        """Instantiate an OperationResult.
+
+        Parameters
+        ----------
+        is_error: bool
+            Whether or not the operation resulted in an exception.
+        duration: int
+            How long the operation took, in milliseconds.
+        result: Optional[str]
+            The operation result. Defaults to None.
+        """
+        self._is_error: bool = is_error
+        self._duration: int = duration
+        self._result: Optional[str] = result
+
+    @property
+    def is_error(self) -> bool:
+        """Determine if the operation resulted in an error.
+
+        Returns
+        -------
+        bool
+            True if the operation resulted in error. Otherwise False.
+        """
+        return self._is_error
+
+    @property
+    def duration(self) -> int:
+        """Get the duration of this operation.
+
+        Returns
+        -------
+        int:
+            The duration of this operation, in milliseconds
+        """
+        return self._duration
+
+    @property
+    def result(self) -> Any:
+        """Get the operation's result.
+
+        Returns
+        -------
+        Any
+            The operation's result
+        """
+        return self._result
+
+    def to_json(self) -> Dict[str, Any]:
+        """Represent OperationResult as a JSON-serializable Dict.
+
+        Returns
+        -------
+        Dict[str, Any]
+            A JSON-serializable Dict of the OperationResult
+        """
+        to_json: Dict[str, Any] = {}
+        to_json["isError"] = self.is_error
+        to_json["duration"] = self.duration
+        to_json["result"] = json.dumps(self.result, default=_serialize_custom_object)
+        return to_json

azure/durable_functions/models/entities/RequestMessage.py

@@ -1,53 +1,53 @@
-from typing import List, Optional, Any
-from ..utils.entity_utils import EntityId
-import json
-
-
-class RequestMessage:
-    """RequestMessage.
-
-    Specifies a request to an entity.
-    """
-
-    def __init__(self,
-                 id_: str,
-                 name: Optional[str] = None,
-                 signal: Optional[bool] = None,
-                 input_: Optional[str] = None,
-                 arg: Optional[Any] = None,
-                 parent: Optional[str] = None,
-                 lockset: Optional[List[EntityId]] = None,
-                 pos: Optional[int] = None,
-                 **kwargs):
-        # TODO: this class has too many optionals, may speak to
-        # over-caution, but it mimics the JS class. Investigate if
-        # these many Optionals are necessary.
-        self.id = id_
-        self.name = name
-        self.signal = signal
-        self.input = input_
-        self.arg = arg
-        self.parent = parent
-        self.lockset = lockset
-        self.pos = pos
-
-    @classmethod
-    def from_json(cls, json_str: str) -> 'RequestMessage':
-        """Instantiate a RequestMessage object from the durable-extension provided JSON data.
-
-        Parameters
-        ----------
-        json_str: str
-            A durable-extension provided json-formatted string representation of
-            a RequestMessage
-
-        Returns
-        -------
-        RequestMessage:
-            A RequestMessage object from the json_str parameter
-        """
-        # We replace the `id` key for `id_` to avoid clashes with reserved
-        # identifiers in Python
-        json_dict = json.loads(json_str)
-        json_dict["id_"] = json_dict.pop("id")
-        return cls(**json_dict)
+from typing import List, Optional, Any
+from ..utils.entity_utils import EntityId
+import json
+
+
+class RequestMessage:
+    """RequestMessage.
+
+    Specifies a request to an entity.
+    """
+
+    def __init__(self,
+                 id_: str,
+                 name: Optional[str] = None,
+                 signal: Optional[bool] = None,
+                 input_: Optional[str] = None,
+                 arg: Optional[Any] = None,
+                 parent: Optional[str] = None,
+                 lockset: Optional[List[EntityId]] = None,
+                 pos: Optional[int] = None,
+                 **kwargs):
+        # TODO: this class has too many optionals, may speak to
+        # over-caution, but it mimics the JS class. Investigate if
+        # these many Optionals are necessary.
+        self.id = id_
+        self.name = name
+        self.signal = signal
+        self.input = input_
+        self.arg = arg
+        self.parent = parent
+        self.lockset = lockset
+        self.pos = pos
+
+    @classmethod
+    def from_json(cls, json_str: str) -> 'RequestMessage':
+        """Instantiate a RequestMessage object from the durable-extension provided JSON data.
+
+        Parameters
+        ----------
+        json_str: str
+            A durable-extension provided json-formatted string representation of
+            a RequestMessage
+
+        Returns
+        -------
+        RequestMessage:
+            A RequestMessage object from the json_str parameter
+        """
+        # We replace the `id` key for `id_` to avoid clashes with reserved
+        # identifiers in Python
+        json_dict = json.loads(json_str)
+        json_dict["id_"] = json_dict.pop("id")
+        return cls(**json_dict)