Extract archive callback.

[MiyamuraMiyako]

Is your feature request related to a problem? Please describe.
I need complute extract progress and process every file when one file extracted.

Describe the solution you'd like
Add callback param in extractall function.

Describe alternatives you've considered
None

Additional context
None

[MiyamuraMiyako]

Yes, I think just report IsDirectory, FileName and PercentDone.

[MiyamuraMiyako]

All extract thread concurrently submit maybe cause issue, I think need add synchronize lock, but maybe cause extract efficiency.

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[miurahr]

@MiyamuraMiyako now #130 implement a primitive progress callback mechanism.
Could you try it? You can see how to use it on test_basic.py:446 test_extract_callback test case.

[miurahr]

Current API does not provide percentage, but provide filename and extracted bytes.
User can get list of filename, its property and file size from list() method, then API user can calculate a percentage, display whether it is a directory.

[MiyamuraMiyako]

I tested this version, It can achieve I need.

[miurahr]

Now you can find a CLI option --verbose at #130 which produce such as

$ python -m py7zr x --verbose tests/data/test_1.7z 
- scripts                                                                  (0%)
- scripts/py7zr                                                           (15%)
- setup.cfg                                                               (23%)
- setup.py                                                               (100%)

You can find a sample code in py7zr/cli.py

class CliExtractCallback(py7zr.callbacks.ExtractCallback):

    def __init__(self, total_bytes, ofd=sys.stdout):
        self.ofd = ofd
        self.archive_total = total_bytes
        self.total_bytes = 0
        self.columns, _ = shutil.get_terminal_size(fallback=(80, 24))
        self.pwidth = 0

    def report_start(self, processing_file_path, processing_bytes):
        self.ofd.write('- {}'.format(processing_file_path))
        self.pwidth += len(processing_file_path) + 2

    def report_end(self, processing_file_path, wrote_bytes):
        self.total_bytes += int(wrote_bytes)
        plest = self.columns - self.pwidth
        progress = self.total_bytes / self.archive_total
        msg = '({:.0%})\n'.format(progress)
        if plest - len(msg) > 0:
            self.ofd.write(msg.rjust(plest))
        else:
            self.ofd.write(msg)
        self.pwidth = 0


if __name__ == "__main__":
    with py7zr.SevenZipFile('target.7z', 'r') as a:
        archive_info = a.archiveinfo()
        cb = CliExtractCallback(total_bytes=archive_info.uncompressed)
        a.extractall(callback=cb)

[miurahr]

v0.7.0b3 released with callback.

[gmankab]

hello

please help me add file to archive, and printing callback in percents

[miurahr]

@gmankab please raise another ticket to request callback feature for archive/write functions.