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

another_ayx_python_sdk/providers/amp_provider/repositories/output_record_packet_repository.py

@@ -0,0 +1,170 @@
+# 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.
+"""Class that saves/retrieves output record packets."""
+import logging
+from typing import Dict, List, TYPE_CHECKING
+
+from another_ayx_python_sdk.providers.amp_provider.builders import RecordPacketBuilder
+from another_ayx_python_sdk.providers.amp_provider.repositories.grpc_repository import (
+    GrpcRepository,
+)
+from another_ayx_python_sdk.providers.amp_provider.repositories.singleton import Singleton
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.outgoing_record_packet_push_pb2 import (
+    OutgoingRecordPacketPush,
+)
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.record_packet_pb2 import (
+    RecordPacket as ProtobufRecordPacket,
+)
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core.record_packet_base import RecordPacketBase
+
+logger = logging.getLogger(__name__)
+
+
+class OutputRecordPacketRepository(metaclass=Singleton):
+    """Repository that stores output record packets."""
+
+    _record_packet_builder = RecordPacketBuilder()
+
+    def __init__(self) -> None:
+        """Initialize the output record packet repository."""
+        self._record_packet_map: Dict[str, "RecordPacketBase"] = {}
+        self._record_packet_sequence: Dict[str, int] = {}
+        self._anchor_progress: Dict[str, float] = {}
+
+    def save_record_packet(
+        self, anchor_name: str, record_packet: "RecordPacketBase"
+    ) -> None:
+        """
+        Save a record packet.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the anchor that the record packet is associated with.
+        record_packet
+            The record packet to save to the repository.
+        """
+        logger.debug(
+            "Saving record packet for %s in OutputRecordPacketRepository", anchor_name
+        )
+        self._record_packet_map[anchor_name] = record_packet
+        logger.debug(
+            "Current OutputRecordPacketRepository State: %r", self._record_packet_map
+        )
+
+        try:
+            client = GrpcRepository().get_sdk_engine_client()
+        except ValueError:
+            pass
+        else:
+            logger.debug("Pushing output record packet for anchor %s", anchor_name)
+
+            for record_packet in self.get_grpc_record_packets(anchor_name):
+                client.PushOutgoingRecordPacket(
+                    OutgoingRecordPacketPush(
+                        anchor_name=anchor_name,
+                        record_packet=record_packet,
+                    )
+                )
+
+    def get_record_packet(self, anchor_name: str) -> "RecordPacketBase":
+        """
+        Get a record packet.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the output anchor that the record packet is associated with.
+
+        Returns
+        -------
+        RecordPacketBase
+            The record packet associated with the anchor name.
+        """
+        if anchor_name not in self._record_packet_map:
+            raise ValueError(f"Anchor {anchor_name} not found in repository.")
+
+        return self._record_packet_map[anchor_name]
+
+    def get_grpc_record_packets(self, anchor_name: str) -> List[ProtobufRecordPacket]:
+        """
+        Get a record packet in protobuf format.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the anchor to delete.
+
+        Returns
+        -------
+        List[ProtobufRecordPacket]
+            The list of protobuf record packets that are associated with the passed in anchor name.
+        """
+        record_packet = self.get_record_packet(anchor_name)
+
+        if anchor_name not in self._record_packet_sequence:
+            self._record_packet_sequence[anchor_name] = 0
+
+        pb_packets = self._record_packet_builder.to_protobuf(
+            record_packet,
+            self._record_packet_sequence[anchor_name],
+            self.get_anchor_progress(anchor_name),
+        )
+
+        self._record_packet_sequence[anchor_name] += len(pb_packets)
+        return pb_packets
+
+    def save_anchor_progress(self, anchor_name: str, progress: float) -> None:
+        """
+        Save the anchor progress.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the anchor to delete.
+        progress
+            The progress percentage of the anchor.
+        """
+        if not 0.0 <= progress <= 1.0:
+            raise ValueError("Progress must be between 0 and 1.")
+
+        self._anchor_progress[anchor_name] = progress
+
+    def get_anchor_progress(self, anchor_name: str) -> float:
+        """
+        Get the anchor progress.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the anchor to delete.
+
+        Returns
+        -------
+        progress
+            The progress percentage of the anchor.
+        """
+        return self._anchor_progress.get(anchor_name, 0.0)
+
+    def clear_repository(self) -> None:
+        """Delete all data in the repository."""
+        logger.debug("Clearing OutputRecordPacketRepository")
+        self._record_packet_map = {}
+        self._record_packet_sequence = {}
+        self._anchor_progress = {}
+        logger.debug(
+            "Current OutputRecordPacketRepository State: %r", self._record_packet_map
+        )

another_ayx_python_sdk/providers/amp_provider/repositories/plugin_class_repository.py

