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

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/field.py

@@ -0,0 +1,122 @@
+# 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.
+"""Mock field class definition."""
+from typing import Any, Callable, Iterable, Mapping, TYPE_CHECKING
+
+from .constants import FieldType
+from .record_ref import RecordRef
+
+if TYPE_CHECKING:
+    from .record_creator import RecordCreator
+
+
+def _return_none_on_type_error(func: Callable) -> Callable:
+    def inner(*args: Iterable, **kwargs: Mapping) -> Any:
+        try:
+            return func(*args, **kwargs)
+        except TypeError:
+            return None
+
+    return inner
+
+
+class Field:
+    """Field mock."""
+
+    def __init__(
+        self,
+        name: str,
+        type: FieldType,
+        size: int,
+        scale: int,
+        source: str,
+        description: str,
+    ) -> None:
+        """Construct a field."""
+        self.name = name
+        self.type = type
+        self.size = size
+        self.scale = scale
+        self.source = source
+        self.description = description
+
+    def equal_type(self, other_field: "Field") -> bool:
+        """Check if another field has an equal type."""
+        return (
+            self.type == other_field.type
+            and self.size == other_field.size
+            and self.scale == other_field.scale
+        )
+
+    @_return_none_on_type_error
+    def get_as_bool(self, record_ref: RecordRef) -> bool:
+        """Get value of field as a boolean."""
+        return bool(record_ref.get_field(self.name))
+
+    @_return_none_on_type_error
+    def get_as_double(self, record_ref: RecordRef) -> float:
+        """Get value of a field as a double."""
+        return float(record_ref.get_field(self.name))
+
+    @_return_none_on_type_error
+    def get_as_int32(self, record_ref: RecordRef) -> int:
+        """Get value of a field as an int32."""
+        return int(record_ref.get_field(self.name))
+
+    @_return_none_on_type_error
+    def get_as_int64(self, record_ref: RecordRef) -> int:
+        """Get value of a field as an int64."""
+        return int(record_ref.get_field(self.name))
+
+    @_return_none_on_type_error
+    def get_as_string(self, record_ref: RecordRef) -> str:
+        """Get value of a field as a string."""
+        return str(record_ref.get_field(self.name))
+
+    @_return_none_on_type_error
+    def get_as_blob(self, record_ref: RecordRef) -> bytes:
+        """Get value of a field as a blob."""
+        return bytes(record_ref.get_field(self.name))
+
+    def get_null(self, record_ref: RecordRef) -> bool:
+        """Check if the value of a field is null."""
+        return record_ref.get_field(self.name) is None
+
+    def set_from_bool(self, record_creator: "RecordCreator", value: bool) -> None:
+        """Set value of a field as a boolean."""
+        record_creator.set_field(self.name, bool(value))
+
+    def set_from_double(self, record_creator: "RecordCreator", value: float) -> None:
+        """Set value of a field as a double."""
+        record_creator.set_field(self.name, float(value))
+
+    def set_from_int32(self, record_creator: "RecordCreator", value: int) -> None:
+        """Set value of a field as an int32."""
+        record_creator.set_field(self.name, int(value))
+
+    def set_from_int64(self, record_creator: "RecordCreator", value: int) -> None:
+        """Set value of a field as an int64."""
+        record_creator.set_field(self.name, int(value))
+
+    def set_from_string(self, record_creator: "RecordCreator", value: str) -> None:
+        """Set value of a field as a string."""
+        record_creator.set_field(self.name, str(value))
+
+    def set_from_blob(self, record_creator: "RecordCreator", value: bytes) -> None:
+        """Set value of a field as a blob."""
+        record_creator.set_field(self.name, bytes(value))
+
+    def set_null(self, record_creator: "RecordCreator") -> None:
+        """Set value of a field to null."""
+        record_creator.set_field(self.name, None)

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/output_anchor.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.
+"""Mock output anchor class definition."""
+from typing import List, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .record_info import RecordInfo
+    from .record_ref import RecordRef
+
+
+class OutputAnchor:
+    """Output anchor mock."""
+
+    def __init__(self) -> None:
+        self.is_closed: bool = False
+        self.record_info: Optional["RecordInfo"] = None
+        self.pushed_records: List["RecordRef"] = []
+        self.progress = 0.0
+
+    def assert_close(self) -> None:
+        """Assert the output anchor is closed."""
+        assert self.is_closed
+
+    def close(self) -> None:
+        """Close the output anchor."""
+        self.is_closed = True
+
+    def init(self, record_info_out: "RecordInfo", sort_info_xml: str = "") -> bool:
+        """Initialize the output anchor with record metadata."""
+        self.record_info = record_info_out
+        return True
+
+    def output_record_count(self, final: bool) -> None:
+        """Output the record count to Designer."""
+        raise NotImplementedError()
+
+    def push_record(self, record_ref: "RecordRef", no_auto_close: bool = False) -> bool:
+        """Push a record downstream."""
+        self.pushed_records.append(record_ref)
+        return True
+
+    def update_progress(self, percent: float) -> None:
+        """Update progress."""
+        self.progress = percent

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/output_anchor_manager.py

