Python 3 py7zr Script to Build 7Zip Compression & Decompression Files From Directory Full Project For Beginners



pip install py7zr




You can install py7zr as usual other libraries using pip.

$ pip install py7zr


User manuals

Developer guide

CLI Usage

You can run command script py7zr like as follows;

  • List archive contents
$ py7zr l test.7z
  • Extract archive
$ py7zr x test.7z
  • Extract archive with password
$ py7zr x -P test.7z
  password?: ****
  • Create and compress to archive
$ py7zr c target.7z test_dir
  • Create multi-volume archive
$ py7zr c -v 500k target.7z test_dir
  • Test archive
$ py7zr t test.7z
  • Append files to archive
$ py7zr a test.7z test_dir
  • Show information
$ py7zr i
  • Show version
$ py7zr --version

SevenZipFile Class Usage

py7zr is a library which can use in your python application.


Here is a code snippet how to decompress some file in your application.

import py7zr

archive = py7zr.SevenZipFile('sample.7z', mode='r')

You can also use ‘with’ block because py7zr provide context manager(v0.6 and later).

import py7zr

with py7zr.SevenZipFile('sample.7z', mode='r') as z:

with py7zr.SevenZipFile('target.7z', 'w') as z:

py7zr also supports extraction of single or selected files by ‘extract(targets=[‘file path’])’. Note: if you specify only a file but not a parent directory, it will fail.

import py7zr
import re

filter_pattern = re.compile(r'<your/target/file_and_directories/regex/expression>')
with SevenZipFile('archive.7z', 'r') as archive:
    allfiles = archive.getnames()
    selective_files = [f if filter_pattern.match(f) for f in allfiles]

py7zr support an extraction of password protected archive.(v0.6 and later)

import py7zr

with py7zr.SevenZipFile('encrypted.7z', mode='r', password='secret') as z:


Here is a code snippet how to produce archive.

import py7zr

with py7zr.SevenZipFile('target.7z', 'w') as archive:
    archive.writeall('/path/to/base_dir', 'base')

To create encrypted archive, please pass a password.

import py7zr

with py7zr.SevenZipFile('target.7z', 'w', password='secret') as archive:
    archive.writeall('/path/to/base_dir', 'base')

To create archive with algorithms such as zstandard, you can call with custom filter.

import py7zr

my_filters = [{"id": py7zr.FILTER_ZSTD}]
another_filters = [{"id": py7zr.FILTER_ARM}, {"id": py7zr.FILTER_LZMA2, "preset": 7}]
with py7zr.SevenZipFile('target.7z', 'w', filters=my_filter) as archive:
    archive.writeall('/path/to/base_dir', 'base')

shutil helper

py7zr also support shutil interface.

from py7zr import pack_7zarchvie, unpack_7zarchive
import shutil

# register file format at first.
shutil.register_archive_format('7zip', pack_7zarchive, description='7zip archive')
shutil.register_unpack_format('7zip', ['.7z'], unpack_7zarchive)

# extraction
shutil.unpack_archive('test.7z', '/tmp')

# compression
shutil.make_archive('target', '7zip', 'src')

Leave a Reply