compress Method

Creates the compressed bzip2 archive.

Syntax

def compress() -> None: ...

Remarks

Invoking compress creates the archive specified by archive_file. When the method is called, the file specified by file_decompressed_name will be opened, and the file specified by archive_file will contain the compressed output.

As the data is compressed the on_progress event will be fired at regular intervals. This event may be used to stream out the bzip2 file, or to display a progress bar to the user.