@@ -0,0 +1,31 @@
+# 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.
+"""Mock output anchor manager class definition."""
+from typing import Mapping, Optional, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .output_anchor import OutputAnchor  # noqa
+
+
+class OutputAnchorManager:
+    """Output anchor manager mock."""
+
+    def __init__(self, output_anchor_map: Mapping[str, "OutputAnchor"]):
+        self._output_anchor_map = output_anchor_map
+
+    def get_output_anchor(
+        self, output_connection_name: str
+    ) -> Optional["OutputAnchor"]:
+        """Get an output anchor by name."""
+        return self._output_anchor_map.get(output_connection_name)

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/record_copier.py

@@ -0,0 +1,65 @@
+# 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.
+"""Mock record copier class definition."""
+from typing import Dict, TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from .record_creator import RecordCreator
+    from .record_info import RecordInfo
+    from .record_ref import RecordRef
+
+
+class RecordCopier:
+    """Record copier mock."""
+
+    def __init__(
+        self,
+        destination: "RecordInfo",
+        source: "RecordInfo",
+        suppress_size_only_conversion_errors: bool = False,
+        decimal_separator: str = ".",
+    ) -> None:
+        """Construct a record copier."""
+        self.destination = destination
+        self.source = source
+        self.supress_size_only_conversion_errors = suppress_size_only_conversion_errors
+        self.decimal_separator = decimal_separator
+        self._done_adding = False
+        self._idx_map: Dict[int, int] = {}
+
+    def add(self, destination_field_num: int, source_field_num: int) -> None:
+        """Add a field to the record copier."""
+        if self._done_adding:
+            raise RuntimeError("Done adding, can't add any more.")
+
+        self._idx_map[source_field_num] = destination_field_num
+
+    def done_adding(self) -> None:
+        """Signal that fields are done being added."""
+        self._done_adding = True
+
+    def copy(self, destination: "RecordCreator", source: "RecordRef") -> None:
+        """Copy a record to the destination format."""
+        for source_idx, dest_idx in self._idx_map.items():
+            source_key = list(source.data.keys())[source_idx]
+            dest_key = list(destination.record_ref.data.keys())[dest_idx]
+
+            destination.record_ref.data[dest_key] = source.data[source_key]
+
+    @staticmethod
+    def set_dest_to_null(destination: "RecordCreator") -> None:
+        """Set destination to all null."""
+        for key in destination.record_ref.data:
+            destination.record_ref.data[key] = None

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/record_creator.py

@@ -0,0 +1,41 @@
+# 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.
+"""Mock record creator class definition."""
+from typing import Any, TYPE_CHECKING
+
+from .record_ref import RecordRef
+
+if TYPE_CHECKING:
+    from .record_info import RecordInfo
+
+
+class RecordCreator:
+    """Record Creator mock."""
+
+    def __init__(self, record_info: "RecordInfo") -> None:
+        """Construct a record creator."""
+        self.record_ref = RecordRef(record_info)
+        self.record_info = record_info
+
+    def finalize_record(self) -> RecordRef:
+        """Finalize a record ref."""
+        return self.record_ref
+
+    def reset(self, var_data_size: int = 0) -> None:
+        """Reset the creator."""
+        self.record_ref = RecordRef(self.record_info)
+
+    def set_field(self, name: str, value: Any) -> None:
+        """Set a field in the underlying record ref."""
+        self.record_ref.set_field(name, value)

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/record_info.py

