Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 1.8.0 instead.
Reason given by maintainers: Does not work correctly with concatenated gzips

python-isal

Faster zlib and gzip compatible compression and decompression by providing Python bindings for the ISA-L library.

This package provides Python bindings for the ISA-L library. The Intel(R) Intelligent Storage Acceleration Library (ISA-L) implements several key algorithms in assembly language. This includes a variety of functions to provide zlib/gzip-compatible compression.

python-isal provides the bindings by offering an isal_zlib and igzip module which are usable as drop-in replacements for the zlib and gzip modules from the stdlib (with some minor exceptions, see below).

Usage

Python-isal has faster versions of the stdlib’s zlib and gzip module these are called isal_zlib and igzip respectively.

They can be imported as follows

from isal import isal_zlib
from isal import igzip

isal_zlib and igzip are meant to be used as drop in replacements so their api and functions are the same as the stdlib’s modules. Except where ISA-L does not support the same calls as zlib (See differences below).

A full API documentation can be found on our readthedocs page.

python -m isal.igzip implements a simple gzip-like command line application (just like python -m gzip).

Installation

Installation with pip

pip install isal

Installation is supported on Linux, MacOS and Windows. On x86-64 (amd64) platforms wheels are provided, so installation should be almost instantaneous. The installation will include a staticallly linked version of ISA-L. If a wheel is not provided for your system the installation will build ISA-L first in a temporary directory. Please check the ISA-L homepage for the build requirements.

The latest development version of python-isal can be installed with:

pip install git+https://github.com/rhpvorderman/python-isal.git

This requires having the build requirements installed. If you wish to link dynamically against a version of libisal installed on your system use:

PYTHON_ISAL_LINK_DYNAMIC=true pip install isal --no-binary isal

ISA-L is available in numerous Linux distro’s as well as on conda via the conda-forge channel. Checkout the ports documentation on the ISA-L project wiki to find out how to install it. It is important that the development headers are also installed.

On Debian and Ubuntu the ISA-L libraries (including the development headers) can be installed with:

sudo apt install libisal-dev

Installation via conda

Python-isal can be installed via conda, for example using the miniconda installer with a properly setup conda-forge channel. When used with bioinformatics tools setting up bioconda provides a clear set of installation instructions for conda.

python-isal is available on conda-forge and can be installed with:

conda install python-isal

This will automatically install the ISA-L library dependency as well, since it is available on conda-forge.

Differences with zlib and gzip modules

  • Compression level 0 in zlib and gzip means no compression, while in isal_zlib and igzip this is the lowest compression level. This is a design choice that was inherited from the ISA-L library.

  • Compression levels range from 0 to 3, not 1 to 9. isal_zlib.Z_DEFAULT_COMPRESSION has been aliased to isal_zlib.ISAL_DEFAULT_COMPRESSION (2).

  • isal_zlib only supports NO_FLUSH, SYNC_FLUSH, FULL_FLUSH and FINISH_FLUSH. Other flush modes are not supported and will raise errors.

  • zlib.Z_DEFAULT_STRATEGY, zlib.Z_RLE etc. are exposed as isal_zlib.Z_DEFAULT_STRATEGY, isal_zlib.Z_RLE etc. for compatibility reasons. However, isal_zlib only supports a default strategy and will give warnings when other strategies are used.

  • zlib supports different memory levels from 1 to 9 (with 8 default). isal_zlib supports memory levels smallest, small, medium, large and largest. These have been mapped to levels 1, 2-3, 4-6, 7-8 and 9. So isal_zlib can be used with zlib compatible memory levels.

  • isal_zlib methods have a data argument which is positional only. In isal_zlib this is not enforced and it can also called as keyword argument. This is due to implementing isal_zlib in cython and maintaining backwards compatibility with python 3.6.

  • igzip.open returns a class IGzipFile instead of GzipFile. Since the compression levels are not compatible, a difference in naming was chosen to reflect this. igzip.GzipFile does exist as an alias of igzip.IGzipFile for compatibility reasons.

Contributing

