Source code for ayx_plugin_sdk.providers.e1_provider.e1_io

# Copyright (C) 2020 Alteryx, Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# 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 Class for SDK IO."""
from pathlib import Path
from typing import Any

import AlteryxPythonSDK as Sdk

from ayx_plugin_sdk.core.doc_utilities import inherit_docs
from ayx_plugin_sdk.core.io_base import IoBase


[docs]@inherit_docs class E1IO(IoBase): """Class wrapping all IO communication with Alteryx Designer.""" __slots__ = ["_engine", "_tool_id"] def __init__(self, engine: Sdk.AlteryxEngine, tool_id: int) -> None: self._engine = engine self._tool_id = tool_id
[docs] def error(self, error_msg: str) -> None: # noqa: D102 self._engine.output_message( self._tool_id, Sdk.EngineMessageType.error, str(error_msg) )
[docs] def warn(self, warn_msg: str) -> None: # noqa: D102 self._engine.output_message( self._tool_id, Sdk.EngineMessageType.warning, str(warn_msg) )
[docs] def info(self, info_msg: str) -> None: # noqa: D102 self._engine.output_message( self._tool_id, Sdk.EngineMessageType.info, str(info_msg) )
[docs] def translate_msg(self, msg: str, *args: Any) -> str: # noqa: D102 stringified_args = [str(arg) for arg in args] translated_msg: str = self._engine.xmsg(msg, *stringified_args) return translated_msg
[docs] def update_progress(self, percent: float) -> None: # noqa: D102 self._engine.output_tool_progress(self._tool_id, percent)
[docs] def create_temp_file( self, extension: str = "tmp", options: int = 0 ) -> Path: # noqa: D102 return Path(str(self._engine.create_temp_file_name(extension, options)))