another-ayx-python-sdk 2.4.2__py3-none-any.whl → 2.4.22__py3-none-any.whl

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/amp_environment_v2.py

@@ -0,0 +1,278 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Proxy Class for managing the SDK environment on Alteryx Multi-threaded Processing (AMP)."""
+import logging
+import os
+import sys
+import uuid
+from pathlib import Path
+from typing import Dict, Optional
+
+from another_ayx_python_sdk.core.doc_utilities import inherit_docs
+from another_ayx_python_sdk.core.environment_base import EnvironmentBase, Locale, UpdateMode
+from another_ayx_python_sdk.core.exceptions import WorkflowRuntimeError
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.plugin_initialization_data_pb2 import (
+    UpdateMode as Protobuf_UpdateMode,
+)
+
+import xmltodict
+
+logger = logging.getLogger()
+
+
+@inherit_docs
+class AMPEnvironmentV2(EnvironmentBase):
+    """Variables that describe the Designer environment when AMP is enabled."""
+
+    tool_config: Dict = {}
+
+    def __init__(self) -> None:
+        self._update_mode: Optional[UpdateMode] = None
+        self._update_only: Optional[bool] = None
+        self._proxy_configuration: Dict[str, str] = {}
+        self._workflow_id: str = ""
+        self._tool_id: int = 0
+        self.raw_constants: Dict[str, str] = {}
+
+    @property
+    def update_only(self) -> bool:  # noqa: D102
+        if self._update_only is None:
+            raise RuntimeError("Update Only has not been determined yet.")
+        return self._update_only
+
+    @property
+    def update_mode(self) -> "UpdateMode":  # noqa: D102
+        """
+        Get the type of tool update running.
+
+        Returns
+        -------
+        UpdateMode
+            Enum corresponding to the type of update mode designer is running in. (Quick, Full, No Update)
+        """
+        if self._update_mode is None:
+            raise RuntimeError("Update Mode has not been determined yet.")
+        return self._update_mode
+
+    @property
+    def designer_version(self) -> str:  # noqa: D102
+        """
+        Get the version of designer that is running the tool.
+
+        Returns
+        -------
+        str
+            A version in the format of 1.2.3.4
+        """
+        if self._designer_version is None:
+            raise RuntimeError(
+                "Environment repository has not received the 'designer_version' engine constant yet."
+            )
+        return self._designer_version
+
+    @property
+    def workflow_dir(self) -> "Path":  # noqa: D102
+        """
+        Get the directory where the workflow is running the tool.
+
+        Returns
+        -------
+        Path
+            The workflow directory as a Path object.
+        """
+        if self._workflow_dir is None:
+            raise RuntimeError(
+                "Environment repository has not received the 'worklfow_dir' engine constant yet."
+            )
+        return self._workflow_dir
+
+    @property
+    def workflow_id(self) -> str:  # noqa: D102
+        """
+        Get the WorkflowRunGuid for the currently-running workflow.
+
+        Returns
+        -------
+        str
+            The workflow id.
+        """
+        return self._workflow_id
+
+    @property
+    def alteryx_install_dir(self) -> "Path":  # noqa: D102
+        """
+        Get the directory where designer is stored.
+
+        Returns
+        -------
+        Path
+            The Alteryx install directory as a Path object.
+        """
+        if self._alteryx_install_dir is None:
+            raise RuntimeError(
+                "Environment repository has not received the 'alteryx_install_dir' engine constant yet."
+            )
+        return self._alteryx_install_dir
+
+    @property
+    def temp_dir(self) -> str:
+        """
+        Get the directory where designer-managed temp files are created.
+
+        Returns
+        -------
+        str
+            The path to the directory where temporary files are stored.
+        """
+        if self._temp_dir is None:
+            raise RuntimeError(
+                "Environment repository has not received the 'temp_dir' engine constant yet."
+            )
+        return self._temp_dir
+
+    @property
+    def alteryx_locale(self) -> "Locale":  # noqa: D102
+        """
+        Get the locale code from Alteryx user settings.
+
+        Returns
+        -------
+        Locale
+            The language / region that Alteryx is using to display messages.
+        """
+        # TODO
+        return "en"
+
+    @property
+    def tool_id(self) -> int:  # noqa: D102
+        """
+        Get the ID of the tool.
+
+        Returns
+        -------
+        int
+            Tool's ID (specified by developer).
+        """
+        return self._tool_id
+
+    @property
+    def proxy_configuration(self) -> dict:  # noqa: D102
+        return self._proxy_configuration
+
+    def get_proxy_configuration(self) -> dict:  # noqa: D102
+        return self._proxy_configuration
+
+    def save_engine_constants(self, constants: Dict[str, str]) -> None:
+        """
+        Save engine constants to repo.
+
+        Parameters
+        ----------
+        constants
+            The dictionary of engine constants received through gRPC
+        """
+        try:
+            self._designer_version = constants["Engine.Version"]
+            self._alteryx_install_dir = Path(constants["AlteryxExecutable"])
+            self._workflow_dir = Path(constants["Engine.WorkflowDirectory"])
+            self._temp_dir = constants["Engine.TempFilePath"]
+            self._tool_id = int(constants.get("ToolId", 0))
+            self._workflow_id = constants.get("WorkflowRunGuid", "")
+            self.raw_constants = constants
+        except KeyError:
+            raise WorkflowRuntimeError(
+                "One or more Engine Constants missing from dictionary."
+            )
+        # The proxy config keys are not always present, so technically an optional kwarg here.
+        self._proxy_configuration = {}
+        if constants.get("ProxyConfiguration"):
+            for key_val_pair in constants["ProxyConfiguration"].split("\n"):
+                keyval = key_val_pair.split("=", 1)
+                # might have a blank or unset key
+                if len(keyval) > 1:
+                    self._proxy_configuration[keyval[0]] = keyval[1]
+
+    def save_update_mode(self, update_mode: int) -> None:
+        """
+        Save the passed in update mode.
+
+        Parameters
+        ----------
+        update_mode
+            An int that corresponds to the protobuf enumeration for the update mode that designer is running in.
+        """
+        if update_mode == Protobuf_UpdateMode.UM_Run:
+            self._update_mode = UpdateMode.NO_UPDATE_MODE
+            self._update_only = False
+        if update_mode == Protobuf_UpdateMode.UM_Full:
+            self._update_mode = UpdateMode.FULL
+            self._update_only = True
+        if update_mode == Protobuf_UpdateMode.UM_Quick:
+            self._update_mode = UpdateMode.QUICK
+            self._update_only = True
+
+    def set_tool_config(self, config_xml_str: str) -> None:
+        """Parse an xml string to dict form and set the config."""
+        self.tool_config = dict(
+            xmltodict.parse(config_xml_str, strip_whitespace=False)["Configuration"]
+            or {}
+        )
+
+    def parse_settings_key_value(
+        self, settings_str: str, line_delimiter: str = "\n", key_delimiter: str = "="
+    ) -> dict:  # noqa: D102
+        return super().parse_settings_key_value(
+            settings_str, line_delimiter=line_delimiter, key_delimiter=key_delimiter
+        )
+
+    def get_settings_conf(self, *args: list) -> dict:  # noqa: D102
+        return super().get_settings_conf(*args)
+
+    def update_tool_config(self, new_config: dict) -> None:  # noqa: D102
+        self.tool_config = new_config
+
+    def create_temp_file(self, extension: str = "tmp") -> "Path":  # noqa: D102
+        """
+        Create a temporary file managed by Designer.
+
+        Parameters
+        ----------
+        extension
+            The file extension of the temp file.
+
+        Returns
+        -------
+        Path
+            The path to where the temp file is.
+        """
+        temp_file_name = f"temp-file-{str(uuid.uuid4())}.{str(extension)}"
+        temp_file_path = Path(self.temp_dir) / (temp_file_name)
+        try:
+            temp_file_path.touch()
+        except FileNotFoundError:
+            # path does not exist
+            logger.error("Engine.TempFilePath (%s) does not exist", self.temp_dir)
+        except IOError:
+            # path exists but no write permissions
+            logger.error("No write permissions for directory %s", self.temp_dir)
+        return Path(temp_file_path)
+
+    def get_log_directory(self) -> "Path":
+        """Return the root log directory for the current platform."""
+        log_directory = (
+            Path(os.environ["localappdata"]) / "Alteryx"
+            if sys.platform == "win32"
+            else Path("/var/log")
+        )
+        return log_directory

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/amp_input_anchor.py

@@ -0,0 +1,73 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""AMP Provider: Plugin Input Anchor class definition."""
+from typing import List, Optional, TYPE_CHECKING
+
+from another_ayx_python_sdk.core.doc_utilities import inherit_docs
+from another_ayx_python_sdk.core.input_anchor_base import InputAnchorBase
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core.input_connection_base import (  # noqa: F401
+        InputConnectionBase,
+    )  # noqa: F401
+
+
+@inherit_docs
+class AMPInputAnchor(InputAnchorBase):
+    """Manage the tool's input anchor in AMP Provider."""
+
+    def __init__(
+        self,
+        name: str,
+        allow_multiple: bool = False,
+        optional: bool = False,
+        connections: Optional[
+            List["InputConnectionBase"]
+        ] = None,  # TODO: implement some kind of anchor_proxy for this like e1
+    ) -> None:
+        """
+        Instantiate an AMP Provider input anchor.
+
+        Parameters
+        ----------
+        name
+            The name of the input anchor.
+        allow_multiple
+            Indicates whether the anchor can have multiple input connections associated with it.
+        optional
+            Indicates whether the anchor is optional.
+        connections
+            The list of input connections associated with the anchor.
+        """
+        self.__name = name
+        self.__allow_multiple = allow_multiple
+        self.__optional = optional
+        self.__connections: List["InputConnectionBase"] = connections or []
+        # TODO: figure out how to deal with REQUIRES_SEQUENCE and REQUEST_SEQUENCE being passed from protobuf object
+
+    @property
+    def name(self) -> str:  # noqa: D102
+        return self.__name
+
+    @property
+    def allow_multiple(self) -> bool:  # noqa: D102
+        return self.__allow_multiple
+
+    @property
+    def optional(self) -> bool:  # noqa: D102
+        return self.__optional
+
+    @property
+    def connections(self) -> List["InputConnectionBase"]:  # noqa: D102
+        return self.__connections

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/amp_input_connection.py