Please make a PR or issue if you feel anything can be improved. Bug reports are also very welcome. Please report them on the github issue tracker.

Metadata

Release files for isal 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for isal 0.7.0
File Size Uploaded Provenance
isal-0.7.0.tar.gz 671.4 kB Without provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for isal 0.7.0
File
isal-0.7.0-cp39-cp39-win_amd64.whl CPython 3.9 CPython 3.9 Windows x86-64 Details
isal-0.7.0-cp39-cp39-manylinux2014_x86_64.whl CPython 3.9 CPython 3.9 Linux glibc 2.17+ x86-64 Details
isal-0.7.0-cp39-cp39-macosx_10_9_x86_64.whl CPython 3.9 CPython 3.9 macOS 10.9+ x86-64 Details
isal-0.7.0-cp38-cp38-win_amd64.whl CPython 3.8 CPython 3.8 Windows x86-64 Details
isal-0.7.0-cp38-cp38-manylinux2014_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.17+ x86-64 Details
isal-0.7.0-cp38-cp38-macosx_10_9_x86_64.whl CPython 3.8 CPython 3.8 macOS 10.9+ x86-64 Details
isal-0.7.0-cp37-cp37m-win_amd64.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-64 Details
isal-0.7.0-cp37-cp37m-manylinux2014_x86_64.whl CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.17+ x86-64 Details
isal-0.7.0-cp37-cp37m-macosx_10_9_x86_64.whl CPython 3.7 CPython 3.7 pymalloc macOS 10.9+ x86-64 Details
isal-0.7.0-cp36-cp36m-win_amd64.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-64 Details
isal-0.7.0-cp36-cp36m-manylinux2014_x86_64.whl CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.17+ x86-64 Details
isal-0.7.0-cp36-cp36m-macosx_10_9_x86_64.whl CPython 3.6 CPython 3.6 pymalloc macOS 10.9+ x86-64 Details

Total release size: 3.8 MB

Release files / isal-0.7.0.tar.gz

Download URL isal-0.7.0.tar.gz
Size 671.4 kB
Tags Source
SHA-256 checksum
How to use checksums
53305ae3c4a54a658312de1fde9848074e65d45f1cb93988ac77b2986dd577df
BLAKE2b-256 checksum
How to use checksums
445042fa097c3929d494b930e75ad0f5679a79d9fdce776eea021b8c9c333c8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp39-cp39-win_amd64.whl

Download URL isal-0.7.0-cp39-cp39-win_amd64.whl
Size 156.5 kB
Tags CPython 3.9 Windows x86-64
SHA-256 checksum
How to use checksums
5393e4c05ff4417939cc5807b51a3863f0382f9d3b9377fe330a985be536e167
BLAKE2b-256 checksum
How to use checksums
375026a4f68251d48382d513ed1e1f7319c61e3c90d2779e312c39fd37a40c10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp39-cp39-manylinux2014_x86_64.whl

Download URL isal-0.7.0-cp39-cp39-manylinux2014_x86_64.whl
Size 429.8 kB
Tags CPython 3.9 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
9647cde0d8cb95020fd8746d1867f588ead876490fcc51961ea83a91807ab862
BLAKE2b-256 checksum
How to use checksums
bdb8f38b076df87f79ea097fd26d560a3046fc1ea06d905264a025e8130bc731
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp39-cp39-macosx_10_9_x86_64.whl

Download URL isal-0.7.0-cp39-cp39-macosx_10_9_x86_64.whl
Size 198.1 kB
Tags CPython 3.9 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
954f5767ab3019e0edc973dd44983ce2f79936490df1490edd0f502dc974f801
BLAKE2b-256 checksum
How to use checksums
559fe2e985532c23aef466dab94c1b42968c2439dddd989b162117a01fd7c63c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp38-cp38-win_amd64.whl

Download URL isal-0.7.0-cp38-cp38-win_amd64.whl
Size 156.6 kB
Tags CPython 3.8 Windows x86-64
SHA-256 checksum
How to use checksums
4dbfbaaff90f8c2f2ec2dc01b34b332ee6d01a4c972f5b8a3a9c1e5581093c07
BLAKE2b-256 checksum
How to use checksums
a84d454f520ab86f56475b3169749ff1406052dc91aa843897b710d5bfb097ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp38-cp38-manylinux2014_x86_64.whl

