Remote

class backpy.core.remote.Remote(name, unique_id, protocol, hostname, username, token, ssh_key, use_system_keys, connection_timeout, root_dir, sha256_cmd)

Bases: object

Methods Summary

__call__(context_verbosity, *args, **kwargs)

Call self as a function.

connect([verbosity_level])

delete(delete_files[, verbosity_level])

disconnect([verbosity_level])

download(source, target[, check_hash, ...])

exists(target[, sftp_client, close_afterwards])

get_connection_timeout()

get_file_size(target[, sftp_client, ...])

get_hash(target[, verbosity_level])

get_hostname()

get_info_table()

get_name()

get_protocol()

get_relative_to_root(path)

get_remotes()

get_root_dir()

get_sha256_cmd()

get_ssh_key()

get_username()

get_uuid()

is_connected()

is_dir(target[, sftp_client, close_afterwards])

load_by_name(name)

load_by_uuid(unique_id)

mkdir(target[, parents, close_afterwards, ...])

new(name, protocol, hostname, username[, ...])

remove(target[, sftp_client, ...])

should_use_system_keys()

test_connection([verbosity_level])

update_config()

upload(source, target[, check_hash, ...])

Methods Documentation

Parameters:

  • name (str)

  • unique_id (UUID)

  • protocol (Protocol)

  • hostname (str)

  • username (str)

  • token (str | None)

  • ssh_key (Path | None)

  • use_system_keys (bool)

  • connection_timeout (int | None)

  • root_dir (str)

  • sha256_cmd (str)

__call__(context_verbosity, *args, **kwargs)

Call self as a function.

Parameters:

context_verbosity (int)

connect(verbosity_level=1)
Parameters:

verbosity_level (int)

Return type:

None

delete(delete_files, verbosity_level=1)
Parameters:

  • delete_files (bool)

  • verbosity_level (int)

disconnect(verbosity_level=1)
Parameters:

verbosity_level (int)

Return type:

None

download(source, target, check_hash=True, retry_on_hash_missmatch=True, max_retries=3, verbosity_level=1)
Parameters:

  • source (str)

  • target (Path | str)

  • check_hash (bool)

  • retry_on_hash_missmatch (bool)

  • max_retries (int)

  • verbosity_level (int)

Return type:

None

exists(target, sftp_client=None, close_afterwards=True)
Parameters:

  • target (str)

  • sftp_client (SFTPClient | None)

  • close_afterwards (bool)

Return type:

bool

get_connection_timeout()
Return type:

int | None

get_file_size(target, sftp_client=None, verbosity_level=1)
Parameters:

  • target (str)

  • sftp_client (SFTPClient | None)

  • verbosity_level (int)

Return type:

int

get_hash(target, verbosity_level=1)
Parameters:

  • target (str)

  • verbosity_level (int)

Return type:

str

get_hostname()
Return type:

str

get_info_table()
Return type:

Table

get_name()
Return type:

str

get_protocol()
Return type:

Protocol

get_relative_to_root(path)
Parameters:

path (Path | str)

Return type:

str

classmethod get_remotes()
get_root_dir()
Return type:

str

get_sha256_cmd()
Return type:

str

get_ssh_key()
Return type:

Path

get_username()
Return type:

str

get_uuid()
Return type:

UUID

is_connected()
Return type:

bool

is_dir(target, sftp_client=None, close_afterwards=True)
Parameters:

  • target (str)

  • sftp_client (SFTPClient | None)

  • close_afterwards (bool)

Return type:

bool

classmethod load_by_name(name)
Parameters:

name (str)

Return type:

Remote

classmethod load_by_uuid(unique_id)
Parameters:

unique_id (str)

Return type:

Remote

mkdir(target, parents=False, close_afterwards=True, client=None, verbosity_level=1)
Parameters:

  • target (str)

  • parents (bool)

  • close_afterwards (bool)

  • client (SFTPClient | SCPClient | None)

  • verbosity_level (int)

Return type:

None

classmethod new(name, protocol, hostname, username, password=None, ssh_key=None, use_system_keys=False, connection_timeout=None, root_dir='.backpy', sha256_cmd='sha256sum', verbosity_level=1, test_connection=True)
Parameters:

  • name (str)

  • protocol (str)

  • hostname (str)

  • username (str)

  • password (str | None)

  • ssh_key (str | None)

  • use_system_keys (bool)

  • connection_timeout (int | None)

  • root_dir (str)

  • sha256_cmd (str)

  • verbosity_level (int)

  • test_connection (bool)

Return type:

Remote

remove(target, sftp_client=None, close_afterwards=True, verbosity_level=1)
Parameters:

  • target (str)

  • sftp_client (SFTPClient | None)

  • close_afterwards (bool)

  • verbosity_level (int)

Return type:

None

should_use_system_keys()
Return type:

bool

test_connection(verbosity_level=1)
Parameters:

verbosity_level (int)

Return type:

None

update_config()
upload(source, target, check_hash=True, retry_on_hash_missmatch=True, max_retries=3, verbosity_level=1)
Parameters:

  • source (Path | str)

  • target (str)

  • check_hash (bool)

  • retry_on_hash_missmatch (bool)

  • max_retries (int)

  • verbosity_level (int)

Return type:

None