BackupSpace¶

class backpy.core.space.BackupSpace(name, unique_id, space_type, compression_algorithm, compression_level, default_include, default_exclude, remote, max_backups=-1, max_size=-1, auto_deletion=False, auto_deletion_rule='oldest')¶

Bases: object

Methods Summary

`clear`([verbosity_level])
`create_backup`([comment, include, exclude, ...])
`delete`([verbosity_level])
`get_as_child_class`()
`get_auto_deletion_rule`()
`get_backup_dir`()
`get_backup_spaces`()
`get_backups`([sort_by, check_hash, ...])
`get_compression_algorithm`()
`get_compression_level`()
`get_config`()
`get_default_exclude`()
`get_default_include`()
`get_disk_usage`([verbosity_level])
`get_info_table`([verbosity_level])
`get_max_backups`()
`get_max_size`()
`get_name`()
`get_remote`()
`get_remote_path`()
`get_type`()
`get_uuid`()
`is_auto_deletion_active`()
`is_backup_limit_reached`([post_creation])
`is_disk_limit_reached`([verbosity_level])
`load_by_name`(name)
`load_by_uuid`(unique_id)
`new`(name, space_type[, ...])
`perform_auto_deletion`([verbosity_level])
`restore_backup`(unique_id, incremental[, ...])
`update_config`()

Methods Documentation

Parameters:

name (str)
unique_id (uuid.UUID)
space_type (BackupSpaceType)
compression_algorithm (compression.CompressionAlgorithm)
compression_level (int)
default_include (list[str])
default_exclude (list[str])
remote (Remote | None)
max_backups (int)
max_size (int)
auto_deletion (bool)
auto_deletion_rule (str)

clear(verbosity_level=1)¶

Parameters:: verbosity_level (int)

create_backup(comment='', include=None, exclude=None, lock=False, location='all', verbosity_level=1)¶

Parameters:

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

Return type:

None

delete(verbosity_level=1)¶

Parameters:: verbosity_level (int)

get_as_child_class()¶

Return type:: BackupSpace

get_auto_deletion_rule()¶

Return type:: str

get_backup_dir()¶

Return type:: Path

classmethod get_backup_spaces()¶

Return type:: list[BackupSpace]

get_backups(sort_by=None, check_hash=True, unlocked_only=False, verbosity_level=1)¶

Parameters:

sort_by (str | None)
check_hash (bool)
unlocked_only (bool)
verbosity_level (int)

Return type:

list[Backup]

get_compression_algorithm()¶

Return type:: CompressionAlgorithm

get_compression_level()¶

Return type:: int

get_config()¶

Return type:: dict

get_default_exclude()¶

Return type:: list[str]

get_default_include()¶

Return type:: list[str]

get_disk_usage(verbosity_level=1)¶

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

get_info_table(verbosity_level=1)¶

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

get_max_backups()¶

Return type:: int

get_max_size()¶

Return type:: int

get_name()¶

Return type:: str

get_remote()¶

Return type:: Remote

get_remote_path()¶

Return type:: str | None

get_type()¶

Return type:: BackupSpaceType

get_uuid()¶

Return type:: UUID

is_auto_deletion_active()¶

Return type:: bool

is_backup_limit_reached(post_creation=False)¶

Parameters:: post_creation (bool)
Return type:: bool

is_disk_limit_reached(verbosity_level=1)¶

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

classmethod load_by_name(name)¶

Parameters:: name (str)
Return type:: BackupSpace

classmethod load_by_uuid(unique_id)¶

Parameters:: unique_id (str)
Return type:: BackupSpace

classmethod new(name, space_type, compression_algorithm='zip', compression_level=6, default_include=None, default_exclude=None, max_backups=-1, max_size=-1, auto_deletion=False, auto_deletion_rule=False, remote=None, verbosity_level=1)¶

Parameters:

name (str)
space_type (BackupSpaceType)
compression_algorithm (str)
compression_level (int)
default_include (list[str] | None)
default_exclude (list[str] | None)
max_backups (int)
max_size (int)
auto_deletion (bool)
auto_deletion_rule (str)
remote (Remote)
verbosity_level (int)

Return type:

BackupSpace

perform_auto_deletion(verbosity_level=1)¶

Parameters:: verbosity_level (int)

restore_backup(unique_id, incremental, source='local', force=False, verbosity_level=1)¶

Parameters:

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

Return type:

None

update_config()¶