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

build/lib/another_ayx_python_sdk/providers/file_provider/file_provider_input_anchor.py

@@ -1,70 +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.
-"""The file provider input anchor class definition."""
-from typing import List, Optional, TYPE_CHECKING
-
-from another_ayx_python_sdk.core.doc_utilities import inherit_docs
-from another_ayx_python_sdk.core.input_anchor_base import InputAnchorBase
-
-if TYPE_CHECKING:  # noqa: F401
-    from another_ayx_python_sdk.core.input_connection_base import (  # noqa: F401
-        InputConnectionBase,
-    )  # noqa: F401
-
-
-@inherit_docs
-class FileProviderInputAnchor(InputAnchorBase):
-    """An input anchor that contains input connection information."""
-
-    def __init__(
-        self,
-        name: str,
-        allow_multiple: bool = False,
-        optional: bool = False,
-        connections: Optional[List["InputConnectionBase"]] = None,
-    ) -> None:
-        """
-        Instantiate a file provider input anchor.
-
-        Parameters
-        ----------
-        name
-            The name of the input anchor.
-        allow_multiple
-            Indicates whether the anchor can have multiple input connections associated with it.
-        optional
-            Indicates whether the anchor is optional or not.
-        connections
-            The list of input connections associated with this anchor.
-        """
-        self.__name = name
-        self.__allow_multiple = allow_multiple
-        self.__optional = optional
-        self.__connections: List["InputConnectionBase"] = connections or []
-
-    @property
-    def name(self) -> str:  # noqa: D102
-        return self.__name
-
-    @property
-    def allow_multiple(self) -> bool:  # noqa: D102
-        return self.__allow_multiple
-
-    @property
-    def optional(self) -> bool:  # noqa: D102
-        return self.__optional
-
-    @property
-    def connections(self) -> List["InputConnectionBase"]:  # noqa: D102
-        return self.__connections

build/lib/another_ayx_python_sdk/providers/file_provider/file_provider_input_connection.py

@@ -1,112 +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.
-"""File Provider Input Connection class."""
-from typing import Optional, TYPE_CHECKING
-
-from another_ayx_python_sdk.core.doc_utilities import inherit_docs
-from another_ayx_python_sdk.core.input_connection_base import InputConnectionBase
-from another_ayx_python_sdk.core.metadata import Metadata
-from another_ayx_python_sdk.core.record_packet import RecordPacket
-
-import pandas as pd
-
-
-if TYPE_CHECKING:
-    from another_ayx_python_sdk.providers.file_provider.file_provider_input_anchor import (
-        FileProviderInputAnchor,
-    )
-
-
-@inherit_docs
-class FileProviderInputConnection(InputConnectionBase):
-    """An input connection contains incoming record and metadata information."""
-
-    def __init__(
-        self,
-        name: str,
-        metadata: Metadata,
-        packet: Optional[RecordPacket] = None,
-        anchor: Optional["FileProviderInputAnchor"] = None,
-    ) -> None:
-        """
-        Instantiate a file provider input connection.
-
-        Parameters
-        ----------
-        name
-            Name of the input connection.
-        metadata
-            Metadata for the input connections.
-        packet
-            Record information for the input connection.
-        anchor
-            Input anchor associated with this connection.
-        """
-        if packet and packet.metadata != metadata:
-            raise ValueError(
-                "Record packet metadata must be the same as anchor metadata."
-            )
-
-        self.__packet = packet
-        self.__name = name
-        self.__metadata = metadata
-        self.__anchor = anchor
-        self.max_packet_size = None
-        self.progress = 0
-
-    @property
-    def name(self) -> str:  # noqa: D102
-        return self.__name
-
-    @property
-    def metadata(self) -> Optional[Metadata]:  # noqa: D102
-        return self.__metadata
-
-    @property
-    def anchor(self) -> "FileProviderInputAnchor":  # noqa: D102
-        if self.__anchor:
-            return self.__anchor
-
-        raise RuntimeError("This input connection is not associated with an anchor.")
-
-    def read(self) -> RecordPacket:  # noqa: D102
-        if self.metadata is None:
-            raise ValueError("Metadata must be set.")
-
-        return self.__packet or RecordPacket(
-            self.metadata, pd.DataFrame(columns=[field.name for field in self.metadata])
-        )
-
-    def _get_max_packet_size(self) -> Optional[int]:
-        return self.__max_packet_size
-
-    def _set_max_packet_size(self, value: Optional[int]) -> None:
-        """
-        File provider doesn't use max_packet size - automatically set to None.
-
-        Otherwise, a user could try and set max packet size for the file provider and would not know why it was not affecting their tool.
-        """
-        if value is not None:
-            return  # TODO: warn user that the file provider does not currently support setting max_packet_size
-        self.__max_packet_size = value
-
-    @property
-    def progress(self) -> float:  # noqa: D102
-        return self.__progress
-
-    @progress.setter
-    def progress(self, value: float) -> None:  # noqa: D102
-        if value < 0:
-            raise ValueError("Progress percentage must be greater than 0.")
-        self.__progress = value