@@ -0,0 +1,55 @@
+# 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.
+"""Class that saves plugin class."""
+from typing import Optional, Type
+
+from another_ayx_python_sdk.core.plugin import Plugin
+from another_ayx_python_sdk.providers.amp_provider.repositories.singleton import Singleton
+
+
+class PluginClassRepository(metaclass=Singleton):
+    """Repository that stores plugin class."""
+
+    def __init__(self) -> None:
+        """Initialize the plugin class repository."""
+        self._plugin_class: Optional[Type[Plugin]] = None
+
+    def save_plugin_class(self, plugin_class: Type[Plugin]) -> None:
+        """
+        Save plugin class.
+
+        Parameters
+        ----------
+        plugin_class
+            The custom Plugin class that's being used.
+        """
+        self._plugin_class = plugin_class
+
+    def get_plugin_class(self) -> Type[Plugin]:
+        """
+        Get the plugin class.
+
+        Returns
+        -------
+        Type[Plugin]
+            The custom Plugin class that's being used.
+        """
+        if self._plugin_class is None:
+            raise ValueError("Plugin class hasn't been saved.")
+
+        return self._plugin_class
+
+    def clear_repository(self) -> None:
+        """Delete all data in the repository."""
+        self._plugin_class = None

another_ayx_python_sdk/providers/amp_provider/repositories/singleton.py

@@ -0,0 +1,32 @@
+# 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.
+"""Singleton metaclass."""
+
+
+class Singleton(type):
+    """Implements the Singleton Design Pattern using metaclasses.
+
+    References
+    ----------
+    [1] Mastering Python Design Patterns, Singleton.
+
+    """
+
+    _instances = {}  # type: ignore
+
+    def __call__(cls, *args, **kwargs):  # type: ignore
+        """Call."""
+        if cls not in cls._instances:
+            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
+        return cls._instances[cls]

another_ayx_python_sdk/providers/amp_provider/repositories/test_harness_state_repository.py

@@ -0,0 +1,172 @@
+# 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.
+"""Repository for the status of the handshake with the SDK engine server."""
+import logging
+from typing import Dict, Optional, TYPE_CHECKING, cast
+
+from another_ayx_python_sdk.providers.amp_provider import AMPRecordPacket
+from another_ayx_python_sdk.providers.amp_provider.builders import (
+    MetadataBuilder,
+    RecordPacketBuilder,
+)
+from another_ayx_python_sdk.providers.amp_provider.repositories.singleton import Singleton
+
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.providers.amp_provider.grpc_util import SocketAddress
+    from another_ayx_python_sdk.providers.amp_provider.resources.generated.record_packet_pb2 import (
+        RecordPacket as ProtobufRecordPacket,
+    )
+    from another_ayx_python_sdk.providers.amp_provider.resources.generated.metadata_pb2 import (
+        Metadata as ProtobufMetadata,
+    )
+    from another_ayx_python_sdk.core import Metadata as CoreMetadata  # noqa: F401
+
+logger = logging.getLogger(__name__)
+
+
+class TestHarnessStateRepository(metaclass=Singleton):
+    """
+    Class defines methods and properties to read/write/delete the handshake status.
+
+    NOTE: This class is only used by the test harness and shouldn't be used by the
+    SDK Tool Service.
+    """
+
+    __test__ = False  # Pytest tries to collect this by default, disable here to prevent warning
+
+    def __init__(self) -> None:
+        """Construct the repository."""
+        self._handshake_completed = False
+        self._sdk_tool_server_address: Optional["SocketAddress"] = None
+        self._metadata: Dict[str, "CoreMetadata"] = {}
+        self._record_packets: Dict[str, "AMPRecordPacket"] = {}
+
+    def save_handshake_completed_status(self, status: bool) -> None:
+        """
+        Save handshake completed status.
+
+        Parameters
+        ----------
+        status
+            Handshake completion status.
+        """
+        logger.debug(f"Handshake completed: {status}")
+        self._handshake_completed = status
+
+    def get_handshake_completed_status(self) -> bool:
+        """
+        Save AMP input anchor to repository.
+
+        Returns
+        -------
+        bool
+            True if handshake completed, False otherwise.
+        """
+        return self._handshake_completed
+
+    def save_sdk_tool_server_address(self, address: "SocketAddress") -> None:
+        """
+        Save the SDK Tool server address.
+
+        Parameters
+        ----------
+        address
+            The IP address and port that the server is listening on.
+        """
+        self._sdk_tool_server_address = address
+
+    def get_sdk_tool_server_address(self) -> "SocketAddress":
+        """
+        Get the SDK Tool server address.
+
+        Returns
+        -------
+        SocketAddress
+            The IP address and port that the server is listening on.
+        """
+        if self._sdk_tool_server_address is None:
+            raise ValueError("SDK Tool server address has not been saved.")
+
+        return self._sdk_tool_server_address
+
+    def save_metadata(self, anchor_name: str, metadata: "ProtobufMetadata") -> None:
+        """
+        Saves metadata of the data coming in.
+
+        Parameters
+        ----------
+        anchor_name
+            The anchor that the metadata is associated with.
+        metadata
+            The metadata of the data that will be going through this anchor.
+        """
+        core_metadata = MetadataBuilder().from_protobuf(metadata)
+        logger.debug(f"Saving metadata {core_metadata} to TestHarnessStateRepository")
+        self._metadata[anchor_name] = core_metadata
+
+    def get_metadata(self, anchor_name: str) -> "CoreMetadata":
+        """
+        Get metadata on the anchor.
+
+        Parameters
+        ----------
+        anchor_name
+            The anchor to get the metadata of.
+
+        Returns
+        -------
+        CoreMetadata
+            The metadata on the anchor that matches the passed in anchor name.
+        """
+        if anchor_name not in self._metadata:
+            raise ValueError(f"Anchor name '{anchor_name}' not found.")
+        return self._metadata[anchor_name]
+
+    def save_record_packet(
+        self, anchor_name: str, record_packet: "ProtobufRecordPacket"
+    ) -> None:
+        """
+        Save record packet to this repository.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the anchor that the record packet is associated with.
+        record_packet
+            The record packet to save to the repository.
+        """
+        core_record_packet, _, _ = RecordPacketBuilder().from_protobuf(
+            record_packet, self.get_metadata(anchor_name)
+        )
+        self._record_packets[anchor_name] = cast(AMPRecordPacket, core_record_packet)
+
+    def get_record_packet(self, anchor_name: str) -> "AMPRecordPacket":
+        """
+        Get record packet from repository.
+
+        Parameters
+        ----------
+        anchor_name
+            The name of the anchor that the record packet is associated with.
+
+        Returns
+        -------
+        record_packet
+            The record packet to save to the repository.
+        """
+        if anchor_name not in self._record_packets:
+            raise ValueError(f"Anchor name '{anchor_name}' not found")
+        logger.debug(f"Saving record packet for {anchor_name}")
+        return self._record_packets[anchor_name]

