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/resources/generated/sdk_tool_service_v2_pb2_grpc.py

@@ -0,0 +1,99 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from . import sdk_tool_service_v2_pb2 as sdk__tool__service__v2__pb2
+
+
+class SdkToolV2Stub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Control = channel.stream_stream(
+                '/sdk.SdkToolV2/Control',
+                request_serializer=sdk__tool__service__v2__pb2.ControlIn.SerializeToString,
+                response_deserializer=sdk__tool__service__v2__pb2.ControlOut.FromString,
+                )
+        self.RecordTransfer = channel.stream_stream(
+                '/sdk.SdkToolV2/RecordTransfer',
+                request_serializer=sdk__tool__service__v2__pb2.RecordTransferIn.SerializeToString,
+                response_deserializer=sdk__tool__service__v2__pb2.RecordTransferOut.FromString,
+                )
+
+
+class SdkToolV2Servicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def Control(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def RecordTransfer(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_SdkToolV2Servicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Control': grpc.stream_stream_rpc_method_handler(
+                    servicer.Control,
+                    request_deserializer=sdk__tool__service__v2__pb2.ControlIn.FromString,
+                    response_serializer=sdk__tool__service__v2__pb2.ControlOut.SerializeToString,
+            ),
+            'RecordTransfer': grpc.stream_stream_rpc_method_handler(
+                    servicer.RecordTransfer,
+                    request_deserializer=sdk__tool__service__v2__pb2.RecordTransferIn.FromString,
+                    response_serializer=sdk__tool__service__v2__pb2.RecordTransferOut.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'sdk.SdkToolV2', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+class SdkToolV2(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Control(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(request_iterator, target, '/sdk.SdkToolV2/Control',
+            sdk__tool__service__v2__pb2.ControlIn.SerializeToString,
+            sdk__tool__service__v2__pb2.ControlOut.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def RecordTransfer(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(request_iterator, target, '/sdk.SdkToolV2/RecordTransfer',
+            sdk__tool__service__v2__pb2.RecordTransferIn.SerializeToString,
+            sdk__tool__service__v2__pb2.RecordTransferOut.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/resources/generated/translate_message_data_pb2.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: translate_message_data.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ctranslate_message_data.proto\x12\x03sdk\"N\n\x14TranslateMessageData\x12\x1a\n\x12unlocalized_string\x18\x01 \x01(\t\x12\x1a\n\x12interpolation_data\x18\x02 \x03(\t\"/\n\x11TranslatedMessage\x12\x1a\n\x12translated_message\x18\x01 \x01(\tb\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'translate_message_data_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _TRANSLATEMESSAGEDATA._serialized_start=37
+  _TRANSLATEMESSAGEDATA._serialized_end=115
+  _TRANSLATEDMESSAGE._serialized_start=117
+  _TRANSLATEDMESSAGE._serialized_end=164
+# @@protoc_insertion_point(module_scope)

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/resources/generated/translate_message_data_pb2_grpc.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/resources/generated/transport_pb2.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: transport.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0ftransport.proto\x12\x03sdk\"0\n\x0cReturnStatus\x12\x0f\n\x07success\x18\x01 \x01(\x08\x12\x0f\n\x07message\x18\x02 \x01(\t\"\xfe\x03\n\rPluginMessage\x12\x0f\n\x07message\x18\x01 \x01(\t\x12,\n\x04type\x18\x02 \x01(\x0e\x32\x1e.sdk.PluginMessage.MessageType\"\xad\x03\n\x0bMessageType\x12\x0b\n\x07INVALID\x10\x00\x12\x08\n\x04INFO\x10\x01\x12\x0b\n\x07WARNING\x10\x02\x12\x0f\n\x0bPLUGINERROR\x10\x03\x12\x0c\n\x08\x43OMPLETE\x10\x04\x12\x14\n\x10\x46IELD_CONV_ERROR\x10\x05\x12\x0c\n\x08\x44ISABLED\x10\x07\x12\x0e\n\nFILE_INPUT\x10\x08\x12\x0f\n\x0b\x46ILE_OUTPUT\x10\t\x12\x1f\n\x1bUPDATE_OUTPUT_META_INFO_XML\x10\n\x12\x1c\n\x18UPDATE_OUTPUT_CONFIG_XML\x10\x0b\x12\x11\n\rDOC_TEMP_FILE\x10\r\x12\x13\n\x0f\x43\x41\x43HE_TEMP_FILE\x10\x10\x12\x11\n\rLOW_DISK_WARN\x10\x14\x12\x13\n\x0fSAFE_MODE_ERROR\x10\x15\x12\x16\n\x12OUTPUT_FIELD_NAMES\x10(\x12\x11\n\rOUTPUT_RECORD\x10)\x12\x17\n\x13RECORD_COUNT_STRING\x10\x32\x12\x1f\n\x1b\x42ROWSE_EVERYWHERE_FILE_NAME\x10\x46\x12\"\n\x1e\x42ROWSE_EVERYWHERE_FILE_NAME_EX\x10G\"\x07\n\x05\x45mptyb\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'transport_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _RETURNSTATUS._serialized_start=24
+  _RETURNSTATUS._serialized_end=72
+  _PLUGINMESSAGE._serialized_start=75
+  _PLUGINMESSAGE._serialized_end=585
+  _PLUGINMESSAGE_MESSAGETYPE._serialized_start=156
+  _PLUGINMESSAGE_MESSAGETYPE._serialized_end=585
+  _EMPTY._serialized_start=587
+  _EMPTY._serialized_end=594
+# @@protoc_insertion_point(module_scope)

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/resources/generated/transport_pb2_grpc.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/resources/generated/update_progress_pb2.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: update_progress.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15update_progress.proto\x12\x03sdk\"\x1f\n\x0eUpdateProgress\x12\r\n\x05value\x18\x01 \x01(\x02\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'update_progress_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _UPDATEPROGRESS._serialized_start=30
+  _UPDATEPROGRESS._serialized_end=61
+# @@protoc_insertion_point(module_scope)

build/lib/build/lib/another_ayx_python_sdk/providers/amp_provider/resources/generated/update_progress_pb2_grpc.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

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

@@ -0,0 +1,115 @@
+# 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.
+"""Runner for the SDK gRPC lifecycle."""
+import os
+from typing import TYPE_CHECKING
+
+from another_ayx_python_sdk.providers.amp_provider.grpc_util import build_sdk_tool_server
+from another_ayx_python_sdk.providers.amp_provider.repositories.grpc_repository import (
+    GrpcRepository,
+)
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.sdk_tool_service_startup_info_pb2 import (
+    SdkToolServiceStartupInfo,
+)
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.transport_pb2 import (
+    ReturnStatus,
+)
+from another_ayx_python_sdk.providers.amp_provider.utilities.constants import ToolEnvType
+from another_ayx_python_sdk.providers.amp_provider.utilities.utilities import tool_type
+
+if TYPE_CHECKING:
+    from grpc.aio import Server
+
+
+class HandshakeFailedException(RuntimeError):
+    """Exception for when the handshake fails."""
+
+    pass
+
+
+# A well known token used to communicate the LISTENing port back
+# to the owner process (OOP) on Desktop/Designer builds
+# DO NOT CHANGE THIS STRING
+# See also ToolProcess.cpp
+LISTEN_PORT_TOKEN = "ListenPort: "
+
+
+class SdkToolRunner:
+    """Manage gRPC lifecycle for the SDK Plugin."""
+
+    def __init__(self, sdk_engine_address: str):
+        """Construct an SDK Tool Runner."""
+        self._sdk_engine_address = sdk_engine_address
+        self.sdk_tool_server: "Server" = None
+        self.sdk_tool_server_address = sdk_engine_address
+
+    async def start_service(self) -> None:
+        """Start the SDK Tool Service."""
+        socket_address = (
+            os.getenv("TOOL_SERVICE_ADDRESS")
+            if tool_type() == ToolEnvType.Service
+            else "localhost:0"
+        )
+
+        [self.sdk_tool_server, port] = build_sdk_tool_server(socket_address)
+
+        # See notes around LISTEN_PORT_TOKEN above. Explicit flush
+        # ensures we do not buffer, but instead write directly to stdout.
+        print(f"{LISTEN_PORT_TOKEN}{port}", flush=True)
+
+        await self.sdk_tool_server.start()
+        await self.sdk_tool_server.wait_for_termination()
+
+    @staticmethod
+    def handshake_with_sdk_engine_service() -> "ReturnStatus":
+        """
+        Run the handshake with the SDK Engine Server.
+
+        Returns
+        -------
+        return_status: ReturnStatus
+            Whether or not the handshake is successful
+
+        Raises
+        ------
+        HandshakeFailedException
+            If method cannot connect to the engine service
+        """
+        return_status = None
+        if tool_type() == ToolEnvType.Desktop:
+            try:
+                return_status = (
+                    GrpcRepository()
+                    .get_sdk_engine_client()
+                    .ConfirmSdkEngineServiceConnection(
+                        SdkToolServiceStartupInfo(
+                            success=True,
+                            message=f"Startup of plugin successful!",
+                            sdk_tool_server_address=GrpcRepository()
+                            .get_sdk_tool_server_address()
+                            .address,
+                        ),
+                    )
+                )
+            except Exception:
+                raise HandshakeFailedException("Couldn't connect to server.")
+        else:
+            return_status = ReturnStatus(
+                message=f"Connection successful!", success=True
+            )
+        return return_status
+
+    async def wait_for_termination(self) -> None:
+        """Block and wait for the process to terminate."""
+        await self.sdk_tool_server.wait_for_termination()

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

@@ -0,0 +1,207 @@
+# 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.
+"""SDK Engine Service grpc class."""
+import logging
+import traceback
+from typing import Any, Callable
+
+from another_ayx_python_sdk.providers.amp_provider import AMPDriver, AMPProvider
+from another_ayx_python_sdk.providers.amp_provider.repositories import (
+    EnvironmentRepository,
+    GrpcRepository,
+    InputAnchorRepository,
+    InputMetadataRepository,
+    InputRecordPacketRepository,
+    OutputAnchorRepository,
+    PluginClassRepository,
+    ToolConfigRepository,
+    clear_repositories,
+)
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.sdk_tool_service_pb2_grpc import (
+    SdkToolServicer,
+)
+from another_ayx_python_sdk.providers.amp_provider.resources.generated.transport_pb2 import (
+    ReturnStatus,
+)
+
+import grpc
+
+
+logger = logging.getLogger()
+
+
+def _handle_service_exception(method: Callable) -> Callable:
+    def _handle_exception(obj, request, context) -> Any:  # type: ignore
+        try:
+            return method(obj, request, context)
+        except Exception:
+            traceback_str = traceback.format_exc()
+            logger.exception(traceback_str)
+            context.set_details(traceback_str)
+            context.set_code(grpc.StatusCode.INTERNAL)
+            context.abort(code=grpc.StatusCode.INTERNAL, details=traceback_str)
+
+    return _handle_exception
+
+
+class SdkToolService(SdkToolServicer):
+    """SDK Tool Service GRPC overrides."""
+
+    @_handle_service_exception
+    def ConfirmSdkToolServiceConnection(self, request, context):  # type: ignore # noqa: N802
+        """Confirm healthy connection.
+
+        Parameters
+        ----------
+        request: Empty
+            The incoming gRPC request - should be empty for this method
+
+        context: grpc.ServicerContext
+            Service-level context for this gRPC service
+        """
+        logger.debug("ConfirmSdkToolServiceConnection called.")
+        status = ReturnStatus(message=f"Connection successful!", success=True)
+        return status
+
+    @_handle_service_exception
+    def InitializeSdkPlugin(self, request, context):  # type: ignore # noqa: N802
+        """
+        Initialize SDK Plugin with config, anchors, and connections.
+
+        Parameters
+        ----------
+        request: PluginInitializationData
+            The incoming gRPC request - should contain tool config, engine constants, list of incoming and outgoing anchors, and a boolean updataMode.
+
+        context: grpc.ServicerContext
+            Service-level context for this gRPC service
+
+        """
+        logger.debug("InitializeSdkPlugin called.")
+        AMPDriver().clear_state()
+        clear_repositories(exclude={GrpcRepository(), PluginClassRepository()})
+
+        ToolConfigRepository().save_xml_tool_config(request.configXml)
+        EnvironmentRepository().save_engine_constants(dict(request.engineConstants))
+        EnvironmentRepository().save_update_mode(request.updateMode)
+
+        for input_anchor in request.incomingAnchors:
+            logger.debug("Saving input anchor: \n%s\n", input_anchor)
+            InputAnchorRepository().save_grpc_anchor(input_anchor)
+
+        for output_anchor in request.outgoingAnchors:
+            logger.debug("Saving output anchor: \n%s\n", output_anchor)
+            OutputAnchorRepository().save_grpc_anchor(output_anchor)
+
+        amp_provider = AMPProvider()
+        sdk_plugin = PluginClassRepository().get_plugin_class()(amp_provider)
+        AMPDriver().plugin = sdk_plugin
+
+        for anchor in request.incomingAnchors:
+            for connection in anchor.connections:
+                logger.debug(
+                    "Driving metadata for input anchor %s and connection %s.",
+                    anchor.name,
+                    connection.name,
+                )
+                AMPDriver().metadata_received(anchor.name, connection.name)
+
+        status = ReturnStatus(message=f"Initialization successful!", success=True)
+        return status
+
+    @_handle_service_exception
+    def PushIncomingRecordPacket(self, request, context):  # type: ignore # noqa: N802
+        """
+        Push a record packet to the plugin.
+
+        Parameters
+        ----------
+        request: IncomingRecordPacketPush
+            The incoming gRPC request - should contain an anchor name, connection name, and the record packet to send.
+
+        context: grpc.ServicerContext
+            Service-level context for this gRPC service.
+        """
+        logger.debug("PushIncomingRecordPacket called.")
+        logger.debug(
+            "Packet received on anchor %s and connection %s.",
+            request.anchor_name,
+            request.connection_name,
+        )
+        record_packet_metadata = InputMetadataRepository().get_metadata(
+            request.anchor_name, request.connection_name
+        )
+        InputRecordPacketRepository().save_grpc_record_packet(
+            anchor_name=request.anchor_name,
+            connection_name=request.connection_name,
+            grpc_record_packet=request.record_packet,
+            metadata=record_packet_metadata,
+        )
+        logger.debug(
+            "Driving record packet to plugin on anchor %s and connection %s.",
+            request.anchor_name,
+            request.connection_name,
+        )
+        AMPDriver().record_packet_received(
+            anchor_name=request.anchor_name,
+            connection_name=request.connection_name,
+        )
+        status = ReturnStatus(message="Record packet recieved!", success=True)
+        return status
+
+    @_handle_service_exception
+    def NotifyIncomingConnectionComplete(self, request, context):  # type: ignore # noqa: N802
+        """
+        Notify the plugin that a connection has closed.
+
+        Parameters
+        ----------
+        request: IncomingConnectionComplete
+            The incoming gRPC request - should contain an anchor name and connection name.
+
+        context: grpc.ServicerContext
+            Service-level context for this gRPC service
+        """
+        logger.debug("NotifyIncomingConnectionComplete called.")
+
+        AMPDriver().connection_closed_callback(
+            request.anchor_name, request.connection_name
+        )
+        logger.debug(
+            "Connection closed for anchor %s, connection %s",
+            request.anchor_name,
+            request.connection_name,
+        )
+        status = ReturnStatus(
+            message=f"Connection {request.connection_name} closed!", success=True
+        )
+        return status
+
+    @_handle_service_exception
+    def NotifyPluginComplete(self, request, context):  # type: ignore # noqa: N802
+        """
+        Notify the plugin that the on_complete method should be called.
+
+        Parameters
+        ----------
+        request: Empty
+            The incoming gRPC request - should be empty for this method
+
+        context: grpc.ServicerContext
+            Service-level context for this gRPC service
+        """
+        logger.debug("NotifyPluginComplete Called")
+        AMPDriver().complete_callback()
+        status = ReturnStatus(message=f"Plugin process complete!", success=True)
+        return status