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

another_ayx_python_sdk/core/output_anchor_base.py

@@ -0,0 +1,151 @@
+# 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.
+"""Output Anchor Description implementation."""
+from abc import ABC, abstractmethod
+from typing import Any, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core.metadata import Metadata
+    from another_ayx_python_sdk.core.record_packet_base import RecordPacketBase
+
+
+class OutputAnchorBase(ABC):
+    """Output Anchor Base class definition."""
+
+    @property
+    @abstractmethod
+    def name(self) -> str:
+        """
+        Get the name of the output anchor.
+
+        Returns
+        -------
+        str
+            The name of the output anchor.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def allow_multiple(self) -> bool:
+        """
+        Get the status that indicates if multiple connections are allowed.
+
+        Returns
+        -------
+        bool
+            Boolean value that indicates if multiple connections are allowed.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def optional(self) -> bool:
+        """
+        Get the status that indicates if the output anchor is optional.
+
+        Returns
+        -------
+        bool
+            Boolean value that indicates if output anchor is optional.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def num_connections(self) -> int:
+        """
+        Get the number of connections attached to the anchor.
+
+        Returns
+        -------
+        int
+            The number of downstream connections on this anchor.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def is_open(self) -> bool:
+        """Get the status that indicates if the anchor is open."""
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def metadata(self) -> Optional["Metadata"]:
+        """Get the metadata for the anchor."""
+        raise NotImplementedError()
+
+    @abstractmethod
+    def open(self, metadata: "Metadata") -> None:
+        """
+        Open the output anchor.
+
+        Write the outgoing record metadata and open this connection for
+        outgoing packets.
+
+        Parameters
+        ----------
+        metadata
+            The metadata to set for this anchor.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def write(self, record_packet: "RecordPacketBase") -> None:
+        """
+        Write a RecordPacket to the outgoing connection.
+
+        Parameters
+        ----------
+        record_packet
+            The record packet to write to the output anchor.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def flush(self) -> None:
+        """Flush the written records for this output connection."""
+        raise NotImplementedError()
+
+    @abstractmethod
+    def close(self) -> None:
+        """Close the outgoing connection."""
+        raise NotImplementedError()
+
+    @abstractmethod
+    def update_progress(self, percentage: float) -> None:
+        """
+        Update the progress on downstream connections.
+
+        Parameters
+        ----------
+        percentage
+            The percentage to write to Designer, that indicates the progress of
+            output on this anchor.
+        """
+        raise NotImplementedError()
+
+    def __eq__(self, other: Any) -> bool:
+        """Compare 2 output anchor instances by value."""
+        if not isinstance(other, self.__class__):
+            return NotImplemented
+        return (
+            self.name == other.name
+            and self.allow_multiple == other.allow_multiple
+            and self.is_open == other.is_open
+            and self.optional == other.optional
+            and self.metadata == other.metadata
+            and self.num_connections == other.num_connections
+        )

another_ayx_python_sdk/core/plugin.py

@@ -0,0 +1,108 @@
+# 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.
+"""
+The Abstract Base class definition for plugins.
+
+For a custom plugin, a user will inherit from Plugin and implement
+all of the abstract methods.
+"""
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core.input_connection_base import InputConnectionBase
+    from another_ayx_python_sdk.core.provider_base import ProviderBase
+
+
+class Plugin(ABC):
+    """The Abstract Base class for Plugin."""
+
+    @abstractmethod
+    def __init__(self, provider: "ProviderBase"):
+        """
+        Initialize the plugin from the provider.
+
+        This method IS called during update-only mode.
+
+        Parameters
+        ----------
+        provider
+            The provider object that provides resources for reading and writing data.
+
+        config
+            A dictionary that contains the tool configuration.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def on_input_connection_opened(
+        self, input_connection: "InputConnectionBase"
+    ) -> None:
+        """
+        Process an opened input connection.
+
+        The method that gets called whenever an input connection is opened.
+
+        When an input connection is opened, it receives metadata. Prior to being
+        opened, its metadata is None.
+
+        This method IS called during update-only mode.
+
+        In this method, a Plugin designer should make sure to open any output anchors
+        during update-only mode in order to ensure that metadata is properly propagated
+        in Designer.
+
+        Parameters
+        ----------
+        input_connection
+            The input connection that was opened.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def on_record_packet(self, input_connection: "InputConnectionBase") -> None:
+        """
+        Process any incoming records.
+
+        The method that gets called whenever an input connection receives records.
+
+        This method IS NOT called during update-only mode.
+
+        In this method, a Plugin designer should read from the input connection
+        and process the record packet that it produces.
+
+        Parameters
+        ----------
+        input_connection
+            The input connection that received a record.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        This method IS NOT called during update-only mode.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        raise NotImplementedError()

another_ayx_python_sdk/core/plugin_v2.py

@@ -0,0 +1,97 @@
+# 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.
+"""
+The Abstract Base class definition for plugins.
+
+For a custom plugin, a user will inherit from Plugin and implement
+all of the abstract methods.
+"""
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+from another_ayx_python_sdk.core import Anchor
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+
+    from pyarrow import Table
+
+
+class PluginV2(ABC):
+    """The Abstract Base class for Plugin."""
+
+    @abstractmethod
+    def __init__(self, provider: "AMPProviderV2"):
+        """
+        Initialize the plugin from the provider.
+
+        This method IS called during update-only mode.
+
+        Parameters
+        ----------
+        provider
+            The provider object that provides resources for reading and writing data.
+
+        config
+            A dictionary that contains the tool configuration.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def on_incoming_connection_complete(self, anchor: Anchor) -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection_name.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def on_record_batch(self, batch: "Table", anchor: Anchor) -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batches
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection_name']) containing input connection identifiers.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        raise NotImplementedError()