build/lib/another_ayx_python_sdk/providers/file_provider/file_provider_output_anchor.py

@@ -1,114 +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.
-"""File provider output anchor class."""
-from pathlib import Path
-from typing import Optional, TYPE_CHECKING
-
-from another_ayx_python_sdk.core import OutputAnchorBase
-from another_ayx_python_sdk.core.doc_utilities import inherit_docs
-
-if TYPE_CHECKING:
-    from another_ayx_python_sdk.core.metadata import Metadata
-    from another_ayx_python_sdk.core.record_packet import RecordPacketBase
-    from another_ayx_python_sdk.providers.file_provider.file_adapter import (  # noqa: F401
-        FileAdapter,
-    )  # noqa: F401
-
-
-@inherit_docs
-class FileProviderOutputAnchor(OutputAnchorBase):
-    """The output anchor contains outgoing record and metadata information."""
-
-    def __init__(
-        self, name: str, allow_multiple: bool = False, optional: bool = False
-    ) -> None:
-        """
-        Instantiate a file provider output anchor.
-
-        Parameters
-        ----------
-        name
-            Name of the output anchor.
-        allow_multiple
-            Indicates whether to allow more than one connection.
-        optional
-            Indicates whether the anchor is optional or not.
-        """
-        self.__name = name
-        self.__allow_multiple = allow_multiple
-        self.__optional = optional
-        self.__metadata: Optional["Metadata"] = None
-        self.__is_closed: bool = True
-        self.__num_connections: int = 0
-        # TODO the file paths and FileAdapter should be populated by the constructor
-        self.metadata_file: Path = Path()
-        self.record_file: Path = Path()
-        self.file_adapter: Optional["FileAdapter"] = None
-
-    def update_progress(self, percentage: float) -> None:
-        """File provider does not need to update progress, so pass."""
-
-    @property
-    def name(self) -> str:  # noqa: D102
-        return self.__name
-
-    @property
-    def allow_multiple(self) -> bool:  # noqa: D102
-        return self.__allow_multiple
-
-    @property
-    def optional(self) -> bool:  # noqa: D102
-        return self.__optional
-
-    @property
-    def num_connections(self) -> int:  # noqa: D102
-        return self.__num_connections
-
-    @property
-    def is_open(self) -> bool:  # noqa: D102
-        return not self.__is_closed
-
-    @property
-    def metadata(self) -> Optional["Metadata"]:  # noqa: D102
-        return self.__metadata
-
-    def open(self, metadata: "Metadata") -> None:  # noqa: D102
-        if not self.file_adapter:
-            raise RuntimeError("File adapter must be set to open the output anchor.")
-
-        self.__metadata = metadata
-        # TODO we should just have a helper function here
-        self.file_adapter.metadata_to_xml(self.metadata_file, self.__metadata)
-        self.__is_closed = False
-
-    def write(self, record_packet: "RecordPacketBase") -> None:  # noqa: D102
-        if not self.__metadata or not self.file_adapter:
-            raise RuntimeError(
-                "Output anchor must be opened before it can be written to."
-            )
-
-        if self.__metadata != record_packet.metadata:
-            raise RuntimeError(
-                "Output anchor's metadata must match the incoming record packet's metadata."
-            )
-
-        dataframe = record_packet.to_dataframe()
-        # TODO This will overwrite the entire CSV file. It should have the option to append the records to one that already exists.
-        self.file_adapter.dataframe_to_csv(self.record_file, dataframe)
-
-    def flush(self) -> None:
-        """File provider does not need to flush records, so pass."""
-
-    def close(self) -> None:  # noqa: D102
-        self.__is_closed = True

