# Copyright 2021 Agnostiq Inc.
# This file is part of Covalent.
# Licensed under the GNU Affero General Public License 3.0 (the "License").
# A copy of the License may be obtained with this software package or at
# Use of this file is prohibited except in compliance with the License. Any
# modifications or derivative works of this file must retain this copyright
# notice, and modified files must contain a notice indicating that they have
# been altered from the originals.
# Covalent is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.
# Relief from the License may be granted by purchasing a commercial license.
from abc import ABC, abstractmethod
from pathlib import Path
from ..enums import FtCallDepReturnValue
from ..file import File
Base FileTransferStrategy class that defines the interface for file transfer strategies exposing common methods for performing copy, download, and upload operations.
# move file (from) source (to) destination
def cp(self, from_file: File, to_file: File) -> None:
# download here implies 'from' is a remote source
def download(self, from_file: File, to_file: File) -> File:
# upload here implies 'to' is a remote source
def upload(self, from_file: File, to_file: File) -> None:
return_value_type: FtCallDepReturnValue = FtCallDepReturnValue.FROM_TO,
) -> None:
# Create any necessary temp files needed for file transfer operations
from_filepath = from_file.filepath
to_filepath = to_file.filepath
is_from_temp_file = from_file.is_temp_file
is_to_temp_file = to_file.is_temp_file
# return value to be injected into kwargs of electron decorated fn as 'files'
if return_value_type == FtCallDepReturnValue.TO:
return_value = to_filepath
elif return_value_type == FtCallDepReturnValue.FROM:
return_value = from_filepath
return_value = (from_filepath, to_filepath)
from_path_obj = Path(from_filepath)
to_path_obj = Path(to_filepath)