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

azure/durable_functions/models/utils/entity_utils.py

@@ -1,91 +1,103 @@
-class EntityId:
-    """EntityId.
-
-    It identifies an entity by its name and its key.
-    """
-
-    def __init__(self, name: str, key: str):
-        """Instantiate an EntityId object.
-
-        Identifies an entity by its name and its key.
-
-        Parameters
-        ----------
-        name: str
-            The entity name
-        key: str
-            The entity key
-
-        Raises
-        ------
-            ValueError: If the entity name or key are the empty string
-        """
-        if name == "":
-            raise ValueError("Entity name cannot be empty")
-        if key == "":
-            raise ValueError("Entity key cannot be empty")
-        self.name: str = name
-        self.key: str = key
-
-    @staticmethod
-    def get_scheduler_id(entity_id: 'EntityId') -> str:
-        """Produce a SchedulerId from an EntityId.
-
-        Parameters
-        ----------
-        entity_id: EntityId
-            An EntityId object
-
-        Returns
-        -------
-        str:
-            A SchedulerId representation of the input EntityId
-        """
-        return f"@{entity_id.name.lower()}@{entity_id.key}"
-
-    @staticmethod
-    def get_entity_id(scheduler_id: str) -> 'EntityId':
-        """Return an EntityId from a SchedulerId string.
-
-        Parameters
-        ----------
-        scheduler_id: str
-            The SchedulerId in which to base the returned EntityId
-
-        Raises
-        ------
-        ValueError:
-            When the SchedulerId string does not have the expected format
-
-        Returns
-        -------
-        EntityId:
-            An EntityId object based on the SchedulerId string
-        """
-        sched_id_truncated = scheduler_id[1:]  # we drop the starting `@`
-        components = sched_id_truncated.split("@")
-        if len(components) != 2:
-            raise ValueError("Unexpected format in SchedulerId")
-        [name, key] = components
-        return EntityId(name, key)
-
-    @staticmethod
-    def get_entity_id_url_path(entity_id: 'EntityId') -> str:
-        """Print the the entity url path.
-
-        Returns
-        -------
-        str:
-            A url path of the EntityId
-        """
-        return f'entities/{entity_id.name}/{entity_id.key}'
-
-    def __str__(self) -> str:
-        """Print the string representation of this EntityId.
-
-        Returns
-        -------
-        str:
-            A SchedulerId-based string representation of the EntityId
-        """
-        return EntityId.get_scheduler_id(entity_id=self)
+class EntityId:
+    """EntityId.
+
+    It identifies an entity by its name and its key.
+    """
+
+    def __init__(self, name: str, key: str):
+        """Instantiate an EntityId object.
+
+        Identifies an entity by its name and its key.
+
+        Parameters
+        ----------
+        name: str
+            The entity name
+        key: str
+            The entity key
+
+        Raises
+        ------
+            ValueError: If the entity name or key are the empty string
+        """
+        if name == "":
+            raise ValueError("Entity name cannot be empty")
+        if key == "":
+            raise ValueError("Entity key cannot be empty")
+        self.name: str = name
+        self.key: str = key
+
+    @staticmethod
+    def get_scheduler_id(entity_id: 'EntityId') -> str:
+        """Produce a SchedulerId from an EntityId.
+
+        Parameters
+        ----------
+        entity_id: EntityId
+            An EntityId object
+
+        Returns
+        -------
+        str:
+            A SchedulerId representation of the input EntityId
+        """
+        return f"@{entity_id.name.lower()}@{entity_id.key}"
+
+    @staticmethod
+    def get_entity_id(scheduler_id: str) -> 'EntityId':
+        """Return an EntityId from a SchedulerId string.
+
+        Parameters
+        ----------
+        scheduler_id: str
+            The SchedulerId in which to base the returned EntityId
+
+        Raises
+        ------
+        ValueError:
+            When the SchedulerId string does not have the expected format
+
+        Returns
+        -------
+        EntityId:
+            An EntityId object based on the SchedulerId string
+        """
+        sched_id_truncated = scheduler_id[1:]  # we drop the starting `@`
+        components = sched_id_truncated.split("@")
+        if len(components) != 2:
+            raise ValueError("Unexpected format in SchedulerId")
+        [name, key] = components
+        return EntityId(name, key)
+
+    @staticmethod
+    def get_entity_id_url_path(entity_id: 'EntityId') -> str:
+        """Print the the entity url path.
+
+        Returns
+        -------
+        str:
+            A url path of the EntityId
+        """
+        return f'entities/{entity_id.name}/{entity_id.key}'
+
+    def __str__(self) -> str:
+        """Print the string representation of this EntityId.
+
+        Returns
+        -------
+        str:
+            A SchedulerId-based string representation of the EntityId
+        """
+        return EntityId.get_scheduler_id(entity_id=self)
+
+    def __eq__(self, other: object) -> bool:
+        """Check if two EntityId objects are equal.
+
+        Parameters
+        ----------
+        other: object
+        """
+        if not isinstance(other, EntityId):
+            return False
+
+        return self.name == other.name and self.key == other.key

