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

azure/durable_functions/decorators/metadata.py

@@ -1,109 +1,109 @@
-#  Copyright (c) Microsoft Corporation. All rights reserved.
-#  Licensed under the MIT License.
-from typing import Optional
-
-from azure.durable_functions.constants import ORCHESTRATION_TRIGGER, \
-    ACTIVITY_TRIGGER, ENTITY_TRIGGER, DURABLE_CLIENT
-from azure.functions.decorators.core import Trigger, InputBinding
-
-
-class OrchestrationTrigger(Trigger):
-    """OrchestrationTrigger.
-
-    Trigger representing an Orchestration Function.
-    """
-
-    @staticmethod
-    def get_binding_name() -> str:
-        """Get the name of this trigger, as a string.
-
-        Returns
-        -------
-        str
-            The string representation of this trigger.
-        """
-        return ORCHESTRATION_TRIGGER
-
-    def __init__(self,
-                 name: str,
-                 orchestration: Optional[str] = None,
-                 ) -> None:
-        self.orchestration = orchestration
-        super().__init__(name=name)
-
-
-class ActivityTrigger(Trigger):
-    """ActivityTrigger.
-
-    Trigger representing a Durable Functions Activity.
-    """
-
-    @staticmethod
-    def get_binding_name() -> str:
-        """Get the name of this trigger, as a string.
-
-        Returns
-        -------
-        str
-            The string representation of this trigger.
-        """
-        return ACTIVITY_TRIGGER
-
-    def __init__(self,
-                 name: str,
-                 activity: Optional[str] = None,
-                 ) -> None:
-        self.activity = activity
-        super().__init__(name=name)
-
-
-class EntityTrigger(Trigger):
-    """EntityTrigger.
-
-    Trigger representing an Entity Function.
-    """
-
-    @staticmethod
-    def get_binding_name() -> str:
-        """Get the name of this trigger, as a string.
-
-        Returns
-        -------
-        str
-            The string representation of this trigger.
-        """
-        return ENTITY_TRIGGER
-
-    def __init__(self,
-                 name: str,
-                 entity_name: Optional[str] = None,
-                 ) -> None:
-        self.entity_name = entity_name
-        super().__init__(name=name)
-
-
-class DurableClient(InputBinding):
-    """DurableClient.
-
-    Binding representing a Durable-client object.
-    """
-
-    @staticmethod
-    def get_binding_name() -> str:
-        """Get the name of this Binding, as a string.
-
-        Returns
-        -------
-        str
-            The string representation of this binding.
-        """
-        return DURABLE_CLIENT
-
-    def __init__(self,
-                 name: str,
-                 task_hub: Optional[str] = None,
-                 connection_name: Optional[str] = None
-                 ) -> None:
-        self.task_hub = task_hub
-        self.connection_name = connection_name
-        super().__init__(name=name)
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+from typing import Optional
+
+from azure.durable_functions.constants import ORCHESTRATION_TRIGGER, \
+    ACTIVITY_TRIGGER, ENTITY_TRIGGER, DURABLE_CLIENT
+from azure.functions.decorators.core import Trigger, InputBinding
+
+
+class OrchestrationTrigger(Trigger):
+    """OrchestrationTrigger.
+
+    Trigger representing an Orchestration Function.
+    """
+
+    @staticmethod
+    def get_binding_name() -> str:
+        """Get the name of this trigger, as a string.
+
+        Returns
+        -------
+        str
+            The string representation of this trigger.
+        """
+        return ORCHESTRATION_TRIGGER
+
+    def __init__(self,
+                 name: str,
+                 orchestration: Optional[str] = None,
+                 ) -> None:
+        self.orchestration = orchestration
+        super().__init__(name=name)
+
+
+class ActivityTrigger(Trigger):
+    """ActivityTrigger.
+
+    Trigger representing a Durable Functions Activity.
+    """
+
+    @staticmethod
+    def get_binding_name() -> str:
+        """Get the name of this trigger, as a string.
+
+        Returns
+        -------
+        str
+            The string representation of this trigger.
+        """
+        return ACTIVITY_TRIGGER
+
+    def __init__(self,
+                 name: str,
+                 activity: Optional[str] = None,
+                 ) -> None:
+        self.activity = activity
+        super().__init__(name=name)
+
+
+class EntityTrigger(Trigger):
+    """EntityTrigger.
+
+    Trigger representing an Entity Function.
+    """
+
+    @staticmethod
+    def get_binding_name() -> str:
+        """Get the name of this trigger, as a string.
+
+        Returns
+        -------
+        str
+            The string representation of this trigger.
+        """
+        return ENTITY_TRIGGER
+
+    def __init__(self,
+                 name: str,
+                 entity_name: Optional[str] = None,
+                 ) -> None:
+        self.entity_name = entity_name
+        super().__init__(name=name)
+
+
+class DurableClient(InputBinding):
+    """DurableClient.
+
+    Binding representing a Durable-client object.
+    """
+
+    @staticmethod
+    def get_binding_name() -> str:
+        """Get the name of this Binding, as a string.
+
+        Returns
+        -------
+        str
+            The string representation of this binding.
+        """
+        return DURABLE_CLIENT
+
+    def __init__(self,
+                 name: str,
+                 task_hub: Optional[str] = None,
+                 connection_name: Optional[str] = None
+                 ) -> None:
+        self.task_hub = task_hub
+        self.connection_name = connection_name
+        super().__init__(name=name)

