Merge pull request #22 from pycompression/release_0.2.0

Release 0.2.0

Author: rhpvorderman

.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: Continous integration
+
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - master
+
+
+jobs:
+  lint:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version:
+          - 3.6
+    steps:
+      - uses: actions/[email protected]
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+      - name: Install tox
+        run: pip install tox
+      - name: Lint
+        run: tox -e lint
+  docs:
+    needs: lint
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/[email protected]
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+      - name: Install tox
+        run: pip install tox
+      - name: Install isal
+        run: sudo apt-get install libisal-dev
+      - name: Build docs
+        run: tox -e docs
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version:
+          - 3.6
+          - 3.7
+          - 3.8
+          - 3.9
+    needs: lint
+    steps:
+      - uses: actions/[email protected]
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+      - name: Install tox
+        run: pip install tox
+      - name: Install isal
+        run: sudo apt-get install libisal-dev
+      - name: Run tests
+        run: tox -e py3
+      - name: Upload coverage report
+        if: ${{ matrix.python-version == 3.6 }} # Only upload coverage once
+        uses: codecov/codecov-action@v1

.travis.yml

@@ -7,6 +7,16 @@ Changelog
 .. This document is user facing. Please word the changes in such a way
 .. that users understand how the changes affect the new version.
 
+version 0.2.0
+-----------------
++ Fixed a bug where writing of the gzip header would crash if an older version
+  of Python 3.7 was used such as on Debian or Ubuntu. This is due to
+  differences between point releases because of a backported feature. The code
+  now checks if the backported feature is present.
++ Added Python 3.9 to the testing.
++ Fixed ``setup.py`` to list setuptools as a requirement.
++ Changed homepage to reflect move to pycompression organization.
+
 version 0.1.0
 -----------------
 + Publish API documentation on readthedocs.

CHANGELOG.rst

@@ -1,3 +1,27 @@
+.. image:: https://img.shields.io/pypi/v/isal.svg
+  :target: https://pypi.org/project/isal/
+  :alt:
+
+.. image:: https://img.shields.io/conda/v/conda-forge/python-isal.svg
+  :target: https://github.com/conda-forge/python-isal-feedstock
+  :alt:
+
+.. image:: https://img.shields.io/pypi/pyversions/isal.svg
+  :target: https://pypi.org/project/isal/
+  :alt:
+
+.. image:: https://img.shields.io/pypi/l/isal.svg
+  :target: https://github.com/LUMC/isal/blob/main/LICENSE
+  :alt:
+
+.. image:: https://travis-ci.com/pycompression/python-isal.svg?branch=develop
+  :target: https://travis-ci.com/github/pycompression/python-isal
+  :alt:
+
+.. image:: https://codecov.io/gh/pycompression/python-isal/branch/develop/graph/badge.svg
+  :target: https://codecov.io/gh/pycompression/python-isal
+  :alt:
+
 .. image:: https://readthedocs.org/projects/python-isal/badge
    :target: https://python-isal.readthedocs.io
    :alt:
@@ -30,6 +54,14 @@ conda-forge channel. Checkout the `ports documentation
 <https://github.com/intel/isa-l/wiki/Ports--Repos>`_ on the isa-l project wiki
 to find out how to install it.
 
+python-isal can be installed via pypi with:
+
+.. code-block::
+
+    pip install isal
+
+This requires the isa-l library to be installed on your pc.
+
 The latest development version of python-isal can be installed with
 
 .. code-block::

README.rst