azure/durable_functions/models/utils/http_utils.py

@@ -1,69 +1,80 @@
-from typing import Any, List, Union
-
-import aiohttp
-
-
-async def post_async_request(url: str, data: Any = None) -> List[Union[int, Any]]:
-    """Post request with the data provided to the url provided.
-
-    Parameters
-    ----------
-    url: str
-        url to make the post to
-    data: Any
-        object to post
-
-    Returns
-    -------
-    [int, Any]
-        Tuple with the Response status code and the data returned from the request
-    """
-    async with aiohttp.ClientSession() as session:
-        async with session.post(url,
-                                json=data) as response:
-            # We disable aiohttp's input type validation
-            # as the server may respond with alternative
-            # data encodings. This is potentially unsafe.
-            # More here: https://docs.aiohttp.org/en/stable/client_advanced.html
-            data = await response.json(content_type=None)
-            return [response.status, data]
-
-
-async def get_async_request(url: str) -> List[Any]:
-    """Get the data from the url provided.
-
-    Parameters
-    ----------
-    url: str
-        url to get the data from
-
-    Returns
-    -------
-    [int, Any]
-        Tuple with the Response status code and the data returned from the request
-    """
-    async with aiohttp.ClientSession() as session:
-        async with session.get(url) as response:
-            data = await response.json(content_type=None)
-            if data is None:
-                data = ""
-            return [response.status, data]
-
-
-async def delete_async_request(url: str) -> List[Union[int, Any]]:
-    """Delete the data from the url provided.
-
-    Parameters
-    ----------
-    url: str
-        url to delete the data from
-
-    Returns
-    -------
-    [int, Any]
-        Tuple with the Response status code and the data returned from the request
-    """
-    async with aiohttp.ClientSession() as session:
-        async with session.delete(url) as response:
-            data = await response.json(content_type=None)
-            return [response.status, data]
+from typing import Any, List, Union
+
+import aiohttp
+
+
+async def post_async_request(url: str,
+                             data: Any = None,
+                             trace_parent: str = None,
+                             trace_state: str = None) -> List[Union[int, Any]]:
+    """Post request with the data provided to the url provided.
+
+    Parameters
+    ----------
+    url: str
+        url to make the post to
+    data: Any
+        object to post
+    trace_parent: str
+        traceparent header to send with the request
+    trace_state: str
+        tracestate header to send with the request
+
+    Returns
+    -------
+    [int, Any]
+        Tuple with the Response status code and the data returned from the request
+    """
+    async with aiohttp.ClientSession() as session:
+        headers = {}
+        if trace_parent:
+            headers["traceparent"] = trace_parent
+        if trace_state:
+            headers["tracestate"] = trace_state
+        async with session.post(url, json=data, headers=headers) as response:
+            # We disable aiohttp's input type validation
+            # as the server may respond with alternative
+            # data encodings. This is potentially unsafe.
+            # More here: https://docs.aiohttp.org/en/stable/client_advanced.html
+            data = await response.json(content_type=None)
+            return [response.status, data]
+
+
+async def get_async_request(url: str) -> List[Any]:
+    """Get the data from the url provided.
+
+    Parameters
+    ----------
+    url: str
+        url to get the data from
+
+    Returns
+    -------
+    [int, Any]
+        Tuple with the Response status code and the data returned from the request
+    """
+    async with aiohttp.ClientSession() as session:
+        async with session.get(url) as response:
+            data = await response.json(content_type=None)
+            if data is None:
+                data = ""
+            return [response.status, data]
+
+
+async def delete_async_request(url: str) -> List[Union[int, Any]]:
+    """Delete the data from the url provided.
+
+    Parameters
+    ----------
+    url: str
+        url to delete the data from
+
+    Returns
+    -------
+    [int, Any]
+        Tuple with the Response status code and the data returned from the request
+    """
+    async with aiohttp.ClientSession() as session:
+        async with session.delete(url) as response:
+            data = await response.json(content_type=None)
+            return [response.status, data]

