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

build/lib/another_ayx_python_sdk/core/input_connection_base.py

@@ -0,0 +1,206 @@
+# 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.
+"""Input Connection Base class definition."""
+from abc import ABC, abstractmethod
+from enum import IntEnum
+from typing import Any, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.core.input_anchor_base import InputAnchorBase
+    from another_ayx_python_sdk.core.metadata import Metadata  # noqa: F401
+    from another_ayx_python_sdk.core.record_packet_base import RecordPacketBase
+
+
+class InputConnectionStatus(IntEnum):
+    """Enumeration for connection state."""
+
+    CREATED = 1
+    INITIALIZED = 2
+    RECEIVING_RECORDS = 3
+    CLOSED = 4
+
+
+class InputConnectionBase(ABC):
+    """Input connection that receives data from upstream tools."""
+
+    @property
+    @abstractmethod
+    def name(self) -> str:
+        """
+        Get the connection name.
+
+        Returns
+        -------
+        str
+            Name of the input connection.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def metadata(self) -> Optional["Metadata"]:
+        """
+        Get the connection metadata.
+
+        Returns
+        -------
+        Metadata, optional
+            The metadata associated with this input connection.
+
+            This returns None when accessed before the input
+            connection has been opened, since the metadata isn't
+            known until that point.
+        """
+        raise NotImplementedError()
+
+    @property
+    @abstractmethod
+    def anchor(self) -> "InputAnchorBase":
+        """
+        Get the anchor this input connection is associated with.
+
+        Returns
+        -------
+        InputAnchorBase
+            The anchor this input connection is associated with.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def read(self) -> "RecordPacketBase":
+        """
+        Read a record packet from the incoming connection.
+
+        Returns
+        -------
+        RecordPacketBase
+            A record packet that contains the data received by this connection.
+        """
+        raise NotImplementedError()
+
+    @property
+    def max_packet_size(self) -> Optional[int]:
+        """
+        Get the maximum number of records per packet.
+
+        Returns
+        -------
+        int, optional
+            The maximum number of records in a packet.
+        """
+        return self._get_max_packet_size()
+
+    @max_packet_size.setter
+    def max_packet_size(self, value: Optional[int]) -> None:
+        """
+        Set the maximum number of records per packet.
+
+        Parameters
+        ----------
+        value
+            The maximum number of records.
+        """
+        self._set_max_packet_size(value)
+
+    @property
+    @abstractmethod
+    def progress(self) -> float:
+        """
+        Get the progress percentage of records received on this input connection.
+
+        Returns
+        -------
+        float
+            The progress percentage of the connection.
+        """
+        raise NotImplementedError()
+
+    @progress.setter
+    @abstractmethod
+    def progress(self, value: float) -> None:
+        """
+        Set the progress percentage of records received on this input connection.
+
+        Parameters
+        ----------
+        value
+            The progress percentage of the connection.
+        """
+        raise NotImplementedError()
+
+    def __eq__(self, other: Any) -> bool:
+        """
+        Compare 2 input connection instances by value.
+
+        Parameters
+        ----------
+        other
+            Other object to compare with this object.
+
+        Returns
+        -------
+        bool
+            True if all properties of this connection match the other connection.
+        """
+        if not isinstance(other, self.__class__):
+            return NotImplemented
+        return (
+            self.name == other.name
+            and self.metadata == other.metadata
+            and self.anchor == other.anchor
+            and self.max_packet_size == other.max_packet_size
+            and self.progress == other.progress
+        )
+
+    @property
+    def status(self) -> InputConnectionStatus:
+        """
+        Get the current state of the input connection.
+
+        Returns
+        -------
+        InputConnectionStatus
+            Enum value corresponding to the state of the input connection
+                CREATED = 1
+                INITIALIZED = 2
+                RECEIVING_RECORDS = 3
+                CLOSED = 4
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def _get_max_packet_size(self) -> Optional[int]:
+        """
+        Get the max packet size allowed on this connection.
+
+        Returns
+        -------
+        int, optional
+            The maximum number of records in a packet.
+
+            None if max_packet_size is not set.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def _set_max_packet_size(self, value: Optional[int]) -> None:
+        """
+        Set the max packet size allowed on this connection.
+
+        Parameters
+        ----------
+        value
+            Max number of records allowed in each packet.
+        """
+        raise NotImplementedError()