Download URL isal-0.7.0-cp38-cp38-manylinux2014_x86_64.whl
Size 443.1 kB
Tags CPython 3.8 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
afe472925f5f0b1a011baf84a452a33155ae1de3b17884c5280cf80a550595df
BLAKE2b-256 checksum
How to use checksums
8814bd5b6153431141529ae9c630af0916f88c175b71b739ef3ddd5d81c0224a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp38-cp38-macosx_10_9_x86_64.whl

Download URL isal-0.7.0-cp38-cp38-macosx_10_9_x86_64.whl
Size 196.4 kB
Tags CPython 3.8 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
01c8733a00e157ba956372aaefd02045de055567b017706ae1a0db81453edfdb
BLAKE2b-256 checksum
How to use checksums
ffb0e826a6003114b8d18914f1885785f14465715eac7ef435fb6788eb8dfeb2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp37-cp37m-win_amd64.whl

Download URL isal-0.7.0-cp37-cp37m-win_amd64.whl
Size 155.5 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
80cca0afbca0b916e16a59ebb410e03807817b41939e259b8917f68ad247c64e
BLAKE2b-256 checksum
How to use checksums
bfbddf9ab349db769866b3fda33b1ef7900208f30a87c158259a6e2fd3fdd1b4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp37-cp37m-manylinux2014_x86_64.whl

Download URL isal-0.7.0-cp37-cp37m-manylinux2014_x86_64.whl
Size 408.6 kB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
06cc8560192b4046c207051f559933024805a319abb9594fe3d214a6d1a90341
BLAKE2b-256 checksum
How to use checksums
70d7039ab547e9c9bf4fb5496fad2e5d5aca5eb9f33ab78ede7e4ce044451b9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp37-cp37m-macosx_10_9_x86_64.whl

Download URL isal-0.7.0-cp37-cp37m-macosx_10_9_x86_64.whl
Size 195.2 kB
Tags CPython 3.7 CPython 3.7 pymalloc macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
363b5779f789feb6e1af34fad47ba5f63437c80549e2da2b4a6928f49a3b0d2f
BLAKE2b-256 checksum
How to use checksums
b62b1cf43beaf7779ab0e1dc03f96d2b560806ecad070b79be9a589b212bd360
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp36-cp36m-win_amd64.whl

Download URL isal-0.7.0-cp36-cp36m-win_amd64.whl
Size 155.7 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
36f4a41e6de6c4d3e72589ddd2c0e01c3cf16f234c799db6311d4b84fe22ec6c
BLAKE2b-256 checksum
How to use checksums
42df9239f12aa39758448e99dbf8e2e391b1e7440b18f043c3a12b46be7b5e6b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp36-cp36m-manylinux2014_x86_64.whl

Download URL isal-0.7.0-cp36-cp36m-manylinux2014_x86_64.whl
Size 407.5 kB
Tags CPython 3.6 CPython 3.6 pymalloc Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
469797d658df8419fe8ee471a4124e46eaa3f96dec9cbd1454fa63cac869ecf8
BLAKE2b-256 checksum
How to use checksums
288007d1443a2995a527fe484528bf1d2da4e69af2271853959d9da7012f2e38
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Release files / isal-0.7.0-cp36-cp36m-macosx_10_9_x86_64.whl

Download URL isal-0.7.0-cp36-cp36m-macosx_10_9_x86_64.whl
Size 196.4 kB
Tags CPython 3.6 CPython 3.6 pymalloc macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
7ea916c6e5d73e1cf7d037775db65ae4d0cecd6ee86e408cf98ff5c8d794e364
BLAKE2b-256 checksum
How to use checksums
61335f31582c273486f2ad767e6e5ecbd6a6fba9d903b6a28234687638d29b65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

Security for isal 0.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.7.0 This release

13 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page