azure/durable_functions/models/utils/json_utils.py

@@ -1,56 +1,96 @@
-from typing import Dict, Any
-
-from ...constants import DATETIME_STRING_FORMAT
-
-
-def add_attrib(json_dict: Dict[str, Any], object_,
-               attribute_name: str, alt_name: str = None):
-    """Add the value of the attribute from the object to the dictionary.
-
-    Used to dynamically add the value of the attribute if the value is present.
-
-    Parameters
-    ----------
-    json_dict: The dictionary to add the attribute to
-    object_: The object to look for the attribute on
-    attribute_name: The name of the attribute to look for
-    alt_name: An alternate name to provide to the attribute in the in the dictionary
-    """
-    if hasattr(object_, attribute_name):
-        json_dict[alt_name or attribute_name] = \
-            getattr(object_, attribute_name)
-
-
-def add_datetime_attrib(json_dict: Dict[str, Any], object_,
-                        attribute_name: str, alt_name: str = None):
-    """Add the value of the attribute from the object to the dictionary converted into a string.
-
-    Parameters
-    ----------
-    json_dict: The dictionary to add the attribute to
-    object_: The object to look for the attribute on
-    attribute_name: The name of the attribute to look for
-    alt_name: An alternate name to provide to the attribute in the in the dictionary
-    """
-    if hasattr(object_, attribute_name):
-        json_dict[alt_name or attribute_name] = \
-            getattr(object_, attribute_name).strftime(DATETIME_STRING_FORMAT)
-
-
-def add_json_attrib(json_dict: Dict[str, Any], object_,
-                    attribute_name: str, alt_name: str = None):
-    """Add the results of the to_json() function call of the attribute from the object to the dict.
-
-    Used to dynamically add the JSON converted value of the attribute if the value is present.
-
-    Parameters
-    ----------
-    json_dict: The dictionary to add the attribute to
-    object_: The object to look for the attribute on
-    attribute_name: The name of the attribute to look for
-    alt_name: An alternate name to provide to the attribute in the in the dictionary
-    """
-    if hasattr(object_, attribute_name):
-        attribute_value = getattr(object_, attribute_name)
-        if attribute_value:
-            json_dict[alt_name or attribute_name] = attribute_value.to_json()
+import datetime
+import re
+from typing import Dict, Any
+
+from ...constants import DATETIME_STRING_FORMAT
+
+
+def add_attrib(json_dict: Dict[str, Any], object_,
+               attribute_name: str, alt_name: str = None):
+    """Add the value of the attribute from the object to the dictionary.
+
+    Used to dynamically add the value of the attribute if the value is present.
+
+    Parameters
+    ----------
+    json_dict: The dictionary to add the attribute to
+    object_: The object to look for the attribute on
+    attribute_name: The name of the attribute to look for
+    alt_name: An alternate name to provide to the attribute in the in the dictionary
+    """
+    if hasattr(object_, attribute_name):
+        json_dict[alt_name or attribute_name] = \
+            getattr(object_, attribute_name)
+
+
+def add_datetime_attrib(json_dict: Dict[str, Any], object_,
+                        attribute_name: str, alt_name: str = None):
+    """Add the value of the attribute from the object to the dictionary converted into a string.
+
+    Parameters
+    ----------
+    json_dict: The dictionary to add the attribute to
+    object_: The object to look for the attribute on
+    attribute_name: The name of the attribute to look for
+    alt_name: An alternate name to provide to the attribute in the in the dictionary
+    """
+    if hasattr(object_, attribute_name):
+        json_dict[alt_name or attribute_name] = \
+            getattr(object_, attribute_name).strftime(DATETIME_STRING_FORMAT)
+
+
+# When we recieve properties from WebJobs extension originally parsed as
+#   TimeSpan objects through Newtonsoft, the format complies with the constant
+#   format specifier for TimeSpan in .NET.
+#   Python offers no convenient way to parse these back into timedeltas,
+#   so we use this regex method instead
+def parse_timespan_attrib(from_str: str) -> datetime.timedelta:
+    """Convert a string representing TimeSpan.ToString("c") in .NET to a python timedelta.
+
+    Parameters
+    ----------
+    from_str: The string format of the TimeSpan to convert
+
+    Returns
+    -------
+    timespan.timedelta
+        The TimeSpan expressed as a Python datetime.timedelta
+
+    """
+    match = re.match(r"^(?P<negative>-)?(?:(?P<days>[0-9]*)\.)?"
+                     r"(?P<hours>[0-9]{2}):(?P<minutes>[0-9]{2})"
+                     r":(?P<seconds>[0-9]{2})(?:\.(?P<ticks>[0-9]{7}))?$",
+                     from_str)
+    if match:
+        groups = match.groupdict()
+        span = datetime.timedelta(
+            days=int(groups['days'] or "0"),
+            hours=int(groups['hours']),
+            minutes=int(groups['minutes']),
+            seconds=int(groups['seconds']),
+            microseconds=int(groups['ticks'] or "0") // 10)
+
+        if groups['negative'] == '-':
+            span = -span
+        return span
+    else:
+        raise Exception(f"Format of TimeSpan failed attempted conversion to timedelta: {from_str}")
+
+
+def add_json_attrib(json_dict: Dict[str, Any], object_,
+                    attribute_name: str, alt_name: str = None):
+    """Add the results of the to_json() function call of the attribute from the object to the dict.
+
+    Used to dynamically add the JSON converted value of the attribute if the value is present.
+
+    Parameters
+    ----------
+    json_dict: The dictionary to add the attribute to
+    object_: The object to look for the attribute on
+    attribute_name: The name of the attribute to look for
+    alt_name: An alternate name to provide to the attribute in the in the dictionary
+    """
+    if hasattr(object_, attribute_name):
+        attribute_value = getattr(object_, attribute_name)
+        if attribute_value:
+            json_dict[alt_name or attribute_name] = attribute_value.to_json()

azure/durable_functions/orchestrator.py

@@ -1,71 +1,73 @@
-"""Durable Orchestrator.
-
-Responsible for orchestrating the execution of the user defined generator
-function.
-"""
-from azure.durable_functions.models.TaskOrchestrationExecutor import TaskOrchestrationExecutor
-from typing import Callable, Any, Generator
-
-from .models import DurableOrchestrationContext
-
-import azure.functions as func
-
-
-class Orchestrator:
-    """Durable Orchestration Class.
-
-    Responsible for orchestrating the execution of the user defined generator
-    function.
-    """
-
-    def __init__(self,
-                 activity_func: Callable[[DurableOrchestrationContext], Generator[Any, Any, Any]]):
-        """Create a new orchestrator for the user defined generator.
-
-        Responsible for orchestrating the execution of the user defined
-        generator function.
-        :param activity_func: Generator function to orchestrate.
-        """
-        self.fn: Callable[[DurableOrchestrationContext], Generator[Any, Any, Any]] = activity_func
-        self.task_orchestration_executor = TaskOrchestrationExecutor()
-
-    def handle(self, context: DurableOrchestrationContext) -> str:
-        """Handle the orchestration of the user defined generator function.
-
-        Parameters
-        ----------
-        context : DurableOrchestrationContext
-            The DF orchestration context
-
-        Returns
-        -------
-        str
-            The JSON-formatted string representing the user's orchestration
-            state after this invocation
-        """
-        self.durable_context = context
-        return self.task_orchestration_executor.execute(context, context.histories, self.fn)
-
-    @classmethod
-    def create(cls, fn: Callable[[DurableOrchestrationContext], Generator[Any, Any, Any]]) \
-            -> Callable[[Any], str]:
-        """Create an instance of the orchestration class.
-
-        Parameters
-        ----------
-        fn: Callable[[DurableOrchestrationContext], Iterator[Any]]
-            Generator function that needs orchestration
-
-        Returns
-        -------
-        Callable[[Any], str]
-            Handle function of the newly created orchestration client
-        """
-
-        def handle(context: func.OrchestrationContext) -> str:
-            context_body = getattr(context, "body", None)
-            if context_body is None:
-                context_body = context
-            return Orchestrator(fn).handle(DurableOrchestrationContext.from_json(context_body))
-
-        return handle
+"""Durable Orchestrator.
+
+Responsible for orchestrating the execution of the user defined generator
+function.
+"""
+from azure.durable_functions.models.TaskOrchestrationExecutor import TaskOrchestrationExecutor
+from typing import Callable, Any, Generator
+
+from .models import DurableOrchestrationContext
+
+import azure.functions as func
+
+
+class Orchestrator:
+    """Durable Orchestration Class.
+
+    Responsible for orchestrating the execution of the user defined generator
+    function.
+    """
+
+    def __init__(self,
+                 activity_func: Callable[[DurableOrchestrationContext], Generator[Any, Any, Any]]):
+        """Create a new orchestrator for the user defined generator.
+
+        Responsible for orchestrating the execution of the user defined
+        generator function.
+        :param activity_func: Generator function to orchestrate.
+        """
+        self.fn: Callable[[DurableOrchestrationContext], Generator[Any, Any, Any]] = activity_func
+        self.task_orchestration_executor = TaskOrchestrationExecutor()
+
+    def handle(self, context: DurableOrchestrationContext) -> str:
+        """Handle the orchestration of the user defined generator function.
+
+        Parameters
+        ----------
+        context : DurableOrchestrationContext
+            The DF orchestration context
+
+        Returns
+        -------
+        str
+            The JSON-formatted string representing the user's orchestration
+            state after this invocation
+        """
+        self.durable_context = context
+        return self.task_orchestration_executor.execute(context, context.histories, self.fn)
+
+    @classmethod
+    def create(cls, fn: Callable[[DurableOrchestrationContext], Generator[Any, Any, Any]]) \
+            -> Callable[[Any], str]:
+        """Create an instance of the orchestration class.
+
+        Parameters
+        ----------
+        fn: Callable[[DurableOrchestrationContext], Iterator[Any]]
+            Generator function that needs orchestration
+
+        Returns
+        -------
+        Callable[[Any], str]
+            Handle function of the newly created orchestration client
+        """
+
+        def handle(context: func.OrchestrationContext) -> str:
+            context_body = getattr(context, "body", None)
+            if context_body is None:
+                context_body = context
+            return Orchestrator(fn).handle(DurableOrchestrationContext.from_json(context_body))
+
+        handle.orchestrator_function = fn
+
+        return handle