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

azure/durable_functions/models/DurableEntityContext.py

@@ -1,201 +1,201 @@
-from typing import Optional, Any, Dict, Tuple, List, Callable
-from azure.functions._durable_functions import _deserialize_custom_object
-import json
-
-
-class DurableEntityContext:
-    """Context of the durable entity context.
-
-    Describes the API used to specify durable entity user code.
-    """
-
-    def __init__(self,
-                 name: str,
-                 key: str,
-                 exists: bool,
-                 state: Any):
-        """Context of the durable entity context.
-
-        Describes the API used to specify durable entity user code.
-
-        Parameters
-        ----------
-        name: str
-            The name of the Durable Entity
-        key: str
-            The key of the Durable Entity
-        exists: bool
-            Flag to determine if the entity exists
-        state: Any
-            The internal state of the Durable Entity
-        """
-        self._entity_name: str = name
-        self._entity_key: str = key
-
-        self._exists: bool = exists
-        self._is_newly_constructed: bool = False
-
-        self._state: Any = state
-        self._input: Any = None
-        self._operation: Optional[str] = None
-        self._result: Any = None
-
-    @property
-    def entity_name(self) -> str:
-        """Get the name of the Entity.
-
-        Returns
-        -------
-        str
-            The name of the entity
-        """
-        return self._entity_name
-
-    @property
-    def entity_key(self) -> str:
-        """Get the Entity key.
-
-        Returns
-        -------
-        str
-            The entity key
-        """
-        return self._entity_key
-
-    @property
-    def operation_name(self) -> Optional[str]:
-        """Get the current operation name.
-
-        Returns
-        -------
-        Optional[str]
-            The current operation name
-        """
-        if self._operation is None:
-            raise Exception("Entity operation is unassigned")
-        return self._operation
-
-    @property
-    def is_newly_constructed(self) -> bool:
-        """Determine if the Entity was newly constructed.
-
-        Returns
-        -------
-        bool
-            True if the Entity was newly constructed. False otherwise.
-        """
-        # This is not updated at the moment, as its semantics are unclear
-        return self._is_newly_constructed
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Tuple['DurableEntityContext', List[Dict[str, Any]]]:
-        """Instantiate a DurableEntityContext from a JSON-formatted string.
-
-        Parameters
-        ----------
-        json_string: str
-            A JSON-formatted string, returned by the durable-extension,
-            which represents the entity context
-
-        Returns
-        -------
-        DurableEntityContext
-            The DurableEntityContext originated from the input string
-        """
-        json_dict = json.loads(json_str)
-        json_dict["name"] = json_dict["self"]["name"]
-        json_dict["key"] = json_dict["self"]["key"]
-        json_dict.pop("self")
-
-        serialized_state = json_dict["state"]
-        if serialized_state is not None:
-            json_dict["state"] = from_json_util(serialized_state)
-
-        batch = json_dict.pop("batch")
-        return cls(**json_dict), batch
-
-    def set_state(self, state: Any) -> None:
-        """Set the state of the entity.
-
-        Parameter
-        ---------
-        state: Any
-            The new state of the entity
-        """
-        self._exists = True
-
-        # should only serialize the state at the end of the batch
-        self._state = state
-
-    def get_state(self, initializer: Optional[Callable[[], Any]] = None) -> Any:
-        """Get the current state of this entity.
-
-        Parameters
-        ----------
-        initializer: Optional[Callable[[], Any]]
-            A 0-argument function to provide an initial state. Defaults to None.
-
-        Returns
-        -------
-        Any
-            The current state of the entity
-        """
-        state = self._state
-        if state is not None:
-            return state
-        elif initializer:
-            if not callable(initializer):
-                raise Exception("initializer argument needs to be a callable function")
-            state = initializer()
-        return state
-
-    def get_input(self) -> Any:
-        """Get the input for this operation.
-
-        Returns
-        -------
-        Any
-            The input for the current operation
-        """
-        input_ = None
-        req_input = self._input
-        req_input = json.loads(req_input)
-        input_ = None if req_input is None else from_json_util(req_input)
-        return input_
-
-    def set_result(self, result: Any) -> None:
-        """Set the result (return value) of the entity.
-
-        Paramaters
-        ----------
-        result: Any
-            The result / return value for the entity
-        """
-        self._exists = True
-        self._result = result
-
-    def destruct_on_exit(self) -> None:
-        """Delete this entity after the operation completes."""
-        self._exists = False
-        self._state = None
-
-
-def from_json_util(json_str: str) -> Any:
-    """Load an arbitrary datatype from its JSON representation.
-
-    The Out-of-proc SDK has a special JSON encoding strategy
-    to enable arbitrary datatypes to be serialized. This utility
-    loads a JSON with the assumption that it follows that encoding
-    method.
-
-    Parameters
-    ----------
-    json_str: str
-        A JSON-formatted string, from durable-extension
-
-    Returns
-    -------
-    Any:
-        The original datatype that was serialized
-    """
-    return json.loads(json_str, object_hook=_deserialize_custom_object)
+from typing import Optional, Any, Dict, Tuple, List, Callable
+from azure.functions._durable_functions import _deserialize_custom_object
+import json
+
+
+class DurableEntityContext:
+    """Context of the durable entity context.
+
+    Describes the API used to specify durable entity user code.
+    """
+
+    def __init__(self,
+                 name: str,
+                 key: str,
+                 exists: bool,
+                 state: Any):
+        """Context of the durable entity context.
+
+        Describes the API used to specify durable entity user code.
+
+        Parameters
+        ----------
+        name: str
+            The name of the Durable Entity
+        key: str
+            The key of the Durable Entity
+        exists: bool
+            Flag to determine if the entity exists
+        state: Any
+            The internal state of the Durable Entity
+        """
+        self._entity_name: str = name
+        self._entity_key: str = key
+
+        self._exists: bool = exists
+        self._is_newly_constructed: bool = False
+
+        self._state: Any = state
+        self._input: Any = None
+        self._operation: Optional[str] = None
+        self._result: Any = None
+
+    @property
+    def entity_name(self) -> str:
+        """Get the name of the Entity.
+
+        Returns
+        -------
+        str
+            The name of the entity
+        """
+        return self._entity_name
+
+    @property
+    def entity_key(self) -> str:
+        """Get the Entity key.
+
+        Returns
+        -------
+        str
+            The entity key
+        """
+        return self._entity_key
+
+    @property
+    def operation_name(self) -> Optional[str]:
+        """Get the current operation name.
+
+        Returns
+        -------
+        Optional[str]
+            The current operation name
+        """
+        if self._operation is None:
+            raise Exception("Entity operation is unassigned")
+        return self._operation
+
+    @property
+    def is_newly_constructed(self) -> bool:
+        """Determine if the Entity was newly constructed.
+
+        Returns
+        -------
+        bool
+            True if the Entity was newly constructed. False otherwise.
+        """
+        # This is not updated at the moment, as its semantics are unclear
+        return self._is_newly_constructed
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Tuple['DurableEntityContext', List[Dict[str, Any]]]:
+        """Instantiate a DurableEntityContext from a JSON-formatted string.
+
+        Parameters
+        ----------
+        json_string: str
+            A JSON-formatted string, returned by the durable-extension,
+            which represents the entity context
+
+        Returns
+        -------
+        DurableEntityContext
+            The DurableEntityContext originated from the input string
+        """
+        json_dict = json.loads(json_str)
+        json_dict["name"] = json_dict["self"]["name"]
+        json_dict["key"] = json_dict["self"]["key"]
+        json_dict.pop("self")
+
+        serialized_state = json_dict["state"]
+        if serialized_state is not None:
+            json_dict["state"] = from_json_util(serialized_state)
+
+        batch = json_dict.pop("batch")
+        return cls(**json_dict), batch
+
+    def set_state(self, state: Any) -> None:
+        """Set the state of the entity.
+
+        Parameter
+        ---------
+        state: Any
+            The new state of the entity
+        """
+        self._exists = True
+
+        # should only serialize the state at the end of the batch
+        self._state = state
+
+    def get_state(self, initializer: Optional[Callable[[], Any]] = None) -> Any:
+        """Get the current state of this entity.
+
+        Parameters
+        ----------
+        initializer: Optional[Callable[[], Any]]
+            A 0-argument function to provide an initial state. Defaults to None.
+
+        Returns
+        -------
+        Any
+            The current state of the entity
+        """
+        state = self._state
+        if state is not None:
+            return state
+        elif initializer:
+            if not callable(initializer):
+                raise Exception("initializer argument needs to be a callable function")
+            state = initializer()
+        return state
+
+    def get_input(self) -> Any:
+        """Get the input for this operation.
+
+        Returns
+        -------
+        Any
+            The input for the current operation
+        """
+        input_ = None
+        req_input = self._input
+        req_input = json.loads(req_input)
+        input_ = None if req_input is None else from_json_util(req_input)
+        return input_
+
+    def set_result(self, result: Any) -> None:
+        """Set the result (return value) of the entity.
+
+        Paramaters
+        ----------
+        result: Any
+            The result / return value for the entity
+        """
+        self._exists = True
+        self._result = result
+
+    def destruct_on_exit(self) -> None:
+        """Delete this entity after the operation completes."""
+        self._exists = False
+        self._state = None
+
+
+def from_json_util(json_str: str) -> Any:
+    """Load an arbitrary datatype from its JSON representation.
+
+    The Out-of-proc SDK has a special JSON encoding strategy
+    to enable arbitrary datatypes to be serialized. This utility
+    loads a JSON with the assumption that it follows that encoding
+    method.
+
+    Parameters
+    ----------
+    json_str: str
+        A JSON-formatted string, from durable-extension
+
+    Returns
+    -------
+    Any:
+        The original datatype that was serialized
+    """
+    return json.loads(json_str, object_hook=_deserialize_custom_object)