azure/durable_functions/entity.py

@@ -1,125 +1,129 @@
-from .models import DurableEntityContext
-from .models.entities import OperationResult, EntityState
-from datetime import datetime
-from typing import Callable, Any, List, Dict
-
-
-class InternalEntityException(Exception):
-    """Framework-internal Exception class (for internal use only)."""
-
-    pass
-
-
-class Entity:
-    """Durable Entity Class.
-
-    Responsible for executing the user-defined entity function.
-    """
-
-    def __init__(self, entity_func: Callable[[DurableEntityContext], None]):
-        """Create a new entity for the user-defined entity.
-
-        Responsible for executing the user-defined entity function
-
-        Parameters
-        ----------
-        entity_func: Callable[[DurableEntityContext], Generator[Any, Any, Any]]
-            The user defined entity function
-        """
-        self.fn: Callable[[DurableEntityContext], None] = entity_func
-
-    def handle(self, context: DurableEntityContext, batch: List[Dict[str, Any]]) -> str:
-        """Handle the execution of the user-defined entity function.
-
-        Loops over the batch, which serves to specify inputs to the entity,
-        and collects results and generates a final state, which are returned.
-
-        Parameters
-        ----------
-        context: DurableEntityContext
-            The entity context of the entity, which the user interacts with as their Durable API
-
-        Returns
-        -------
-        str
-            A JSON-formatted string representing the output state, results, and exceptions for the
-            entity execution.
-        """
-        response = EntityState(results=[], signals=[])
-        for operation_data in batch:
-            result: Any = None
-            is_error: bool = False
-            start_time: datetime = datetime.now()
-
-            try:
-                # populate context
-                operation = operation_data["name"]
-                if operation is None:
-                    message = "Durable Functions Internal Error:"\
-                        "Entity operation was missing a name field"
-                    raise InternalEntityException(message)
-                context._operation = operation
-                context._input = operation_data["input"]
-                self.fn(context)
-                result = context._result
-
-            except InternalEntityException as e:
-                raise e
-
-            except Exception as e:
-                is_error = True
-                result = str(e)
-
-            duration: int = self._elapsed_milliseconds_since(start_time)
-            operation_result = OperationResult(
-                is_error=is_error,
-                duration=duration,
-                result=result
-            )
-            response.results.append(operation_result)
-
-        response.state = context._state
-        response.entity_exists = context._exists
-        return response.to_json_string()
-
-    @classmethod
-    def create(cls, fn: Callable[[DurableEntityContext], None]) -> Callable[[Any], str]:
-        """Create an instance of the entity class.
-
-        Parameters
-        ----------
-            fn (Callable[[DurableEntityContext], None]): [description]
-
-        Returns
-        -------
-        Callable[[Any], str]
-            Handle function of the newly created entity client
-        """
-        def handle(context) -> str:
-            # It is not clear when the context JSON would be found
-            # inside a "body"-key, but this pattern matches the
-            # orchestrator implementation, so we keep it for safety.
-            context_body = getattr(context, "body", None)
-            if context_body is None:
-                context_body = context
-            ctx, batch = DurableEntityContext.from_json(context_body)
-            return Entity(fn).handle(ctx, batch)
-        return handle
-
-    def _elapsed_milliseconds_since(self, start_time: datetime) -> int:
-        """Calculate the elapsed time, in milliseconds, from the start_time to the present.
-
-        Parameters
-        ----------
-        start_time: datetime
-            The timestamp of when the entity began processing a batched request.
-
-        Returns
-        -------
-        int
-            The time, in millseconds, from start_time to now
-        """
-        end_time = datetime.now()
-        time_diff = end_time - start_time
-        elapsed_time = int(time_diff.total_seconds() * 1000)
-        return elapsed_time
+from .models import DurableEntityContext
+from .models.entities import OperationResult, EntityState
+from datetime import datetime, timezone
+from typing import Callable, Any, List, Dict
+
+
+class InternalEntityException(Exception):
+    """Framework-internal Exception class (for internal use only)."""
+
+    pass
+
+
+class Entity:
+    """Durable Entity Class.
+
+    Responsible for executing the user-defined entity function.
+    """
+
+    def __init__(self, entity_func: Callable[[DurableEntityContext], None]):
+        """Create a new entity for the user-defined entity.
+
+        Responsible for executing the user-defined entity function
+
+        Parameters
+        ----------
+        entity_func: Callable[[DurableEntityContext], Generator[Any, Any, Any]]
+            The user defined entity function
+        """
+        self.fn: Callable[[DurableEntityContext], None] = entity_func
+
+    def handle(self, context: DurableEntityContext, batch: List[Dict[str, Any]]) -> str:
+        """Handle the execution of the user-defined entity function.
+
+        Loops over the batch, which serves to specify inputs to the entity,
+        and collects results and generates a final state, which are returned.
+
+        Parameters
+        ----------
+        context: DurableEntityContext
+            The entity context of the entity, which the user interacts with as their Durable API
+
+        Returns
+        -------
+        str
+            A JSON-formatted string representing the output state, results, and exceptions for the
+            entity execution.
+        """
+        response = EntityState(results=[], signals=[])
+        for operation_data in batch:
+            result: Any = None
+            is_error: bool = False
+            start_time: datetime = datetime.now(timezone.utc)
+
+            try:
+                # populate context
+                operation = operation_data["name"]
+                if operation is None:
+                    message = "Durable Functions Internal Error:"\
+                        "Entity operation was missing a name field"
+                    raise InternalEntityException(message)
+                context._operation = operation
+                context._input = operation_data["input"]
+                self.fn(context)
+                result = context._result
+
+            except InternalEntityException as e:
+                raise e
+
+            except Exception as e:
+                is_error = True
+                result = str(e)
+
+            duration: int = self._elapsed_milliseconds_since(start_time)
+            operation_result = OperationResult(
+                is_error=is_error,
+                duration=duration,
+                execution_start_time_ms=int(start_time.timestamp() * 1000),
+                result=result
+            )
+            response.results.append(operation_result)
+
+        response.state = context._state
+        response.entity_exists = context._exists
+        return response.to_json_string()
+
+    @classmethod
+    def create(cls, fn: Callable[[DurableEntityContext], None]) -> Callable[[Any], str]:
+        """Create an instance of the entity class.
+
+        Parameters
+        ----------
+            fn (Callable[[DurableEntityContext], None]): [description]
+
+        Returns
+        -------
+        Callable[[Any], str]
+            Handle function of the newly created entity client
+        """
+        def handle(context) -> str:
+            # It is not clear when the context JSON would be found
+            # inside a "body"-key, but this pattern matches the
+            # orchestrator implementation, so we keep it for safety.
+            context_body = getattr(context, "body", None)
+            if context_body is None:
+                context_body = context
+            ctx, batch = DurableEntityContext.from_json(context_body)
+            return Entity(fn).handle(ctx, batch)
+
+        handle.entity_function = fn
+
+        return handle
+
+    def _elapsed_milliseconds_since(self, start_time: datetime) -> int:
+        """Calculate the elapsed time, in milliseconds, from the start_time to the present.
+
+        Parameters
+        ----------
+        start_time: datetime
+            The timestamp of when the entity began processing a batched request.
+
+        Returns
+        -------
+        int
+            The time, in millseconds, from start_time to now
+        """
+        end_time = datetime.now(timezone.utc)
+        time_diff = end_time - start_time
+        elapsed_time = int(time_diff.total_seconds() * 1000)
+        return elapsed_time