Pure python 7-zip library
.. |logo| image:: logo.svg :width: 80pt :height: 80pt :target: https://pypi.org/project/py7zr
.. image:: https://readthedocs.org/projects/py7zr/badge/?version=latest :target: https://py7zr.readthedocs.io/en/latest/?badge=latest
.. image:: https://badge.fury.io/py/py7zr.svg :target: https://badge.fury.io/py/py7zr
.. image:: https://img.shields.io/pypi/dd/py7zr :target: https://pypi.org/project/py7zr
.. image:: https://img.shields.io/conda/vn/conda-forge/py7zr :target: https://anaconda.org/conda-forge/py7zr
.. image:: https://github.com/miurahr/py7zr/workflows/Run%20Tox%20tests/badge.svg :target: https://github.com/miurahr/py7zr/actions
.. image:: https://dev.azure.com/miurahr/github/_apis/build/status/miurahr.py7zr?branchName=master :target: https://dev.azure.com/miurahr/github/_build/latest?definitionId=14&branchName=master
.. image:: https://coveralls.io/repos/github/miurahr/py7zr/badge.svg?branch=master :target: https://coveralls.io/github/miurahr/py7zr?branch=master
.. image:: https://img.shields.io/pypi/l/py7zr :target: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
.. image:: https://snyk.io/advisor/python/py7zr/badge.svg :target: https://snyk.io/advisor/python/py7zr :alt: py7zr
py7zr is a library and utility to support 7zip archive compression, decompression, encryption and decryption written by Python programming language.
Version 0.20.0, 0.19.0, 0.18.10 or before has a vulnerability for path traversal
_ attack.
Details are on "CVE-2022-44900: path traversal vulnerability in py7zr" disclose article
_ .
Affected versions are vulnerable to Directory Traversal due to insufficient checks in the 'py7zr.py' and 'helpers.py' files
You are recommend to update immediately to version 0.20.2 or later, 0.19.2 or 0.18.12
.. _vulnerability for path traversal
: https://security.snyk.io/vuln/SNYK-PYTHON-PY7ZR-3092461
I realy appreciate Mr. Matteo Cosentino for notification and coorporation on security improvement.
.. _disclose article
: https://lessonsec.com/cve/cve-2022-44900/
py7zr
supports algorithms and filters which lzma module
_ and liblzma
_ support,
and supports BZip2 and Deflate that are implemented in python core libraries,
It also supports ZStandard, Brotli and PPMd with third party libraries.
py7zr
is also able to encrypt and decrypt data using 3rd party encryption library.
compress
crypt
Filters
.. note::
p7zip
implementation,
but not work with original 7-zip because the original does not implement the feature.py7zr
try checking symbolic links strictly and raise ValueError when bad link is requested,
but it does not guarantee to block all the bad cases.DEFLATE64
:sup:TM
that is a registered trademark of PKWARE, Inc.
lzma module
_ does not provide).You can install py7zr as usual other libraries using pip.
.. code-block:: shell
$ pip install py7zr
OR, alternatively using conda:
.. code-block:: shell
$ conda install -c conda-forge py7zr
User Guide
_ for latest version.
API Guide
_ for latest version.
Manual
_ for stable version.
Contributor guide
_ for one want to contribute the project.
7z file specification
_
.. _User Guide
: https://py7zr.readthedocs.io/en/latest/user_guide.html
.. _API Guide
: https://py7zr.readthedocs.io/en/latest/api.html
.. _Manual
: https://py7zr.readthedocs.io/en/stable/
.. _Contributor guide
: https://py7zr.readthedocs.io/en/latest/contribution.html
.. _7z file specification
: https://py7zr.readthedocs.io/en/latest/archive_format.html
You can run command script py7zr like as follows;
.. code-block:: shell
$ py7zr l test.7z
.. code-block:: shell
$ py7zr x test.7z
.. code-block:: shell
$ py7zr x -P test.7z
password?: ****
.. code-block:: shell
$ py7zr c target.7z test_dir
.. code-block:: shell
$ py7zr c -v 500k target.7z test_dir
.. code-block:: shell
$ py7zr t test.7z
.. code-block:: shell
$ py7zr a test.7z test_dir
.. code-block:: shell
$ py7zr i
.. code-block:: shell
$ py7zr --version
py7zr is a library which can use in your python application.
Here is a code snippet how to decompress some file in your application.
.. code-block:: python
import py7zr
archive = py7zr.SevenZipFile('sample.7z', mode='r')
archive.extractall(path="/tmp")
archive.close()
You can also use 'with' block because py7zr provide context manager(v0.6 and later).
.. code-block:: python
import py7zr
with py7zr.SevenZipFile('sample.7z', mode='r') as z:
z.extractall()
with py7zr.SevenZipFile('target.7z', 'w') as z:
z.writeall('./base_dir')
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.
.. code-block:: python
import py7zr
import re
filter_pattern = re.compile(r'<your/target/file_and_directories/regex/expression>')
with py7zr.SevenZipFile('archive.7z', 'r') as archive:
allfiles = archive.getnames()
selective_files = [f for f in allfiles if filter_pattern.match(f)]
archive.extract(targets=selective_files)
py7zr support an extraction of password protected archive.(v0.6 and later)
.. code-block:: python
import py7zr
with py7zr.SevenZipFile('encrypted.7z', mode='r', password='secret') as z:
z.extractall()
Here is a code snippet how to produce archive.
.. code-block:: python
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.
.. code-block:: python
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.
.. code-block:: python
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_filters) as archive:
archive.writeall('/path/to/base_dir', 'base')
py7zr also support shutil
interface.
.. code-block:: python
from py7zr import pack_7zarchive, 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')
py7zr
uses a python3 standard lzma module
_ for extraction and compression.
The standard lzma module uses liblzma
_ that support core compression algorithm of 7zip.
Minimum required version is Python 3.7.
py7zr
tested on Linux, macOS, Windows and Ubuntu aarch64.
It hopefully works on M1 Mac too.
Recommended versions are:
Following fixes are included in these versions, and it is not fixed on python3.6.
BPO-21872
_: LZMA library sometimes fails to decompress a filePyPy3-3090
_: lzma.LZMADecomporessor.decompress does not respect max_lengthPyPy3-3242
_: '_lzma_cffi' has no function named 'lzma_stream_encoder'Following improvements are included in CPython 3.10
BPO-41486
_: Faster bz2/lzma/zlib via new output buffering.. _lzma module
: https://docs.python.org/3/library/lzma.html
.. _liblzma
: https://tukaani.org/xz/
.. _BPO-21872
: https://bugs.python.org/issue21872
.. _BPO-41486
: https://bugs.python.org/issue41486
.. _PyPy3-3090
: https://foss.heptapod.net/pypy/pypy/-/issues/3090
.. _PyPy3-3242
: https://foss.heptapod.net/pypy/pypy/-/issues/3242
There are several dependencies to support algorithms and CLI expressions.
===================== ===============================
Package Purpose
===================== ===============================
PyCryptodomex
_ 7zAES encryption
PyZstd
_ ZStandard compression
PyPPMd
_ PPMd compression
Brotli
_ Brotli compression (CPython)
BrotliCFFI
_ Brotli compression (PyPy)
inflate64
_ Enhanced deflate compression
pybcj
_ BCJ filters
multivolumefile
_ Multi-volume archive read/write
texttable
_ CLI formatter
===================== ===============================
.. _Pycryptodomex
: https://www.pycryptodome.org/en/latest/index.html
.. _PyZstd
: https://pypi.org/project/pyzstd
.. _PyPPMd
: https://pypi.org/project/pyppmd
.. _Brotli
: https://pypi.org/project/brotli
.. _BrotliCFFI
: https://pypi.org/project/brotlicffi
.. _inflate64
: https://pypi.org/project/inflate64
.. _pybcj
: https://pypi.org/project/pybcj
.. _multivolumefile
: https://pypi.org/project/multivolumefile
.. _texttable
: https://pypi.org/project/texttable
You can find a compression and decompression benchmark results at Github issue and wiki page
py7zr works well, but slower than 7-zip
and p7zip
C/C++ implementation by several reasons.
When compression/decompression speed is important, it is recommended to use these
alternatives through subprocess.run
python interface.
py7zr consumes some memory to decompress and compress data. It requires about 300MiB - 700MiB free memory to work well at least.
aqtinstall
_ Another (unofficial) Qt (aqt) CLI Installer on multi-platforms... _aqtinstall: https://github.com/miurahr/aqtinstall .. _PreNLP: https://github.com/lyeoni/prenlp .. _mlox: https://github.com/mlox/mlox
Copyright (C) 2019-2022 Hiroshi Miura
pylzma Copyright (c) 2004-2015 by Joachim Bauch
7-Zip Copyright (C) 1999-2010 Igor Pavlov
LZMA SDK Copyright (C) 1999-2010 Igor Pavlov
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA