Merge pull request #34 from pycompression/release_0.4.1

Release 0.4.1

Author: rhpvorderman

CHANGELOG.rst

@@ -7,6 +7,12 @@ 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.4.1
+-----------------
++ Fix a bug where streams that were passed to gzip_ng_threaded.open where
+  closed.
++ Fix compatibility with Python 3.13
+
 version 0.4.0
 -----------------
 + Add a ``gzip_ng_threaded`` module that contains the ``gzip_ng_threaded.open``

setup.py

@@ -123,7 +123,7 @@ def build_zlib_ng():
 
 setup(
     name="zlib-ng",
-    version="0.4.0",
+    version="0.4.1",
     description="Drop-in replacement for zlib and gzip modules using zlib-ng",
     author="Leiden University Medical Center",
     author_email="r.h.p.vorderman@lumc.nl",  # A placeholder for now

src/zlib_ng/__init__.py

@@ -5,4 +5,4 @@
 # This file is part of python-zlib-ng which is distributed under the
 # PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2.
 
-__version__ = "0.4.0"
+__version__ = "0.4.1"

src/zlib_ng/gzip_ng_threaded.py

@@ -78,16 +78,18 @@ def open(filename, mode="rb", compresslevel=gzip_ng._COMPRESS_LEVEL_TRADEOFF,
 def open_as_binary_stream(filename, open_mode):
     if isinstance(filename, (str, bytes)) or hasattr(filename, "__fspath__"):
         binary_file = builtins.open(filename, open_mode)
+        closefd = True
     elif hasattr(filename, "read") or hasattr(filename, "write"):
         binary_file = filename
+        closefd = False
     else:
         raise TypeError("filename must be a str or bytes object, or a file")
-    return binary_file
+    return binary_file, closefd
 
 
 class _ThreadedGzipReader(io.RawIOBase):
     def __init__(self, filename, queue_size=2, block_size=1024 * 1024):
-        self.raw = open_as_binary_stream(filename, "rb")
+        self.raw, self.closefd = open_as_binary_stream(filename, "rb")
         self.fileobj = zlib_ng._GzipReader(self.raw, buffersize=8 * block_size)
         self.pos = 0
         self.read_file = False
@@ -155,7 +157,8 @@ def close(self) -> None:
         self.running = False
         self.worker.join()
         self.fileobj.close()
-        self.raw.close()
+        if self.closefd:
+            self.raw.close()
         self._closed = True
 
     @property
@@ -246,7 +249,7 @@ def __init__(self,
         self._crc = 0
         self.running = False
         self._size = 0
-        self.raw = open_as_binary_stream(filename, mode)
+        self.raw, self.closefd = open_as_binary_stream(filename, mode)
         self._closed = False
         self._write_gzip_header()
         self.start()
@@ -334,7 +337,8 @@ def close(self) -> None:
         trailer = struct.pack("<II", self._crc, self._size & 0xFFFFFFFF)
         self.raw.write(trailer)
         self.raw.flush()
-        self.raw.close()
+        if self.closefd:
+            self.raw.close()
         self._closed = True
 
     @property

src/zlib_ng/zlib_ngmodule.c

@@ -2810,7 +2810,7 @@ GzipReader_readall(GzipReader *self, PyObject *Py_UNUSED(ignore))
         Py_DECREF(chunk_list);
         return NULL;
     }
-    PyObject *ret = _PyBytes_Join(empty_bytes, chunk_list);
+    PyObject *ret = PyObject_CallMethod(empty_bytes, "join", "O", chunk_list);
     Py_DECREF(empty_bytes);
     Py_DECREF(chunk_list);
     return ret;

tests/test_gzip_ng_threaded.py

@@ -190,3 +190,22 @@ def test_gzip_ng_threaded_append_text_mode(tmp_path):
     with gzip.open(test_file, "rt") as f:
         contents = f.read()
     assert contents == "ABCD"
+
+
+def test_threaded_reader_does_not_close_stream():
+    test_stream = io.BytesIO()
+    test_stream.write(gzip.compress(b"thisisatest"))
+    test_stream.seek(0)
+    with gzip_ng_threaded.open(test_stream, "rb") as f:
+        text = f.read()
+    assert not test_stream.closed
+    assert text == b"thisisatest"
+
+
+def test_threaded_writer_does_not_close_stream():
+    test_stream = io.BytesIO()
+    with gzip_ng_threaded.open(test_stream, "wb") as f:
+        f.write(b"thisisatest")
+    assert not test_stream.closed
+    test_stream.seek(0)
+    assert gzip.decompress(test_stream.read()) == b"thisisatest"