another_ayx_python_sdk/providers/amp_provider/repositories/tool_config_repository.py

@@ -0,0 +1,89 @@
+# 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.
+"""Class that saves tool configuration information."""
+import copy
+from typing import Any, Dict
+
+from another_ayx_python_sdk.providers.amp_provider.builders.tool_config_builder import (
+    ToolConfigBuilder,
+)
+from another_ayx_python_sdk.providers.amp_provider.repositories.grpc_repository import (
+    GrpcRepository,
+)
+from another_ayx_python_sdk.providers.amp_provider.repositories.singleton import Singleton
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.output_message_data_pb2 import (
+    OutputMessageData,
+    OutputMessageTypes,
+)
+
+
+class ToolConfigRepository(metaclass=Singleton):
+    """Repository that stores tool configuration information."""
+
+    _tool_config_builder = ToolConfigBuilder()
+
+    def __init__(self) -> None:
+        """Initialize the tool configuration repository."""
+        self._tool_config: Dict[str, Any] = {}
+
+    def save_tool_config(self, tool_config: Dict[str, Any]) -> None:
+        """
+        Save tool configuration dictionary.
+
+        Parameters
+        ----------
+        tool_config
+            Dictionary form of the Tool Config XML.
+        """
+        if tool_config != self._tool_config:
+            self._tool_config = tool_config
+
+            try:
+                client = GrpcRepository().get_sdk_engine_client()
+            except ValueError:
+                # Don't save if client isn't ready
+                pass
+            else:
+                client.OutputMessage(
+                    OutputMessageData(
+                        message_type=OutputMessageTypes.OMT_UpdateOutputConfigXml,
+                        message=self._tool_config_builder.to_xml(tool_config),
+                    )
+                )
+
+    def save_xml_tool_config(self, tool_config_xml: str) -> None:
+        """
+        Save the tool configuration xml as a dictionary.
+
+        Parameters
+        ----------
+        tool_config_xml
+            The Tool Config XML as a raw string.
+        """
+        self.save_tool_config(self._tool_config_builder.from_xml(tool_config_xml))
+
+    def get_tool_config(self) -> Dict[str, Any]:
+        """
+        Get the tool configuration.
+
+        Returns
+        -------
+        Dict[str, Any]
+            The Tool Config XML associated with the current plugin.
+        """
+        return copy.deepcopy(self._tool_config)
+
+    def clear_repository(self) -> None:
+        """Delete all data in the repository."""
+        self._tool_config = {}

another_ayx_python_sdk/providers/amp_provider/resources/__init__.py

@@ -0,0 +1,14 @@
+# 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.
+"""Resources to be consumed by the amp provider."""