wasp_backup package

Submodules

wasp_backup.apps module

wasp_backup.archiver module

class wasp_backup.archiver.WArchiveIntegrityChecker(archive_path, logger, stop_event=None, io_read_rate=None)

Bases: wasp_backup.archiver.WBasicArchiveExtractor

check_archive()

check_details()

reader_chain()

class wasp_backup.archiver.WBasicArchiveCreator(archive_path, logger, stop_event=None, io_write_rate=None, compression_mode=None, cipher=None)

Bases: wasp_backup.io.WBasicArchiverIO, wasp_backup.core.WBackupMetaProvider

archive()

archiving_details()

cipher()

compression_mode()

file_object()

inside_filename()

io_write_rate()

meta()

write_archive(fo, archive)

write_chain()

class wasp_backup.archiver.WBasicArchiveExtractor(archive_path, logger, stop_event=None, io_read_rate=None)

Bases: wasp_backup.io.WBasicArchiverIO

io_read_rate()

open_file(file_name)

open_meta()

class wasp_backup.archiver.WBasicInsideTarArchiveCreator(archive_path, logger, compression_mode=None, cipher=None, stop_event=None, io_write_rate=None)

Bases: wasp_backup.archiver.WBasicArchiveCreator

write_archive(fo, archive)

wasp_backup.check module

class wasp_backup.check.WCheckBackupCommand(logger)

Bases: wasp_backup.command_common.WBackupCommand

checker()

wasp_backup.cipher module

class wasp_backup.cipher.WBackupCipher(cipher_name, password)

Bases: object

aes_cipher()

cipher_name()

meta()

salt()

wasp_backup.command_common module

class wasp_backup.command_common.WBackupCommand(logger)

Bases: wasp_general.command.enhanced.WEnhancedCommand

logger()

stop_event(value=None)

class wasp_backup.command_common.WCompressionArgumentHelper

Bases: wasp_general.command.enhanced.ArgumentCastingHelper

static cast_string(value)

class wasp_backup.command_common.WCreateBackupCommand(logger)

Bases: wasp_backup.command_common.WBackupCommand

exception UploadFailed

Bases: Exception

archiver()

set_archiver(value)

wasp_backup.command_common.cipher_name_validation(cipher_name)

wasp_backup.core module

class wasp_backup.core.WArchiverIOStatusProvider

Bases: object

status()

class wasp_backup.core.WBackupMeta

Bases: object

class Archive

Bases: object

class CompressionMode

Bases: enum.Enum

An enumeration.

bzip2 = 'bz2'

gzip = 'gz'

class MetaOptions

Bases: enum.Enum

An enumeration.

archived_files = 'archived_files'

archived_program = 'archived_program'

cipher_algorithm = 'cipher_algorithm'

compression_mode = 'compression_mode'

creation_time = 'creation_time'

hash_algorithm = 'hash_algorithm'

hash_value = 'hash_value'

inside_filename = 'inside_filename'

inside_tar = 'inside_tar'

io_write_rate = 'io_write_rate'

original_lv_uuid = 'original_lv_uuid'

pbkdf2_iterations_count = 'pbkdf2_iterations_count'

pbkdf2_prf = 'pbkdf2_prf'

pbkdf2_salt = 'pbkdf2_salt'

snapshot_used = 'snapshot_used'

uncompressed_archive_size = 'uncompressed_archive_size'

class BackupNotificationOptions

Bases: enum.Enum

An enumeration.

backup_duration = 'backup_duration'

copy_completion = 'copy_completion'

copy_duration = 'copy_duration'

copy_to = 'copy_to'

created_archive = 'created_archive'

total_archive_size = 'total_archive_size'

class LVMSnapshot

Bases: object

class RetentionNotificationOptions

Bases: enum.Enum

An enumeration.

kept_archives = 'kept_archives'

removed_archives = 'removed_archives'

retention_location = 'retention_location'

class wasp_backup.core.WBackupMetaProvider

Bases: object

classmethod encode_meta(meta, strict_cls=None)

meta()

wasp_backup.file_archiver module

class wasp_backup.file_archiver.WFileArchiveCreator(backup_source, archive_path, logger, stop_event=None, io_write_rate=None, compression_mode=None, cipher=None, buffer_size=8192)

Bases: wasp_backup.archiver.WBasicArchiveCreator

backup_source()

buffer_size()

meta()

write_archive(fo, archive)

wasp_backup.file_backup module

class wasp_backup.file_backup.WFileBackupCommand(logger)

Bases: wasp_backup.command_common.WCreateBackupCommand

class SnapshotUsage

Bases: enum.Enum