build/lib/another_ayx_python_sdk/providers/file_provider/file_record_packet.py

@@ -1,21 +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.
-"""Interface for working with multiple records."""
-from another_ayx_python_sdk.core.doc_utilities import inherit_docs
-from another_ayx_python_sdk.core.record_packet import RecordPacket
-
-
-@inherit_docs
-class FileRecordPacket(RecordPacket):
-    """File Record packet."""

build/lib/another_ayx_python_sdk/providers/file_provider/iox.py

@@ -1,56 +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.
-"""File Provider."""
-from pathlib import Path
-from typing import Any
-
-from another_ayx_python_sdk.core.io_base import IoBase
-
-import deprecation
-
-
-class IO(IoBase):
-    """Simple tool interface that will be used with Designer."""
-
-    def __init__(self) -> None:
-        """Instantiate the interface."""
-
-    def error(self, error_msg: str) -> None:
-        """Display an error in the Results window."""
-
-    def warn(self, warn_msg: str) -> None:
-        """Display a warning in the Results window."""
-
-    def info(self, info_msg: str) -> None:
-        """Display information in the Results window."""
-
-    def translate_msg(self, msg: str, *args: Any) -> str:
-        """Translate a message."""
-        raise NotImplementedError()
-
-    def update_progress(self, percent: float) -> None:
-        """Update tool progress."""
-
-    def create_temp_file(self, extension: str = "tmp", options: int = 0) -> Path:
-        """Create a temporary file path."""
-        return Path(extension)
-
-    @deprecation.deprecated(
-        deprecated_in="1.0.3",
-        removed_in="2.0.0",
-        details="Use functions of provider's dcm property instead",
-    )  # type: ignore
-    def decrypt_password(self, password: str) -> str:  # noqa: D102
-        """Decrypt a password; will append '_decrypted' to the supplied password."""
-        return password + "_decrypted"

build/lib/another_ayx_python_sdk/providers/file_provider/tool_input.py

@@ -1,104 +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.
-"""Alteryx Designer environment information."""
-from pathlib import Path
-from typing import List, Optional
-
-from pydantic import BaseModel, validator
-
-
-class ToolDefinition(BaseModel):
-    """
-    ToolDefinition validates the tool information for the tool input.
-
-    Parameters
-    ----------
-    plugin
-        The class name of the plugin being run.
-    path
-        The path to the plugin being run.
-    """
-
-    plugin: str
-    path: Path
-
-
-class AnchorDefinition(BaseModel):
-    """
-    AnchorDefinition validates the anchor information for the tool input.
-
-    Parameters
-    ----------
-    anchor_name
-        The name of the anchor that the records and metadata are assoiciated with.
-    records
-        The anchor record data.
-    metadata
-        The anchor metadata information.
-    """
-
-    anchor_name: str
-    records: Path
-    metadata: Path
-
-
-class ToolInput(BaseModel):
-    """
-    ToolInput validates the input JSON for the user input to the file provider.
-
-    Parameters
-    ----------
-    tool
-        A ToolDefinition object with 2 inputs, path and plugin, that contain the path
-        to the plugin and the plugin name respectively.
-    tool_config
-        The path to the tool configuration file.
-    workflow_config
-        The path to the workflow configuration file.
-    inputs
-        A list of AnchorDefinition objects with 3 inputs, anchor_name, records, and metadata,
-        that specify the anchor the input information corresponds to, the record information for that anchor,
-        and the metadata information for that anchor respectively.
-     outputs
-        A list of AnchorDefinition objects with 3 inputs, anchor_name, records, and metadata, that specify the anchor
-        the output information corresponds to, the file where the record information for that anchor will
-        be stored, and the file where the metadata information for that anchor will be stored respectively.
-    update_tool_config
-        An optional path that indicates whether to update the tool's config. If it is set,
-        the config will be updated at the specified path.
-    """
-
-    tool: ToolDefinition
-    tool_config: Path
-    workflow_config: Path
-    inputs: Optional[List[AnchorDefinition]]
-    outputs: Optional[List[AnchorDefinition]]
-    update_tool_config: Optional[Path]
-
-    @validator("inputs", "outputs", always=True, pre=True)
-    def anchor_is_none(cls, v):  # type: ignore  # noqa: N805
-        """
-        Set the inputs and outputs equal to an empty list if they aren't specified.
-
-        Parameters
-        ----------
-        v
-            The inputs or the outputs optional list of dictionaries.
-
-        Returns
-        -------
-        List[Dict[str, str]]
-            An empty list or the inputs or outputs.
-        """
-        return v or []