@@ -36,7 +36,7 @@
 
 setup(
     name="isal",
-    version="0.1.0",
+    version="0.2.0",
     description="Faster zlib and gzip compatible compression and "
                 "decompression by providing python bindings for the isa-l "
                 "library.",
@@ -50,21 +50,22 @@
     packages=find_packages('src'),
     package_dir={'': 'src'},
     package_data={'isal': ['*.pxd', '*.pyx']},
-    url="https://github.com/rhpvorderman/python-isal",
+    url="https://github.com/pycompression/python-isal",
     classifiers=[
         "Programming Language :: Python :: 3 :: Only",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
         "Programming Language :: Cython",
         "Development Status :: 3 - Alpha",
         "Topic :: System :: Archiving :: Compression",
         "License :: OSI Approved :: MIT License",
     ],
     python_requires=">=3.6",
     setup_requires=["cython"],
-    install_requires=[],
+    install_requires=["setuptools"],
     ext_modules=[
         Extension("isal.isal_zlib", ["src/isal/isal_zlib.pyx"],
                   libraries=["isal"], **EXTENSION_OPTS),

setup.py

@@ -159,18 +159,27 @@ def flush(self, zlib_mode=isal_zlib.Z_SYNC_FLUSH):
         super().flush(zlib_mode)
 
     def _write_gzip_header(self, compresslevel=_COMPRESS_LEVEL_TRADEOFF):
-        # Determine what xfl flag is written for the compression level.
-        # Equate the fast level to gzip level 1. All the other levels are
-        # medium.
-        if sys.version_info[0] == 3 and sys.version_info[1] < 7:
-            # Correct header introduced in 3.7
-            super()._write_gzip_header()
-        else:
+        # Python 3.9 added a `compresslevel` parameter to write gzip header.
+        # This only determines the value of one extra flag. Because this change
+        # was backported to 3.7 and 3.8 in later point versions, the attributes
+        # of the function should be checked before trying to use the
+        # compresslevel parameter.
+        # The gzip header has an extra flag that can be set depending on the
+        # compression level used. This should be set when either the fastest or
+        # best method is used. ISAL level 0 is larger than gzip level 1 and
+        # much faster, so setting the flag for fastest level is appropriate.
+        # ISAL level 1,2 and 3 (best)are similar in size and fall around the
+        # gzip level 3 size. So setting no extra flag
+        # (by using COMPRESS_LEVEL_TRADEOFF) is appropriate here.
+        if ("compresslevel" in super()._write_gzip_header.__code__.co_varnames
+            and hasattr(gzip, "_COMPRESS_LEVEL_FAST")
+                and hasattr(gzip, "_COMPRESS_LEVEL_TRADEOFF")):
             if compresslevel == _COMPRESS_LEVEL_FAST:
-                compresslevel = gzip._COMPRESS_LEVEL_FAST
+                super()._write_gzip_header(gzip._COMPRESS_LEVEL_FAST)
             else:
-                compresslevel = gzip._COMPRESS_LEVEL_TRADEOFF
-            super()._write_gzip_header(compresslevel)
+                super()._write_gzip_header(gzip._COMPRESS_LEVEL_TRADEOFF)
+        else:
+            super()._write_gzip_header()
 
     def write(self, data):
         self._check_not_closed()

src/isal/igzip.py

@@ -365,10 +365,11 @@ def test_metadata(self):
                              struct.pack('<i', mtime))  # little-endian
 
             xflByte = fRead.read(1)
-            if sys.version_info[0] == 3 and sys.version_info[1] < 7:
-                self.assertEqual(xflByte, b'\x02')  # maximum compression
+            if ("compresslevel" in
+                    gzip.GzipFile._write_gzip_header.__code__.co_varnames):
+                self.assertEqual(xflByte, b'\x00')  # fast compression
             else:
-                self.assertEqual(xflByte, b'\x00')  # medium compression
+                self.assertEqual(xflByte, b'\x02')  # maximum compression
             osByte = fRead.read(1)
             self.assertEqual(osByte, b'\xff')  # OS "unknown" (OS-independent)
 
@@ -399,8 +400,9 @@ def test_compresslevel_metadata(self):
         # specifically, discussion of XFL in section 2.3.1
         cases = [
             ('fast', 0, b'\x04'),
-            ('best', 3, b'\x00'),  # Comparable to medium gzip level.
-            ('tradeoff', 2, b'\x00'),  # Dito
+            ('best', 3, b'\x00'),  # Smaller than fast, bigger than best gzip.
+            ('tradeoff', 2, b'\x00'),  # therefore medium is appropriate.
+            ('1', 1, b'\x00')
         ]
         xflOffset = 8
 

tests/test_gzip_compliance.py

@@ -25,6 +25,8 @@ commands=
 deps=flake8
      flake8-import-order
      mypy
+# Linting does not need the installed package.
+skip_install=true
 commands =
     flake8 src tests setup.py benchmark.py