Merge pull request #244 from pycompression/release_1.8.0

Release 1.8.0

Author: rhpvorderman

.github/workflows/ci.yml

@@ -16,10 +16,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
-      - name: Set up Python 3.8
+      - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.10"
       - name: Install tox
         run: pip install tox
       - name: Lint
@@ -36,10 +36,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: recursive
-      - name: Set up Python 3.8
+      - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.10"
       - name: Install isal
         run: sudo apt-get install libisal-dev
       - name: Install tox and upgrade setuptools and pip
@@ -54,22 +54,22 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.8"
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"
-          - "pypy-3.9"
+          - "3.14"
+          - "3.14t"
           - "pypy-3.10"
+          - "pypy-3.11"
         os: ["ubuntu-latest"]
         include:
           - os: "macos-13"
-            python-version: "3.8"
-          - os: "macos-14"
+            python-version: "3.10"
+          - os: "macos-latest"
             python-version: "3.10"
           - os: "windows-latest"
-            python-version: "3.8"
+            python-version: "3.10"
     steps:
       - uses: actions/checkout@v4
         with:
@@ -78,6 +78,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
       - name: Install tox and upgrade setuptools
         run: pip install --upgrade tox setuptools
       - name: Install build dependencies (Linux)  # Yasm in pypa/manylinux images.
@@ -105,7 +106,7 @@ jobs:
     strategy:
       matrix:
         python_version:
-          - "3.8"
+          - "3.10"
     steps:
       - uses: actions/checkout@v4
         with:
@@ -243,14 +244,14 @@ jobs:
           CIBW_ENVIRONMENT_LINUX: >-
             PYTHON_ISAL_BUILD_CACHE=True
             PYTHON_ISAL_BUILD_CACHE_FILE=/tmp/build_cache
-            CFLAGS="-g0 -DNDEBUG"
+            CFLAGS="-O3 -DNDEBUG"
           CIBW_ENVIRONMENT_WINDOWS: >-
             PYTHON_ISAL_BUILD_CACHE=True
             PYTHON_ISAL_BUILD_CACHE_FILE=${{ runner.temp }}\build_cache
           CIBW_ENVIRONMENT_MACOS: >-
             PYTHON_ISAL_BUILD_CACHE=True
             PYTHON_ISAL_BUILD_CACHE_FILE=${{ runner.temp }}/build_cache
-            CFLAGS="-g0 -DNDEBUG"
+            CFLAGS="-O3 -DNDEBUG"
       - name: Build sdist
         if: ${{runner.os == 'Linux' && matrix.cibw_archs_linux == 'x86_64'}}
         run: |

CHANGELOG.rst

@@ -8,6 +8,22 @@ Changelog
 .. that users understand how the changes affect the new version.
 
 
+version 1.8.0
+-----------------
++ Python 3.14 is supported.
++ Python 3.8 and 3.9 are no longer supported.
++ Fix an issue where flushing using igzip_threaded caused a gzip end of stream
+  and started a new gzip stream. In essence creating a concatenated gzip
+  stream. Now it is in concordance with how single threaded gzip streams
+  are flushed using Z_SYNC_FLUSH.
++ Change build backend to setuptools-scm which is more commonly used and
+  supported.
++ Include test packages in the source distribution, so source distribution
+  installations can be verified.
++ Fix an issue where some tests failed because they ignored PYTHONPATH.
++ Enable support for free-threading and build free-threaded wheels for
+  CPython 3.14. Thanks to @lysnikolaou and @ngoldbaum.
+
 version 1.7.2
 -----------------
 + Use upstream ISA-L version 2.31.1 which includes patches to make 

MANIFEST.in

@@ -1,7 +1,8 @@
 graft src/isal/isa-l
 include src/isal/*.h
-prune tests
 prune docs
+prune .github
+exclude .git*
 prune benchmark_scripts
 exclude requirements-docs.txt
 exclude codecov.yml

pyproject.toml

@@ -1,10 +1,61 @@
 [build-system]
-requires = ["setuptools>=64", "versioningit>=1.1.0"]
+requires = ["setuptools>=77", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
-[tool.versioningit.vcs]
-method="git"
-default-tag = "v0.0.0"
+[project]
+name = "isal"
+dynamic = ["version"]
+description = """
+Faster zlib and gzip compatible compression and decompression by providing \
+python bindings for the ISA-L ibrary."""
+license="PSF-2.0"
+keywords=["isal", "isa-l", "compression", "deflate", "gzip", "igzip"]
+authors = [{name = "Leiden University Medical Center"},
+           {email = "[email protected]"}]
+readme = "README.rst"
+requires-python = ">=3.9"  # Because of setuptools version
+classifiers = [
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy",
+        "Programming Language :: C",
+        "Development Status :: 5 - Production/Stable",
+        "Topic :: System :: Archiving :: Compression",
+        "Operating System :: POSIX :: Linux",
+        "Operating System :: MacOS",
+        "Operating System :: Microsoft :: Windows",
+]
+urls.homepage = "https://github.com/pycompression/python-isal"
+urls.documentation = "python-isal.readthedocs.io"
 
-[tool.versioningit.write]
-file = "src/isal/_version.py"
+[tool.setuptools_scm]
+version_file = "src/isal/_version.py"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["isal"]
+
+[tool.setuptools.package-data]
+isal = ['*.pyi', 'py.typed', 'isa-l/LICENSE', 'isa-l/README.md', 'isa-l/Release_notes.txt']
+[tool.setuptools.exclude-package-data]
+isal = [
+        "*.c",
+        "*.h",
+        "isa-l/*/*",
+        "isa-l/Mak*",
+        "isa-l/.*",
+        "isa-l/autogen.sh",
+        "isa-l/Doxyfile",
+        "isa-l/CONTRIBUTING.md",
+        "isa-l/SECURITY.md",
+        "isa-l/configure.ac",
+        "isa-l/isa-l.*",
+        "isa-l/libisal.pc.in",
+        "isa-l/make.inc",
+]