build/lib/another_ayx_python_sdk/test_harness/__init__.py

@@ -1,14 +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.
-"""Python SDK gRPC Plugin Test harness."""

build/lib/another_ayx_python_sdk/test_harness/__main__.py

@@ -1,120 +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.
-"""Entrypoint for the test harness."""
-import asyncio
-from enum import Enum
-from pathlib import Path
-from typing import List
-
-from another_ayx_python_sdk.core import Field, FieldType, Metadata
-from another_ayx_python_sdk.test_harness.plugin_runner import (
-    PluginRunner,
-    RunMode,
-)
-
-import pandas as pd
-
-import typer
-
-pd.set_option("display.max_columns", None)
-
-app = typer.Typer()
-
-
-class TransportType(Enum):
-    """Data serialization formats."""
-
-    ENGINE = "engine"
-    ARROW = "arrow"
-
-
-@app.command()
-def version() -> None:
-    """Get the version pf the test harness."""
-    typer.echo("Version: 1.0.0")
-
-
-@app.command()
-def run_plugin(
-    plugin_entrypoint: Path = typer.Argument(
-        ..., help="The path to the entrypoint to run."
-    ),
-    plugins_package: str = typer.Argument(
-        ..., help="The package that contains plugins to run."
-    ),
-    tool_name: str = typer.Argument(..., help="The name of the tool to run."),
-    config_xml: Path = typer.Argument(
-        ..., help="Config XML file containing input/output anchor config."
-    ),
-    input_csv: List[Path] = typer.Option(
-        "", help="List of CSV files to use as input data."
-    ),
-    transport_type: str = typer.Option(
-        TransportType.ARROW, help="[engine | arrow] which data type to use for the run"
-    ),
-    run_mode: RunMode = RunMode.full_run,
-) -> None:
-    """Run a plugin out of process and run data through it."""
-    typer.echo(
-        f"Running {tool_name} in {'update only' if run_mode == RunMode.update_only else 'full run'} mode.\n"
-    )
-    input_data = []
-    if input_csv:
-        for path in input_csv:
-            if not path.is_file() or not path.exists():
-                raise FileNotFoundError("Could not find input csv data")
-            dataframe = pd.read_csv(path)
-            input_data.append(dataframe)
-
-    input_metadata = [_get_metadata(df) for df in input_data]
-
-    runner = PluginRunner(
-        plugin_entrypoint,
-        plugins_package,
-        tool_name,
-        input_metadata,
-        input_data,
-        config_xml,
-        transport_type,
-    )
-    asyncio.run(runner.run_plugin_v2(run_mode))
-
-    # Keeping the below as a reminder in case we need to test metadata still.
-    # if transport_type == "engine":
-    #     output_metadata = runner.get_output_metadata()
-    #     typer.echo(f"Output metadata is:\n{output_metadata}\n")
-
-    # if run_mode == RunMode.full_run:
-    #     output_data = runner.get_output_data()
-    #     typer.echo(f"Output data is:\n{output_data}\n")
-
-
-def _get_metadata(dataframe: pd.DataFrame) -> Metadata:
-    fields = []
-    for col in dataframe.columns:
-        name, field_type, size = col.split("-")
-        fields.append(
-            Field(name=name, field_type=FieldType(field_type), size=int(size))
-        )
-
-    return Metadata(fields)
-
-
-def main() -> None:
-    """Run the main CLI for the test harness."""
-    app()
-
-
-if __name__ == "__main__":
-    main()