Merge pull request #52 from pycompression/release_0.6.1

Release 0.6.1

Author: rhpvorderman

.github/release_checklist.md

@@ -6,16 +6,11 @@ Release checklist
   - [ ] Change current development version in `CHANGELOG.rst` to stable version.
   - [ ] Change the version in `__init__.py`
 - [ ] Merge the release branch into `main`.
-- [ ] Create a test pypi package from the main branch. ([Instructions.](
-https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives
-))
-- [ ] Install the packages from the test pypi repository to see if they work.
 - [ ] Created an annotated tag with the stable version number. Include changes 
 from CHANGELOG.rst.
-- [ ] Push tag to remote.
-- [ ] Push tested packages to pypi.
+- [ ] Push tag to remote. This triggers the wheel/sdist build on github CI.
 - [ ] merge `main` branch back into `develop`.
-- [ ] Add updated version number to develop.
+- [ ] Add updated version number to develop. (`setup.py` and `src/isal/__init__.py`)
 - [ ] Build the new tag on readthedocs. Only build the last patch version of
 each minor version. So `1.1.1` and `1.2.0` but not `1.1.0`, `1.1.1` and `1.2.0`.
 - [ ] Create a new release on github.

CHANGELOG.rst

@@ -7,6 +7,11 @@ 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.6.1
+-----------------
++ Fix a crash that occurs when opening a file that did not end in ``.gz`` while
+  outputting to stdout using ``python -m isal.igzip``.
+
 version 0.6.0
 -----------------
 + ``python -m gzip``'s behaviour has been changed since fixing bug:

setup.py

@@ -152,7 +152,7 @@ def build_isa_l():
 
 setup(
     name="isal",
-    version="0.6.0",
+    version="0.6.1",
     description="Faster zlib and gzip compatible compression and "
                 "decompression by providing python bindings for the ISA-L "
                 "library.",

src/isal/__init__.py

@@ -39,4 +39,4 @@
     "__version__"
 ]
 
-__version__ = "0.6.0"
+__version__ = "0.6.1"

src/isal/igzip.py

@@ -294,8 +294,9 @@ def main():
         in_file = IGzipFile(mode="rb", fileobj=sys.stdin.buffer)
     elif not args.compress and args.file is not None:
         base, extension = os.path.splitext(args.file)
-        if extension != ".gz":
-            sys.exit(f"filename doesn't end in .gz: {args.file!r}")
+        if extension != ".gz" and not args.stdout:
+            sys.exit(f"filename doesn't end in .gz: {args.file!r}. "
+                     f"Cannot determine output filename.")
         in_file = open(args.file, "rb")
 
     # Determine output file

tests/test_gzip_compliance.py

@@ -823,7 +823,8 @@ def test_decompress_infile_outfile(self):
     def test_decompress_infile_outfile_error(self):
         rc, out, err = assert_python_failure('-m', 'isal.igzip', '-d',
                                              'thisisatest.out')
-        self.assertEqual(b"filename doesn't end in .gz: 'thisisatest.out'",
+        self.assertEqual(b"filename doesn't end in .gz: 'thisisatest.out'. "
+                         b"Cannot determine output filename.",
                          err.strip())
         self.assertEqual(rc, 1)
         self.assertEqual(out, b'')

tests/test_igzip.py

@@ -118,6 +118,15 @@ def test_decompress_infile_outfile_error(capsysbinary):
     assert out == b''
 
 
+def test_decompress_infile_stdout_noerror(capsysbinary, tmp_path):
+    test_file = tmp_path / "test"
+    test_file.write_bytes(COMPRESSED_DATA)
+    sys.argv = ['', '-cd', str(tmp_path / 'test')]
+    igzip.main()
+    result = capsysbinary.readouterr()
+    assert DATA == result.out
+
+
 def test_decompress_infile_stdout(capsysbinary, tmp_path):
     test_gz = tmp_path / "test.gz"
     test_gz.write_bytes(gzip.compress(DATA))