File Transfer
File class to store components of provided URI including scheme (s3://, file://, ect.) determine if the file is remote, and acts a facade to facilitate filesystem operations.
filepath
File path corresponding to the file.
is_remote
Flag determining if file is remote (override). Default is resolved automatically from file scheme.
is_dir
Flag determining if file is a directory (override). Default is determined if file uri contains trailing slash.
include_folder
Flag that determines if the folder should be included in the file transfer, if False only contents of folder are transfered.
Folder class to store components of provided URI including scheme (s3://, file://, ect.), determine if the file is remote, and act as facade to facilitate filesystem operations. Folder is a child of the File class which sets is_dir flag to True.
include_folder
Flag that determines if the folder should be included in the file transfer, if False only contents of folder are transfered.
FileTransfer object class that takes two File objects or filepaths (from, to) and a File Transfer Strategy to perform remote or local file transfer operations.
from_file
Filepath or File object corresponding to the source file.
to_file
Filepath or File object corresponding to the destination file.
order
Order (enum) to execute the file transfer before (Order.BEFORE) or after (Order.AFTER) electron execution.
strategy
Optional File Transfer Strategy to perform file operations - default will be resolved from provided file schemes.
Factory for creating a FileTransfer instance where from_filepath is implicitly created as a remote File Object, and the order (Order.BEFORE) is set so that this file transfer will occur prior to electron execution.
Parameters
from_filepath (str) – File path corresponding to remote file (source).
to_filepath (Optional[str]) – File path corresponding to local file (destination)
strategy (Optional[FileTransferStrategy]) – Optional File Transfer Strategy to perform file operations - default will be resolved from provided file schemes.
order (Order) – Order (enum) to execute the file transfer before (Order.BEFORE) or after (Order.AFTER) electron execution - default is BEFORE
Return Type
Returns
FileTransfer instance with implicit Order.BEFORE enum set and from (source) file marked as remote
Factory for creating a FileTransfer instance where to_filepath is implicitly created as a remote File Object, and the order (Order.AFTER) is set so that this file transfer will occur post electron execution.
Parameters
from_filepath (str) – File path corresponding to remote file (source).
to_filepath (Optional[str]) – File path corresponding to local file (destination)
strategy (Optional[FileTransferStrategy]) – Optional File Transfer Strategy to perform file operations - default will be resolved from provided file schemes.
order (Order) – Order (enum) to execute the file transfer before (Order.BEFORE) or after (Order.AFTER) electron execution - default is BEFORE
Return Type
Returns
FileTransfer instance with implicit Order.AFTER enum set and to (destination) file marked as remote