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

build/lib/build/lib/another_ayx_python_sdk/core/environment_base.py

@@ -1,213 +0,0 @@
-# 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.
-"""Runtime Environment information."""
-import os
-from abc import ABC, abstractmethod
-from enum import Enum, unique
-from pathlib import Path
-from typing import Literal
-
-import xmltodict
-
-Locale = Literal["en", "it", "fr", "de", "ja", "es", "pt", "zh"]
-
-
-@unique
-class UpdateMode(Enum):
-    """The types of update modes that can run in Alteryx Designer."""
-
-    NO_UPDATE_MODE = ""
-    QUICK = "Quick"
-    FULL = "Full"
-
-
-class EnvironmentBase(ABC):
-    """
-    Environment Information class definition.
-
-    This class provides information about the runtime environment
-    of the tool that is running. For example, if it is running as update
-    only, the version of the system running, etc.
-    """
-
-    @property
-    @abstractmethod
-    def update_only(self) -> bool:
-        """
-        Check if the engine is running in update-only mode.
-
-        Returns
-        -------
-        bool
-            Boolean value that indicates if the engine is running in update only.
-
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def update_mode(self) -> UpdateMode:
-        """
-        Get the type of update running.
-
-        Returns
-        -------
-        UpdateMode
-            Enumeration corresponding to the update mode that the workflow is running in.
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def designer_version(self) -> str:
-        """
-        Return the version of Designer that is being used.
-
-        Returns
-        -------
-        str
-            A version in the format of 1.2.3.4
-
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def workflow_dir(self) -> Path:
-        """
-        Get the directory for the currently-running workflow.
-
-        Returns
-        -------
-        Path
-            The workflow directory as a Path object.
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def workflow_id(self) -> str:
-        """
-        Get the WorkflowRunGuid for the currently-running workflow.
-
-        Returns
-        -------
-        str
-            The workflow id.
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def alteryx_install_dir(self) -> Path:
-        """
-        Get the Alteryx install directory.
-
-        Returns
-        -------
-        Path
-            The Alteryx install directory as a Path object.
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def alteryx_locale(self) -> Locale:
-        """
-        Retrieve the locale code from Alteryx Designer User Settings.
-
-        Returns
-        -------
-        Locale
-            The language/region that Alteryx is using to display messages.
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def tool_id(self) -> int:
-        """
-        Get the current tool's workflow ID.
-
-        Returns
-        -------
-        int
-            Tool's ID (specified by developer).
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def proxy_configuration(self) -> dict:
-        """
-        Get the proxy configuration settings if they exist.
-
-        Returns
-        -------
-        dict
-            Proxy Configuration as set in Designer
-        """
-        raise NotImplementedError()
-
-    @abstractmethod
-    def get_settings_conf(
-        self, keys: list, version_override: str = ""
-    ) -> dict:  # noqa: D102
-        """Parse xml to retrieve settings."""
-        designer_version = (
-            self.designer_version[0:6] if not version_override else version_override
-        )
-        user_settings_path = (
-            Path(os.environ["APPDATA"])
-            / "Alteryx"
-            / "Engine"
-            / designer_version
-            / "UserSettings.xml"
-        )
-        with open(user_settings_path) as f:
-            user_settings = xmltodict.parse(f.read())
-            while keys:
-                user_settings = user_settings[keys[0]]
-                keys = keys[1:]
-        return user_settings
-
-    @abstractmethod
-    def parse_settings_key_value(
-        self, settings_str: str, line_delimiter: str = "\n", key_delimiter: str = "="
-    ) -> dict:  # noqa: D102
-        """Extract a key value pair from an xml text entry set by Designer."""
-        parsed_values = {}
-        for key_val_pair in settings_str.split(line_delimiter):
-            keyval = key_val_pair.split(key_delimiter, 1)
-            # might have a blank or unset key
-            if len(keyval) > 1:
-                parsed_values[keyval[0]] = keyval[1]
-        return parsed_values
-
-    @abstractmethod
-    def update_tool_config(self, new_config: dict) -> None:
-        """
-        Update the tool's configuration.
-
-        Parameters
-        ----------
-        new_config
-            The new configuration to set for the tool.
-
-        Returns
-        -------
-        None
-
-        """
-        raise NotImplementedError()

build/lib/build/lib/another_ayx_python_sdk/core/exceptions.py

@@ -1,59 +0,0 @@
-# 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.
-"""Exception class definition."""
-
-
-class WorkflowRuntimeError(Exception):
-    """Exception for a workflow runtime error."""
-
-    def __init__(self, msg: "str"):
-        """
-        Construct a workflow runtime error.
-
-        Parameters
-        ----------
-        msg
-            Human-readable description of the error that occurred.
-        """
-        super().__init__(str(msg))
-
-
-class AnchorNotFoundException(Exception):
-    """Exception for when a requested anchor can't be found for the tool."""
-
-
-class DcmEError:
-    """Class for storage of DcmE error information."""
-
-    def __init__(self, message: str, error_code: int, detail: str = ""):
-        """Create a DcmEError class."""
-        self.message = message
-        self.error_code = error_code
-        self.detail = detail
-
-
-class DcmEException(Exception):
-    """Class for exception happened during DcmE transactions."""
-
-    def __init__(self, msg: "str", error: DcmEError):
-        """
-        Construct a DcmE exception error.
-
-        Parameters
-        ----------
-        msg
-            Human-readable description of the error that occurred.
-        """
-        super().__init__(str(msg))
-        self.dcm_error = error

build/lib/build/lib/another_ayx_python_sdk/core/field.py