build/lib/another_ayx_python_sdk/core/io_base.py

@@ -0,0 +1,139 @@
+# 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.
+"""IO (input/output) utility functions for reading from and writing to Alteryx Designer."""
+from abc import ABC, abstractmethod
+from typing import Any, TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+class IoBase(ABC):
+    """IO Base class definition."""
+
+    @abstractmethod
+    def error(self, error_msg: str) -> None:
+        """
+        Display an error message in the Alteryx Designer Results window.
+
+        Parameters
+        ----------
+        error_msg
+            A string to show as an error in the Designer Results window.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def warn(self, warn_msg: str) -> None:
+        """
+        Display a warning message in the Alteryx Designer Results window.
+
+        Parameters
+        ----------
+        warn_msg
+            A string to show as a warning in the Designer Results window.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def info(self, info_msg: str) -> None:
+        """
+        Display an info message in the Alteryx Designer Results window.
+
+        Parameters
+        ----------
+        info_msg
+            A string to show as an info message in the Designer Results window.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def translate_msg(self, msg: str, *args: Any) -> str:
+        """
+        Translate a message to the current locale.
+
+        .. deprecated:: 0.1.0a
+          `translate_msg` is not the recommended translation mechanism. Refer to
+          the documentation on localization.
+
+        Parameters
+        ----------
+        msg
+            A string to translate.
+        args
+            Arguments for string interpolation.
+
+        Returns
+        -------
+        str
+            The translated string.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def update_progress(self, percent: float) -> None:
+        """
+        Update tool progress.
+
+        Parameters
+        ----------
+        percent
+            A number between 0 and 100 to indicate the progress percentage.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def create_temp_file(self, extension: str = "tmp", options: int = 0) -> "Path":
+        """
+        Create a temporary file managed by Alteryx Designer.
+
+        Parameters
+        ----------
+        extension
+            The extension of the new file.
+        options
+            Lifecycle management options for the temp file.
+
+            0: A normal temp file. It is cleaned up by Designer when a Run completes.
+
+            1: A temp file for a GUI element, like a browse, that the GUI is responsible for cleaning up.
+
+            2: A temp file for a GUI element, like a browse, that the GUI is responsible for cleaning up.
+            Additionally, the file name is not made to be unique.
+            Use when the extension argument already contains a unique ID.
+
+        Returns
+        -------
+        Path
+            Path to the new temp file.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def decrypt_password(self, password: str) -> str:
+        """
+        Decrypt password.
+
+        Parameters
+        ----------
+        password
+            Password to decrypt.
+
+        Returns
+        -------
+        str
+            Decrypted password.
+        """
+        raise NotImplementedError()

build/lib/another_ayx_python_sdk/core/metadata.py