another_ayx_python_sdk/core/provider_base.py

@@ -0,0 +1,125 @@
+# 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.
+"""
+Record Provider implementation.
+
+Record providers instantiate input and output connections for the tool and pass
+information along to the record processor.
+"""
+from abc import ABC, abstractmethod
+from typing import Dict, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from logging import Logger
+    from another_ayx_python_sdk.core.environment_base import EnvironmentBase
+    from another_ayx_python_sdk.core.io_base import IoBase
+    from another_ayx_python_sdk.core.input_anchor_base import InputAnchorBase
+    # from another_ayx_python_sdk.core.dcm import Dcm
+    from another_ayx_python_sdk.core import OutputAnchorBase
+
+
+class ProviderBase(ABC):
+    """Record Provider for the tool."""
+
+    @property
+    @abstractmethod
+    def tool_config(self) -> Dict:
+        """Get Config XML from this provider."""
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def logger(self) -> "Logger":
+        """
+        Get the Logger for the provider.
+
+        Returns
+        -------
+        Logger
+            Python logging object.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def io(self) -> "IoBase":
+        """
+        Get the IO (input/output) object from this provider.
+
+        Returns
+        -------
+        IoBase
+            An instance of a concrete IO object.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def environment(self) -> "EnvironmentBase":
+        """
+        Get the Environment object from this provider.
+
+        Returns
+        -------
+        EnvironmentBase
+            An instance of a concrete Environment object.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def get_input_anchor(self, name: str) -> "InputAnchorBase":
+        """
+        Get an input anchor by name.
+
+        Parameters
+        ----------
+        name
+            The name of the anchor to get.
+
+        Returns
+        -------
+        InputAnchorBase
+            An instance of a concrete InputAnchorBase object with the name requested.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def get_output_anchor(self, name: str) -> "OutputAnchorBase":
+        """
+        Get an output anchor by name.
+
+        Parameters
+        ----------
+        name
+            The name of the anchor to get.
+
+        Returns
+        -------
+        OutputAnchorBase
+            An instance of a concrete OutputAnchorBase object with the name requested.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def dcm(self) -> "Dcm":
+        """
+        Get the DCM object from this provider.
+
+        Returns
+        -------
+        Dcm
+            An instance of a concrete Dcm object.
+        """
+        raise NotImplementedError()

another_ayx_python_sdk/core/proxy_requests.py

@@ -0,0 +1,51 @@
+# 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.
+
+"""Utility module for proxy authentication and configuration."""
+from typing import TYPE_CHECKING
+
+import another_ayx_python_sdk.core.constants as core_const
+
+from pypac import PACSession
+
+from requests.auth import HTTPProxyAuth
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core import ProviderBase
+
+
+def create_proxied_session(
+    tool_provider: "ProviderBase", use_engine_credentials: bool = True
+) -> PACSession:
+    """
+    Create and return a `requests` session for an environment using a proxy.
+
+    `PACSession` will apply any settings found for PAC on the system. If `use_engine_credentials`
+    is `False` you must apply your own credentials to the returned session.
+    """
+    session = PACSession()
+    proxy_conf: dict = tool_provider.environment.proxy_configuration
+    # PAC may be used without authentication required, check engine for auth requirement or defer to user for credentials
+    if (
+        use_engine_credentials
+        and proxy_conf.get(core_const.AYX_PROXY_CRED_REQ_KEY, "false") == "true"
+    ):
+        creds = (
+            proxy_conf[core_const.AYX_PROXY_USERNAME_KEY],
+            tool_provider.io.decrypt_password(
+                proxy_conf[core_const.AYX_PROXY_PASSWORD_KEY]
+            ),
+        )
+        session.proxy_auth = HTTPProxyAuth(*creds)
+    return session

another_ayx_python_sdk/core/record_packet.py

@@ -0,0 +1,88 @@
+# 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.
+"""Simple Record Packet class definition."""
+from typing import TYPE_CHECKING
+
+from another_ayx_python_sdk.core.metadata import Metadata
+from another_ayx_python_sdk.core.record_packet_base import RecordPacketBase
+
+
+if TYPE_CHECKING:
+    import pandas as pd
+
+
+class RecordPacket(RecordPacketBase):
+    """
+    Simple record packet based on pandas.
+
+    This record packet is a generic format based on the pandas dataframe
+    and the Record class.
+    """
+
+    def __init__(self, metadata: Metadata, df: "pd.DataFrame"):
+        """
+        Construct a record packet.
+
+        Parameters
+        ----------
+        metadata
+            The metadata for records contained in the packet.
+
+        records
+            Optional sequence of records for initializing data in the packet.
+        """
+        if len(df.columns) != len(metadata):
+            raise ValueError(
+                "Dataframe must have the same number of fields as metadata."
+            )
+
+        self._df = df
+        self.__metadata = metadata
+
+    @property
+    def metadata(self) -> Metadata:
+        """
+        Get the packet metadata.
+
+        Returns
+        -------
+        Metadata
+            The metadata for records contained in the packet.
+        """
+        return self.__metadata
+
+    def to_dataframe(self) -> "pd.DataFrame":
+        """
+        Get the packet data as a dataframe.
+
+        Returns
+        -------
+        pd.DataFrame
+            The dataframe that contains all records in the packet.
+        """
+        return self._df
+
+    @classmethod
+    def from_dataframe(cls, metadata: Metadata, df: "pd.DataFrame") -> "RecordPacket":
+        """
+        Build a packet from a dataframe.
+
+        Parameters
+        ----------
+        metadata
+            The metadata for the record packet.
+        df
+            The dataframe to generate records from.
+        """
+        return cls(metadata, df)