setup.cfg

@@ -15,11 +15,9 @@
 import tempfile
 from pathlib import Path
 
-from setuptools import Extension, find_packages, setup
+from setuptools import Extension, setup
 from setuptools.command.build_ext import build_ext
 
-import versioningit
-
 ISA_L_SOURCE = os.path.join("src", "isal", "isa-l")
 
 SYSTEM_IS_BSD = (sys.platform.startswith("freebsd") or
@@ -138,46 +136,6 @@ def build_isa_l():
 
 
 setup(
-    name="isal",
-    version=versioningit.get_version(),
-    description="Faster zlib and gzip compatible compression and "
-                "decompression by providing python bindings for the ISA-L "
-                "library.",
-    author="Leiden University Medical Center",
-    author_email="[email protected]",  # A placeholder for now
-    long_description=Path("README.rst").read_text(),
-    long_description_content_type="text/x-rst",
     cmdclass={"build_ext": BuildIsalExt},
-    license="PSF-2.0",
-    keywords="isal isa-l compression deflate gzip igzip threads",
-    zip_safe=False,
-    packages=find_packages('src'),
-    package_dir={'': 'src'},
-    package_data={'isal': ['*.pyi', 'py.typed',
-                           # Include isa-l LICENSE and other relevant files
-                           # with the binary distribution.
-                           'isa-l/LICENSE', 'isa-l/README.md',
-                           'isa-l/Release_notes.txt']},
-    url="https://github.com/pycompression/python-isal",
-    classifiers=[
-        "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Programming Language :: Python :: 3.13",
-        "Programming Language :: Python :: Implementation :: CPython",
-        "Programming Language :: Python :: Implementation :: PyPy",
-        "Programming Language :: C",
-        "Development Status :: 5 - Production/Stable",
-        "Topic :: System :: Archiving :: Compression",
-        "License :: OSI Approved :: Python Software Foundation License",
-        "Operating System :: POSIX :: Linux",
-        "Operating System :: MacOS",
-        "Operating System :: Microsoft :: Windows",
-    ],
-    python_requires=">=3.8",  # BadGzipFile imported
     ext_modules=EXTENSIONS
 )

setup.py

@@ -31,6 +31,11 @@ PyInit__isal(void)
     if (m == NULL) {
         return NULL;
     }
+
+#ifdef Py_GIL_DISABLED
+    PyUnstable_Module_SetGIL(m, Py_MOD_GIL_NOT_USED);
+#endif
+
     PyModule_AddIntMacro(m, ISAL_MAJOR_VERSION);
     PyModule_AddIntMacro(m, ISAL_MINOR_VERSION);
     PyModule_AddIntMacro(m, ISAL_PATCH_VERSION);

src/isal/_isalmodule.c

@@ -617,6 +617,11 @@ PyInit_igzip_lib(void)
     if (m == NULL)
         return NULL;
 
+#ifdef Py_GIL_DISABLED
+    PyUnstable_Module_SetGIL(m, Py_MOD_GIL_NOT_USED);
+#endif
+
+
     IsalError = PyErr_NewException("igzip_lib.IsalError", NULL, NULL);
     if (IsalError == NULL) {
         return NULL;

src/isal/igzip_libmodule.c

@@ -316,30 +316,26 @@ def write(self, b) -> int:
         self.input_queues[worker_index].put((data, zdict))
         return len(data)
 
-    def _end_gzip_stream(self):
+    def flush(self):
         self._check_closed()
         # Wait for all data to be compressed
         for in_q in self.input_queues:
             in_q.join()
         # Wait for all data to be written
         for out_q in self.output_queues:
             out_q.join()
-        # Write an empty deflate block with a lost block marker.
+        self.raw.flush()
+
+    def close(self) -> None:
+        if self._closed:
+            return
+        self.flush()
         self.raw.write(isal_zlib.compress(b"", wbits=-15))
         trailer = struct.pack("<II", self._crc, self._size & 0xFFFFFFFF)
         self.raw.write(trailer)
         self._crc = 0
         self._size = 0
         self.raw.flush()
-
-    def flush(self):
-        self._end_gzip_stream()
-        self._write_gzip_header()
-
-    def close(self) -> None:
-        if self._closed:
-            return
-        self._end_gzip_stream()
         self.stop()
         if self.exception:
             self.raw.close()

src/isal/igzip_threaded.py

@@ -2183,6 +2183,10 @@ PyInit_isal_zlib(void)
         return NULL;
     }
 
+#ifdef Py_GIL_DISABLED
+    PyUnstable_Module_SetGIL(m, Py_MOD_GIL_NOT_USED);
+#endif
+
     PyObject *igzip_lib_module = PyImport_ImportModule("isal.igzip_lib");
     if (igzip_lib_module == NULL) {
         return NULL;