@@ -1,183 +0,0 @@
-# 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 Field class definition."""
-from enum import Enum
-from typing import Any, Optional
-
-import pyarrow as pa
-
-
-class FieldType(Enum):
-    """
-    Field types.
-
-    See AyxData/include/AyxData/dc/common/FieldType.h C++ enumeration.
-    """
-
-    bool = 1
-    byte = 2
-    int16 = 3
-    int32 = 4
-    int64 = 5
-    fixeddecimal = 6
-    float = 7
-    double = 8
-    string = 9
-    wstring = 10
-    v_string = 11
-    v_wstring = 12
-    date = 13
-    time = 14
-    datetime = 15
-    blob = 16
-    spatialobj = 17
-
-
-class Field:
-    """A record field that contains metadata like field name."""
-
-    def __init__(
-        self,
-        name: str,
-        field_type: FieldType,
-        size: int = 0,
-        scale: int = 0,
-        source: Optional[str] = None,
-        description: Optional[str] = None,
-    ) -> None:
-        """
-        Instantiate a field.
-
-        Parameters
-        ----------
-        name
-            The name of the field.
-        field_type
-            The type of data that this 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.
-        """
-        # set maximum size for strings
-        if size == 0:
-            if field_type == FieldType.string or field_type == FieldType.wstring:
-                size = 0x3FFF
-            elif field_type == FieldType.v_string or field_type == FieldType.v_wstring:
-                size = 0x7FFFFFFF
-        if field_type == FieldType.spatialobj:
-            source = "WKT"
-        self.name = name
-        self.type = field_type
-        self.size = size
-        self.scale = scale
-        self.source = source or ""
-        self.description = description or ""
-
-    def __eq__(self, other: Any) -> bool:
-        """
-        Determine if 2 fields are equal.
-
-        Parameters
-        ----------
-        other
-            Any other object to compare against.
-
-        Returns
-        -------
-        bool
-            True if all properties of this field match the other field.
-        """
-        if not isinstance(other, Field):
-            return NotImplemented
-        return (
-            self.name == other.name
-            and self.type == other.type
-            and self.size == other.size
-            and self.scale == other.scale
-            and self.source == other.source
-            and self.description == other.description
-        )
-
-    def __repr__(self) -> str:
-        """
-        Get the string representation of the object.
-
-        Returns
-        -------
-        str
-            The string representation of the metadata.
-        """
-        return (
-            f"Field(name={self.name}, field_type={self.type}, size={self.size}, "
-            f'scale={self.scale}, source="{self.source}", description="{self.description}")'
-        )
-
-    def arrow_type(self) -> "pa.Type":
-        """Return the Python Arrow type of this field."""
-        if self.type == FieldType.bool:
-            return pa.bool_()
-        elif self.type == FieldType.byte:
-            return pa.uint8()
-        elif self.type == FieldType.int16:
-            return pa.int16()
-        elif self.type == FieldType.int32:
-            return pa.int32()
-        elif self.type == FieldType.int64:
-            return pa.int64()
-        elif self.type == FieldType.fixeddecimal:
-            return pa.decimal256(76, 36)
-        elif self.type == FieldType.float:
-            return pa.float32()
-        elif self.type == FieldType.double:
-            return pa.float64()
-        elif (
-            self.type == FieldType.string
-            or self.type == FieldType.wstring
-            or self.type == FieldType.v_string
-            or self.type == FieldType.v_wstring
-        ):
-            return pa.string()
-        elif self.type == FieldType.date:
-            return pa.date32()
-        elif self.type == FieldType.time:
-            return pa.time64("us")
-        elif self.type == FieldType.datetime:
-            return pa.date64()
-        elif self.type == FieldType.blob:
-            return pa.binary()
-        elif self.type == FieldType.spatialobj:
-            return pa.string()
-
-    def to_arrow(self) -> "pa.Field":
-        """Turn this Field to a Python Arrow Field."""
-        return pa.field(self.name, self.arrow_type(), metadata=self.as_arrow_metadata())
-
-    def as_arrow_metadata(self) -> dict:
-        """Return dict representation of the field using ayx keys."""
-        return {
-            b"ayx.type": str(self.type.value).encode("utf-8"),
-            b"ayx.size": str(self.size).encode("utf-8"),
-            b"ayx.name": self.name.encode("utf-8"),
-            b"ayx.scale": str(self.scale).encode("utf-8"),
-            b"ayx.source": self.source.encode("utf-8"),
-            b"ayx.description": self.description.encode("utf-8"),
-        }

build/lib/build/lib/another_ayx_python_sdk/core/input_anchor_base.py

@@ -1,86 +0,0 @@
-# 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 Anchor Interface class definition."""
-from abc import ABC, abstractmethod
-from typing import Any, List
-
-from another_ayx_python_sdk.core.input_connection_base import InputConnectionBase
-
-
-class InputAnchorBase(ABC):
-    """Input Anchor Interface class definition."""
-
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        """
-        Get the name of the input anchor.
-
-        Returns
-        -------
-        str
-            The name of the input 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 input anchor is optional.
-
-        Returns
-        -------
-        bool
-            Boolean value that indicates if input anchor is optional.
-        """
-        raise NotImplementedError()
-
-    @property
-    @abstractmethod
-    def connections(self) -> List[InputConnectionBase]:
-        """
-        Get the anchor connections.
-
-        Returns
-        -------
-        List[InputConnectionBase]
-            List of all the connections associated with the anchor.
-        """
-        raise NotImplementedError()
-
-    def __eq__(self, other: Any) -> bool:
-        """Implement equivalence check to compare 2 Input Anchor objects."""
-        if isinstance(other, InputAnchorBase):
-            return (
-                self.name == other.name
-                and self.allow_multiple == other.allow_multiple
-                and self.optional == other.optional
-                and self.connections == other.connections
-            )
-        else:
-            return NotImplemented