@@ -0,0 +1,132 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""AMP Provider: Plugin Input Connection class definition."""
+import logging
+from typing import Optional, TYPE_CHECKING
+
+from another_ayx_python_sdk.core.doc_utilities import inherit_docs
+from another_ayx_python_sdk.core.input_connection_base import InputConnectionBase
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core import Metadata  # noqa: F401
+    from another_ayx_python_sdk.core.input_connection_base import InputConnectionStatus
+    from another_ayx_python_sdk.core.record_packet_base import RecordPacketBase
+    from another_ayx_python_sdk.providers.amp_provider import AMPInputAnchor
+
+
+logger = logging.getLogger(__name__)
+
+
+@inherit_docs
+class AMPInputConnection(InputConnectionBase):
+    """Manage input connections in AMP Provider."""
+
+    def __init__(
+        self, name: str, metadata: "Metadata", anchor: "AMPInputAnchor"
+    ) -> None:
+        """
+        Instantiate an AMP Provider input connection.
+
+        Parameters
+        ----------
+        name
+            Name of the input connection.
+        metadata
+            Metadata for the input connection.
+        anchor
+            Input anchor associated with the connection.
+        """
+        self.__name = name
+        self.__metadata = metadata  # TODO: Get metadata from repository
+        self.__anchor = anchor
+        self.progress = 0.0
+
+    @property
+    def name(self) -> str:  # noqa: D102
+        return self.__name
+
+    @property
+    def metadata(self) -> Optional["Metadata"]:  # noqa: D102
+        return self.__metadata
+
+    @property
+    def anchor(self) -> "AMPInputAnchor":  # noqa: D102
+        return self.__anchor
+
+    def read(self) -> "RecordPacketBase":  # noqa: D102
+        if self.metadata is None:
+            raise RuntimeError("Input connection has not been opened yet.")
+        logger.debug(
+            "Reading record packet from input connection %s on input anchor %s",
+            self.name,
+            self.anchor.name,
+        )
+        from another_ayx_python_sdk.providers.amp_provider.repositories.input_record_packet_repository import (
+            EmptyRecordPacketRepositoryException,
+            InputRecordPacketRepository,
+        )
+
+        try:
+            packet = InputRecordPacketRepository().peek_record_packet(
+                self.anchor.name, self.name
+            )
+        except EmptyRecordPacketRepositoryException:
+            raise RuntimeError("All record packets have been read from this connection")
+        return packet
+
+    def _get_max_packet_size(self) -> Optional[int]:
+        from another_ayx_python_sdk.providers.amp_provider.repositories import (
+            InputConnectionRepository,
+        )
+
+        try:
+            return InputConnectionRepository().get_connection_packet_size(
+                self.anchor.name, self.name
+            )
+        except ValueError:
+            return None
+
+    def _set_max_packet_size(self, value: Optional[int]) -> None:
+        if value and value <= 0:
+            raise ValueError(
+                "max_packet_size must be None or an integer greater than 0."
+            )
+
+        from another_ayx_python_sdk.providers.amp_provider.repositories import (
+            InputConnectionRepository,
+        )
+
+        InputConnectionRepository().save_connection_packet_size(
+            self.anchor.name, self.name, value
+        )
+
+    @property
+    def progress(self) -> float:  # noqa: D102
+        return self.__progress
+
+    @progress.setter
+    def progress(self, value: float) -> None:  # noqa: D102
+        if value < 0:
+            raise ValueError("Progress percentage must be greater than 0.")
+        self.__progress = value
+
+    @property
+    def status(self) -> "InputConnectionStatus":  # noqa: D102
+        from another_ayx_python_sdk.providers.amp_provider.repositories import (
+            InputConnectionRepository,
+        )
+
+        return InputConnectionRepository().get_connection_status(
+            self.anchor.name, self.name
+        )

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/amp_io.py

@@ -0,0 +1,64 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""AMP Provider: Proxy class for SDK IO (input/output)."""
+from pathlib import Path
+from typing import Any
+
+from another_ayx_python_sdk.core import IoBase
+from another_ayx_python_sdk.core.doc_utilities import inherit_docs
+from another_ayx_python_sdk.providers.amp_provider.repositories import IORepository
+
+import deprecation
+
+
+@inherit_docs
+class AMPIO(IoBase):
+    """Class that wraps all IO with Designer."""
+
+    def error(self, error_msg: str) -> None:  # noqa: D102
+        IORepository().save_error(error_msg)
+
+    def warn(self, warn_msg: str) -> None:  # noqa: D102
+        IORepository().save_warn(warn_msg)
+
+    def info(self, info_msg: str) -> None:  # noqa: D102
+        IORepository().save_info(info_msg)
+
+    def translate_msg(self, msg: str, *args: Any) -> str:  # noqa: D102
+        return IORepository().get_translate_msg(msg, *args)
+
+    def update_progress(self, percent: float) -> None:  # noqa: D102
+        IORepository().update_progress(percent)
+
+    def create_temp_file(
+        self, extension: str = "tmp", options: int = 0
+    ) -> "Path":  # noqa: D102
+        """
+        Create a temporary file managed by Designer.
+
+        .. deprecated:: AMP
+            `options` is not used in AMP because there is no longer a
+            differentiation between temporary persistent and temporary non-persitent
+            files.
+
+        """
+        return IORepository().get_temp_file(extension)
+
+    @deprecation.deprecated(
+        deprecated_in="1.0.3",
+        removed_in="2.0.0",
+        details="Use functions of provider's dcm property instead",
+    )  # type: ignore
+    def decrypt_password(self, password: str) -> str:  # noqa: D102
+        return IORepository().decrypt_password(password)