Source code for ayx_plugin_sdk.providers.file_provider.iox

# 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.
"""File Provider."""
from pathlib import Path
from typing import Any

from ayx_plugin_sdk.core.io_base import IoBase


[docs]class IO(IoBase): """Simple tool interface that will be used with Designer.""" def __init__(self) -> None: """Instantiate the interface."""
[docs] def error(self, error_msg: str) -> None: """Display an error in the Results window."""
[docs] def warn(self, warn_msg: str) -> None: """Display a warning in the Results window."""
[docs] def info(self, info_msg: str) -> None: """Display information in the Results window."""
[docs] def translate_msg(self, msg: str, *args: Any) -> str: """Translate a message.""" raise NotImplementedError()
[docs] def update_progress(self, percent: float) -> None: """Update tool progress."""
[docs] def create_temp_file(self, extension: str = "tmp", options: int = 0) -> Path: """Create a temporary file path.""" return Path(extension)
[docs] def decrypt_password(self, password: str) -> str: # noqa: D102 """Decrypt a password; will append '_decrypted' to the supplied password.""" return password + "_decrypted"