@@ -0,0 +1,134 @@
+# 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.
+"""Mock record info class definition."""
+from copy import deepcopy
+from typing import Generator, List, Optional
+
+from .alteryx_engine import AlteryxEngine
+from .constants import FieldType
+from .field import Field
+from .record_creator import RecordCreator
+
+
+class RecordInfo:
+    """Record info mock."""
+
+    def __init__(self, alteryx_engine: AlteryxEngine) -> None:
+        """Construct a record info."""
+        self.fields: List["Field"] = []
+        self.alteryx_engine = alteryx_engine
+
+    def add_field(
+        self,
+        field_name: str,
+        field_type: FieldType,
+        size: int = 0,
+        scale: int = 0,
+        source: str = "",
+        description: str = "",
+    ) -> "Field":
+        """Add a field to the record info."""
+        self.fields.append(
+            Field(
+                name=field_name,
+                type=field_type,
+                size=size,
+                scale=scale,
+                source=source,
+                description=description,
+            )
+        )
+
+        return self.fields[-1]
+
+    def add_field_from_xml(self, xml: str, name_prefix: str = "") -> "Field":
+        """Add a field from an XML string definition."""
+        raise NotImplementedError()
+
+    def clone(self) -> "RecordInfo":
+        """Make a copy of the record info."""
+        return deepcopy(self)
+
+    def construct_record_creator(self) -> RecordCreator:
+        """Create a new record creator."""
+        return RecordCreator(self)
+
+    def equal_types(
+        self, record_info: "RecordInfo", allow_additional_fields: bool = False
+    ) -> bool:
+        """Check if another record info object has equal types to this."""
+        if not allow_additional_fields and len(self) < len(record_info):
+            return False
+
+        for self_field, other_field in zip(self, record_info):
+            if self_field.type != other_field.type:
+                return False
+
+        return True
+
+    def get_field_by_name(
+        self, field_name: str, throw_error: bool = True
+    ) -> Optional["Field"]:
+        """Get a field object by field name."""
+        for field in self:
+            if field.name == field_name:
+                return field
+
+        if throw_error:
+            raise RuntimeError("Field name not found.")
+
+        return None
+
+    def get_field_num(self, field_name: str, throw_error: bool = True) -> int:
+        """Get the index of a field by name."""
+        for idx, field in enumerate(self.fields):
+            if field.name == field_name:
+                return idx
+
+        if throw_error:
+            raise RuntimeError()
+
+        return -1
+
+    def get_hash(self) -> int:
+        """Get hash of this record info."""
+        raise NotImplementedError()
+
+    def get_record_xml_meta_data(self, include_source: bool = True) -> str:
+        """Get XML metadata string."""
+        raise NotImplementedError()
+
+    def init_from_xml(self, xml: str, name_prefix: str = "") -> None:
+        """Initialize this record info from an XML string."""
+        raise NotImplementedError()
+
+    def rename_field_by_index(self, field_idx: int, new_name: str) -> "Field":
+        """Rename a field by index."""
+        raise NotImplementedError()
+
+    def rename_field_by_name(self, old_name: str, new_name: str) -> "Field":
+        """Rename a field by name."""
+        raise NotImplementedError()
+
+    def swap_field_names(self, field_1: int, field_2: int) -> None:
+        """Swap two field names."""
+        raise NotImplementedError()
+
+    def __iter__(self) -> Generator["Field", None, None]:
+        """Iterate over fields in this record info."""
+        yield from self.fields
+
+    def __len__(self) -> int:
+        """Get the number of fields available."""
+        return len(self.fields)

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/record_ref.py

@@ -0,0 +1,42 @@
+# 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.
+"""Mock record ref class definition."""
+from typing import Any, Dict, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .record_info import RecordInfo
+
+
+class RecordRef:
+    """Record ref mock."""
+
+    def __init__(self, record_info: "RecordInfo") -> None:
+        """Construct a record ref."""
+        self.data: Dict[str, Any] = {field.name: None for field in record_info}
+        self.record_info = record_info
+
+    def set_field(self, name: str, value: Any) -> None:
+        """Set a field to a value."""
+        self.data[name] = value
+
+    def get_field(self, name: str) -> Any:
+        """Get the value of a field."""
+        return self.data[name]
+
+    def __eq__(self, other: object) -> bool:
+        """Compare two record refs for equality."""
+        if not isinstance(other, RecordRef):
+            return NotImplemented
+
+        return self.data == other.data

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/tool.py

@@ -0,0 +1,29 @@
+# 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.
+"""Tool definition."""
+from typing import Any, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .alteryx_engine import AlteryxEngine
+
+
+class Tool:
+    """Instance of a tool in a workflow along with associated data structures."""
+
+    def __init__(self, engine: "AlteryxEngine", plugin_instance: Any) -> None:
+        """Construct a new tool object."""
+        self.engine = engine
+        self.plugin_instance = plugin_instance
+        self.output_manager = None
+        self.tool_id = None

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/AlteryxPythonSDK/tool_execution_info.py

@@ -0,0 +1,43 @@
+# 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 definition for tool execution information."""
+from typing import List, Optional
+
+
+class ToolExecutionInfo:
+    """Tool execution info class."""
+
+    def __init__(self) -> None:
+        """Construct a tool execution information object."""
+        self.errors: List[str] = []
+        self.warnings: List[str] = []
+        self.infos: List[str] = []
+        self.output_workflow_xml: Optional[str] = None
+        self.progress: float = 0.0
+
+    def add_error(self, error: str) -> None:
+        """Add an error message to the info."""
+        self.errors.append(error)
+
+    def add_warning(self, warning: str) -> None:
+        """Add an warning message to the info."""
+        self.warnings.append(warning)
+
+    def add_info(self, info: str) -> None:
+        """Add an info message to the info."""
+        self.infos.append(info)
+
+    def set_output_workflow_xml(self, xml: str) -> None:
+        """Track the output tool workflow XML."""
+        self.output_workflow_xml = xml

build/lib/another_ayx_python_sdk/providers/e1_provider/mock_e1_sdk/__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.
+"""Mock alteryx python SDK package for use when not running in Designer."""

build/lib/another_ayx_python_sdk/providers/e1_provider/proxies/__init__.py

@@ -0,0 +1,18 @@
+# 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.
+"""Proxy classes for raw Python SDK classes."""
+from .field_proxy import FieldProxy
+from .record_copier_proxy import RecordCopierProxy
+
+__all__ = ["FieldProxy", "RecordCopierProxy"]