An enumeration.

auto = 'auto'

disabled = 'disabled'

forced = 'forced'

wasp_backup.inside_tar_archiver module

class wasp_backup.inside_tar_archiver.WInsideTarArchiveCreator(archive_path, logger, *backup_sources, compression_mode=None, cipher=None, stop_event=None, io_write_rate=None, abs_path=False)

Bases: wasp_backup.archiver.WBasicInsideTarArchiveCreator

abs_path()

archive()

backup_sources()

inside_filename()

last_file()

meta()

class wasp_backup.inside_tar_archiver.WLVMArchiveCreator(archive_path, logger, *backup_sources, compression_mode=None, sudo=False, cipher=None, stop_event=None, io_write_rate=None)

Bases: wasp_backup.inside_tar_archiver.WInsideTarArchiveCreator

archive(disable_snapshot=False, snapshot_force=False, snapshot_size=None, mount_directory=None, mount_fs=None, mount_options=None)

meta()

sudo()

wasp_backup.io module

class wasp_backup.io.WArchiverAESCipher(raw, cipher)

Bases: wasp_general.io.WAESWriter, wasp_backup.core.WBackupMetaProvider

meta()

class wasp_backup.io.WArchiverDataCounter(raw)

Bases: wasp_general.io.WThrottlingWriter, wasp_backup.core.WBackupMetaProvider

meta()

class wasp_backup.io.WArchiverHashCalculationWriter(raw)

Bases: wasp_general.io.WHashCalculationWriter, wasp_backup.core.WBackupMetaProvider

meta()

class wasp_backup.io.WArchiverStatus

Bases: object

meta()

status()

class wasp_backup.io.WArchiverThrottlingReader(raw, read_limit=None)

Bases: wasp_general.io.WThrottlingReader, wasp_backup.core.WArchiverIOStatusProvider

status()

class wasp_backup.io.WArchiverThrottlingWriter(raw, write_limit=None)

Bases: wasp_general.io.WThrottlingWriter, wasp_backup.core.WBackupMetaProvider, wasp_backup.core.WArchiverIOStatusProvider

meta()

status()

class wasp_backup.io.WArchiverWriterChain(last_io_obj, *links)

Bases: wasp_general.io.WWriterChain, wasp_backup.io.WArchiverStatus

class wasp_backup.io.WBasicArchiverIO(archive_path, logger, stop_event=None, io_rate=None)

Bases: object

archive_path()

io_rate()

logger()

stop_event(value=None)

class wasp_backup.io.WExtractorReaderChain(last_io_obj, *links)

Bases: wasp_general.io.WReaderChain, wasp_backup.io.WArchiverStatus

class wasp_backup.io.WMetaTarPatcher(archive_path, inside_archive_name, meta_provider, compression_mode=None)

Bases: wasp_backup.io.WTarPatcher

meta_provider()

classmethod process_meta(meta)

class wasp_backup.io.WTarPatcher(archive, inside_file_name, patch_header=True, patch_tail=False, compression_mode=None)

Bases: _io.BufferedWriter

classmethod align_size(size, chunk_size)

alignment_padding()

classmethod block_size(size)

close()

compression_mode()

data_written()

final_position()

inside_file_name()

inside_file_size()

original_archive()

classmethod padding(padding_size)

patch()

patch_header()

patch_tail()

classmethod record_size(size)

start_position()

classmethod tar_header(name, size=None)

classmethod tar_info(name, size=None)

write(b)

wasp_backup.notify module

wasp_backup.notify.notify(notify_data, notify_app, encode_strict_cls=None)

wasp_backup.popen_archiver module

class wasp_backup.popen_archiver.WPopenArchiveCreator(backup_source, archive_path, logger, stop_event=None, io_write_rate=None, compression_mode=None, cipher=None, buffer_size=8192)

Bases: wasp_backup.file_archiver.WFileArchiveCreator

meta()

write_archive(fo, archive)

wasp_backup.program_backup module

class wasp_backup.program_backup.WProgramBackupCommand(logger)

Bases: wasp_backup.command_common.WCreateBackupCommand

wasp_backup.retention module

class wasp_backup.retention.WRetentionBackupCommand(logger)

Bases: wasp_backup.command_common.WBackupCommand

class AgeHelper

Bases: enum.Enum

An enumeration.

archive_meta = 'archive-meta'

creation_time = 'creation-time'

modification_time = 'modification-time'

name_parsing = 'name-parsing'

class PeriodKeepFilter(from_dt, tz, period_value, period_modifier, archive_number)

Bases: object

wasp_backup.version module

wasp_backup.version.package_version()

Module contents