azure/durable_functions/models/DurableHttpRequest.py

@@ -1,58 +1,58 @@
-from typing import Dict, Union, Optional
-
-from azure.durable_functions.models.TokenSource import TokenSource
-from azure.durable_functions.models.utils.json_utils import add_attrib, add_json_attrib
-
-
-class DurableHttpRequest:
-    """Data structure representing a durable HTTP request."""
-
-    def __init__(self, method: str, uri: str, content: Optional[str] = None,
-                 headers: Optional[Dict[str, str]] = None,
-                 token_source: Optional[TokenSource] = None):
-        self._method: str = method
-        self._uri: str = uri
-        self._content: Optional[str] = content
-        self._headers: Optional[Dict[str, str]] = headers
-        self._token_source: Optional[TokenSource] = token_source
-
-    @property
-    def method(self) -> str:
-        """Get the HTTP request method."""
-        return self._method
-
-    @property
-    def uri(self) -> str:
-        """Get the HTTP request uri."""
-        return self._uri
-
-    @property
-    def content(self) -> Optional[str]:
-        """Get the HTTP request content."""
-        return self._content
-
-    @property
-    def headers(self) -> Optional[Dict[str, str]]:
-        """Get the HTTP request headers."""
-        return self._headers
-
-    @property
-    def token_source(self) -> Optional[TokenSource]:
-        """Get the source of OAuth token to add to the request."""
-        return self._token_source
-
-    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, 'method')
-        add_attrib(json_dict, self, 'uri')
-        add_attrib(json_dict, self, 'content')
-        add_attrib(json_dict, self, 'headers')
-        add_json_attrib(json_dict, self, 'token_source', 'tokenSource')
-        return json_dict
+from typing import Dict, Union, Optional
+
+from azure.durable_functions.models.TokenSource import TokenSource
+from azure.durable_functions.models.utils.json_utils import add_attrib, add_json_attrib
+
+
+class DurableHttpRequest:
+    """Data structure representing a durable HTTP request."""
+
+    def __init__(self, method: str, uri: str, content: Optional[str] = None,
+                 headers: Optional[Dict[str, str]] = None,
+                 token_source: Optional[TokenSource] = None):
+        self._method: str = method
+        self._uri: str = uri
+        self._content: Optional[str] = content
+        self._headers: Optional[Dict[str, str]] = headers
+        self._token_source: Optional[TokenSource] = token_source
+
+    @property
+    def method(self) -> str:
+        """Get the HTTP request method."""
+        return self._method
+
+    @property
+    def uri(self) -> str:
+        """Get the HTTP request uri."""
+        return self._uri
+
+    @property
+    def content(self) -> Optional[str]:
+        """Get the HTTP request content."""
+        return self._content
+
+    @property
+    def headers(self) -> Optional[Dict[str, str]]:
+        """Get the HTTP request headers."""
+        return self._headers
+
+    @property
+    def token_source(self) -> Optional[TokenSource]:
+        """Get the source of OAuth token to add to the request."""
+        return self._token_source
+
+    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, 'method')
+        add_attrib(json_dict, self, 'uri')
+        add_attrib(json_dict, self, 'content')
+        add_attrib(json_dict, self, 'headers')
+        add_json_attrib(json_dict, self, 'token_source', 'tokenSource')
+        return json_dict

