Backup¶

class backpy.core.backup.Backup(path, backup_space, unique_id, sha256sum, comment, created_at, remote, exclude=None, include=None, locked=False)¶

Bases: object

Methods Summary

`calculate_hash`()
`check_hash`([remote, verbosity_level])
`delete`([verbosity_level])
`get_comment`()
`get_config`()
`get_created_at`()
`get_exclude`()
`get_file_size`([verbosity_level])
`get_hash`()
`get_include`()
`get_info_table`([check_hash, verbosity_level])
`get_path`()
`get_remote`()
`get_remote_archive_path`()
`get_remote_config_path`()
`get_uuid`()
`has_local_archive`()
`has_remote_archive`()
`is_full_backup`()
`is_locked`()
`load_by_uuid`(backup_space, unique_id[, ...])
`lock`([verbosity_level])
`new`(source_path, backup_space[, comment, ...])
`restore`(incremental, source, force[, ...])
`unlock`([verbosity_level])
`update_config`([verbosity_level])

Methods Documentation

Parameters:

path (Path | None)
backup_space (BackupSpace)
unique_id (uuid.UUID)
sha256sum (str)
comment (str)
created_at (TimeObject)
remote (Remote | None)
exclude (list[str] | None)
include (list[str] | None)
locked (bool)

calculate_hash()¶

Return type:: str

check_hash(remote=False, verbosity_level=1)¶

Parameters:: verbosity_level (int)
Return type:: bool

delete(verbosity_level=1)¶

Parameters:: verbosity_level (int)
Return type:: None

get_comment()¶

Return type:: str

get_config()¶

Return type:: dict

get_created_at()¶

Return type:: TimeObject

get_exclude()¶

Return type:: list[str]

get_file_size(verbosity_level=1)¶

Parameters:: verbosity_level (int)
Return type:: int

get_hash()¶

Return type:: str

get_include()¶

Return type:: list[str]

get_info_table(check_hash=False, verbosity_level=1)¶

Parameters:

check_hash (bool)
verbosity_level (int)

Return type:

Table

get_path()¶

Return type:: Path | None

get_remote()¶

Return type:: Remote

get_remote_archive_path()¶

Return type:: str

get_remote_config_path()¶

Return type:: str

get_uuid()¶

Return type:: UUID

has_local_archive()¶

Return type:: bool

has_remote_archive()¶

Return type:: bool

is_full_backup()¶

Return type:: bool

is_locked()¶

Return type:: bool

classmethod load_by_uuid(backup_space, unique_id, check_hash=True, fail_invalid=False, verbosity_level=1)¶

Parameters:

backup_space (BackupSpace)
unique_id (str)
check_hash (bool)
fail_invalid (bool)
verbosity_level (int)

lock(verbosity_level=1)¶

Parameters:: verbosity_level (int)

classmethod new(source_path, backup_space, comment='', include=None, exclude=None, lock=False, location='all', verbosity_level=1)¶

Parameters:

source_path (Path)
backup_space (BackupSpace)
comment (str)
include (list[str] | None)
exclude (list[str] | None)
lock (bool)
location (str)
verbosity_level (int)

restore(incremental, source, force, verbosity_level=1)¶

Parameters:

incremental (bool)
source (str)
force (bool)
verbosity_level (int)

Return type:

None

unlock(verbosity_level=1)¶

Parameters:: verbosity_level (int)

update_config(verbosity_level=1)¶

Parameters:: verbosity_level (int)