@@ -0,0 +1,173 @@
+# 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.
+"""Defines a class for record metadata."""
+
+from copy import deepcopy
+from typing import Any, Iterator, List, Optional
+
+from another_ayx_python_sdk.core.field import Field, FieldType
+
+
+class Metadata:
+    """
+    Record Metadata class.
+
+    This metadata is received by input connections, and written to output anchors.
+    A metadata object is a composition of ordered Field objects.
+    """
+
+    def __init__(self, fields: Optional[List[Field]] = None) -> None:
+        """
+        Instantiate the Record Metadata class.
+
+        Parameters
+        ----------
+        fields
+            A list of fields that make up the metadata object.
+        """
+        self.fields = fields or []
+
+    def add_field(
+        self,
+        name: str,
+        field_type: FieldType,
+        size: int = 0,
+        scale: int = 0,
+        source: str = "",
+        description: str = "",
+    ) -> Field:
+        """
+        Add a field to the record metadata.
+
+        Parameters
+        ----------
+        name
+            The name of the field.
+        field_type
+            The type of data that the field represents.
+        size
+            The size of the data.
+
+            For strings, this is the maximum number of characters.
+            For blobs, this is the maximum number of bytes.
+        scale
+            The scale of the data. This only applies to fixeddecimal type.
+        source
+            The source of the data.
+        description
+            A description about the data that lives in this field.
+
+        Returns
+        -------
+        Field
+            The field that was added to the metadata.
+        """
+        field = Field(
+            name=name,
+            field_type=field_type,
+            size=size,
+            scale=scale,
+            source=source,
+            description=description,
+        )
+
+        self.fields.append(field)
+        return field
+
+    def clone(self) -> "Metadata":
+        """
+        Make a deep copy of the record info.
+
+        Returns
+        -------
+        Metadata
+            A copy of this metadata object.
+        """
+        return deepcopy(self)
+
+    def __len__(self) -> int:
+        """
+        Get the number of fields in the metadata.
+
+        Returns
+        -------
+        int
+            The number of fields in the metadata object.
+        """
+        return len(self.fields)
+
+    def __iter__(self) -> Iterator[Field]:
+        """
+        Iterate over the fields in the metadata.
+
+        Yields
+        ------
+        Field
+            Each field in the metadata object.
+        """
+        yield from self.fields
+
+    def __eq__(self, other: Any) -> bool:
+        """
+        Determine if metadata object is equivalent to another.
+
+        Parameters
+        ----------
+        other
+            The object to compare against.
+
+        Returns
+        -------
+        bool
+            Boolean value that indicates if the 2 objects are equal.
+        """
+        if not isinstance(other, Metadata):
+            return NotImplemented
+        if len(self) != len(other):
+            return False
+        return all([field == other_field for field, other_field in zip(self, other)])
+
+    def __getitem__(self, item: int) -> Field:
+        """
+        Get the field at an index.
+
+        Parameters
+        ----------
+        item
+            The index of the field to get.
+
+        Returns
+        -------
+        Field
+            The field at the specified index.
+        """
+        if not isinstance(item, int):
+            raise ValueError("Index must be integer.")
+        if item < 0:
+            raise ValueError("Index must be greater than 0.")
+        if len(self.fields) < item:
+            raise ValueError("Index out of bounds!")
+        return self.fields[item]
+
+    def __repr__(self) -> str:
+        """
+        Get the string representation of the object.
+
+        Returns
+        -------
+        str
+            The string representation of the metadata.
+        """
+        fields_str = "".join(["\n    " + repr(field) + "," for field in self]) + "\n"
+        return f"Metadata({fields_str})"

build/lib/another_ayx_python_sdk/core/observable_mixin.py

@@ -0,0 +1,90 @@
+# 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.
+"""Observable Mixin class definition."""
+from collections import defaultdict
+from typing import Any, Callable, DefaultDict, List
+
+
+class ObservableMixin:
+    """
+    Mixin to make an object observable.
+
+    An observable object has 3 new methods available on it:
+    subscribe, subscribe_all, and notify_topic.
+    """
+
+    __slots__ = ["_subscribers", "_subscribers_to_all"]
+
+    def __init__(self) -> None:
+        """Initialize observable properties."""
+        self._subscribers: DefaultDict = defaultdict(list)
+        self._subscribers_to_all: List[Callable] = []
+
+    def subscribe(self, topic: Any, callback: Callable) -> None:
+        """
+        Subscribe to a topic.
+
+        The callback for this subscription is called any time the topic
+        is published to. The arguments passed to the callable depend on the
+        payload given by notifier.
+
+        Parameters
+        ----------
+        topic
+            The topic to subscribe to. Any time this class notifies this topic,
+            the callback function is called.
+
+        callback
+            The callback function to call when the given topic is notified
+            of an event.
+        """
+        self._subscribers[topic].append(callback)
+
+    def subscribe_all(self, callback: Callable) -> None:
+        """
+        Subscribe to all topics.
+
+        The callback for this subscription is called any time any topic
+        is published to. The arguments passed to the callable depend on the
+        payload given by notifier.
+
+        Parameters
+        ----------
+        callback
+            The callback function to call when any topic is notified
+            of an event.
+        """
+        self._subscribers_to_all.append(callback)
+
+    def notify_topic(self, topic: Any, **payload: Any) -> None:
+        """
+        Notify a topic of an event.
+
+        This calls any callbacks that have been registered to listen
+        for notifications to this topic. The payload can be any assortment
+        of key-value pairs.
+
+        Parameters
+        ----------
+        topic
+            The topic to notify.
+
+        **payload
+            Any assortment of key-value pairs to give to the callback functions.
+        """
+        for callback in self._subscribers[topic]:
+            callback(**payload)
+
+        for callback in self._subscribers_to_all:
+            callback(**payload)