azure/durable_functions/models/DurableOrchestrationBindings.py

@@ -1,66 +1,66 @@
-import json
-from typing import Dict, Optional
-
-from azure.durable_functions.models.FunctionContext import FunctionContext
-
-
-class DurableOrchestrationBindings:
-    """Binding information.
-
-    Provides information relevant to the creation and management of
-    durable functions.
-    """
-
-    # parameter names are as defined by JSON schema and do not conform to PEP8 naming conventions
-    def __init__(self, taskHubName: str, creationUrls: Dict[str, str],
-                 managementUrls: Dict[str, str], rpcBaseUrl: Optional[str] = None, **kwargs):
-        self._task_hub_name: str = taskHubName
-        self._creation_urls: Dict[str, str] = creationUrls
-        self._management_urls: Dict[str, str] = managementUrls
-        # TODO: we can remove the Optional once we drop support for 1.x,
-        # this is always provided in 2.x
-        self._rpc_base_url: Optional[str] = rpcBaseUrl
-        self._client_data = FunctionContext(**kwargs)
-
-    @property
-    def task_hub_name(self) -> str:
-        """Get the name of the container that is used for orchestrations."""
-        return self._task_hub_name
-
-    @property
-    def creation_urls(self) -> Dict[str, str]:
-        """Get the URLs that are used for creating new orchestrations."""
-        return self._creation_urls
-
-    @property
-    def management_urls(self) -> Dict[str, str]:
-        """Get the URLs that are used for managing orchestrations."""
-        return self._management_urls
-
-    @property
-    def rpc_base_url(self) -> Optional[str]:
-        """Get the base url communication between out of proc workers and the function host."""
-        return self._rpc_base_url
-
-    @property
-    def client_data(self) -> FunctionContext:
-        """Get any additional client data provided within the context of the client."""
-        return self._client_data
-
-    @classmethod
-    def from_json(cls, json_string):
-        """Convert the value passed into a new instance of the class.
-
-        Parameters
-        ----------
-        json_string
-            Context passed a JSON serializable value to be converted into an
-            instance of the class
-
-        Returns
-        -------
-        DurableOrchestrationBindings
-            New instance of the durable orchestration binding class
-        """
-        json_dict = json.loads(json_string)
-        return cls(**json_dict)
+import json
+from typing import Dict, Optional
+
+from azure.durable_functions.models.FunctionContext import FunctionContext
+
+
+class DurableOrchestrationBindings:
+    """Binding information.
+
+    Provides information relevant to the creation and management of
+    durable functions.
+    """
+
+    # parameter names are as defined by JSON schema and do not conform to PEP8 naming conventions
+    def __init__(self, taskHubName: str, creationUrls: Dict[str, str],
+                 managementUrls: Dict[str, str], rpcBaseUrl: Optional[str] = None, **kwargs):
+        self._task_hub_name: str = taskHubName
+        self._creation_urls: Dict[str, str] = creationUrls
+        self._management_urls: Dict[str, str] = managementUrls
+        # TODO: we can remove the Optional once we drop support for 1.x,
+        # this is always provided in 2.x
+        self._rpc_base_url: Optional[str] = rpcBaseUrl
+        self._client_data = FunctionContext(**kwargs)
+
+    @property
+    def task_hub_name(self) -> str:
+        """Get the name of the container that is used for orchestrations."""
+        return self._task_hub_name
+
+    @property
+    def creation_urls(self) -> Dict[str, str]:
+        """Get the URLs that are used for creating new orchestrations."""
+        return self._creation_urls
+
+    @property
+    def management_urls(self) -> Dict[str, str]:
+        """Get the URLs that are used for managing orchestrations."""
+        return self._management_urls
+
+    @property
+    def rpc_base_url(self) -> Optional[str]:
+        """Get the base url communication between out of proc workers and the function host."""
+        return self._rpc_base_url
+
+    @property
+    def client_data(self) -> FunctionContext:
+        """Get any additional client data provided within the context of the client."""
+        return self._client_data
+
+    @classmethod
+    def from_json(cls, json_string):
+        """Convert the value passed into a new instance of the class.
+
+        Parameters
+        ----------
+        json_string
+            Context passed a JSON serializable value to be converted into an
+            instance of the class
+
+        Returns
+        -------
+        DurableOrchestrationBindings
+            New instance of the durable orchestration binding class
+        """
+        json_dict = json.loads(json_string)
+        return cls(**json_dict)