resolve comments from PR

Author: gnzsnz

.gitignore

@@ -5,10 +5,3 @@ __pycache__/
 .tox
 venv/
 src/xopen/_version.py
-settings.json
-.coverage
-coverage.xml
-.vscode/*
-.DS_Store
-build/*
-dist/*

README.rst

@@ -26,8 +26,8 @@ Supported compression formats are:
 - gzip (``.gz``)
 - bzip2 (``.bz2``)
 - xz (``.xz``)
+- lz4 (``.lz4``)
 - Zstandard (``.zst``) (optional)
-- lz4 (``.lz4``) (optional)
 
 ``xopen`` is compatible with Python versions 3.8 and later.
 
@@ -141,6 +141,9 @@ built-in support for multithreaded compression.
 
 For bz2 files, `pbzip2 (parallel bzip2) <http://compression.great-site.net/pbzip2/>`_ is used.
 
+For lz4 files, [python lz4](https://python-lz4.readthedocs.io/en/stable/index.html)
+package is used.
+
 ``xopen`` falls back to Python’s built-in functions
 (``gzip.open``, ``lzma.open``, ``bz2.open``)
 if none of the other methods can be used.
@@ -181,20 +184,6 @@ program or the Python ``zstandard`` package needs to be installed.
 To ensure that you get the correct ``zstandard`` version, you can specify the ``zstd`` extra for
 ``xopen``, that is, install it using ``pip install xopen[zstd]``.
 
-Optional lz4 support
---------------------------
-
-For reading and writing lz4 (``.lz4``) files, either the ``lz4`` command-line
-program or the Python ``lz4`` package needs to be installed.
-
-* If the ``threads`` parameter to ``xopen()`` is ``None`` (the default) or any value greater than 0,
-  ``xopen`` uses an external ``lz4`` process.
-* If the above fails (because no ``lz4`` program is available) or if ``threads`` is 0,
-  the ``lz4`` package is used.
-
-To ensure that ``lz4`` is installed, you can specify the ``lz4`` extra for
-``xopen``, that is, install it using ``pip install xopen[lz4]``.
-
 
 Changelog
 ---------

pyproject.toml

@@ -5,39 +5,30 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "xopen"
 authors = [
-    { name = "Marcel Martin", email = "marcel.martin@scilifelab.se" },
-    { name = "Ruben Vorderman", email = "r.h.p.vorderman@lumc.nl" },
+    {name = "Marcel Martin", email = "marcel.martin@scilifelab.se"},
+    {name = "Ruben Vorderman", email = "r.h.p.vorderman@lumc.nl"}
 ]
 description = "Open compressed files transparently"
 readme = "README.rst"
-license = { text = "MIT" }
+license = {text = "MIT"}
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3"
 ]
 requires-python = ">=3.8"
 dynamic = ["version"]
 dependencies = [
     'isal>=1.6.1; platform.machine == "x86_64" or platform.machine == "AMD64" or platform.machine == "aarch64"',
     'zlib-ng>=0.4.1; platform.machine == "x86_64" or platform.machine == "AMD64" or platform.machine == "aarch64"',
-    'lz4>=4.3.3',
+    'lz4>4.3.1'
 ]
 
 [project.urls]
 homepage = "https://github.com/pycompression/xopen/"
 
 [project.optional-dependencies]
-dev = [
-    "pytest",
-    "pytest-timeout",
-    "tox",
-    "black",
-    "flake8",
-    "mypy",
-    "twine",
-    "setuptools_scm[toml]",
-]
+dev = ["pytest"]
 zstd = ["zstandard<1"]
 
 [tool.setuptools_scm]

src/xopen/__init__.py

@@ -126,7 +126,7 @@ class _ProgramSettings:
     "zstd": _ProgramSettings(("zstd",), tuple(range(1, 20)), "-T"),
     "pigz": _ProgramSettings(("pigz", "--no-name"), tuple(range(0, 10)) + (11,), "-p"),
     "gzip": _ProgramSettings(("gzip", "--no-name"), tuple(range(1, 10))),
-    "lz4": _ProgramSettings(("lz4",), tuple(range(0, 17)), "-T"),
+    "lz4": _ProgramSettings(("lz4",), tuple(range(0, 17))),
 }
 
 
@@ -850,7 +850,7 @@ def xopen(  # noqa: C901
     compresslevel is the compression level for writing to gzip, xz and zst files.
     This parameter is ignored for the other compression formats.
     If set to None, a default depending on the format is used:
-    gzip: 6, xz: 6, zstd: 3, lz4: 1.
+    gzip: 6, xz: 6, zstd: 3, lz4: 0.
 
     When threads is None (the default), compressed file formats are read or written
     using a pipe to a subprocess running an external tool such as,

tests/test_xopen.py

@@ -28,11 +28,9 @@
 TEST_DIR = Path(__file__).parent
 CONTENT_LINES = ["Testing, testing ...\n", "The second line.\n"]
 CONTENT = "".join(CONTENT_LINES)
-extensions = ["", ".gz", ".bz2", ".xz"]
+extensions = ["", ".gz", ".bz2", ".xz", ".lz4"]
 if shutil.which("zstd") or zstandard:
     extensions += [".zst"]
-if shutil.which("lz4") or lz4:
-    extensions += [".lz4"]
 base = os.path.join(os.path.dirname(__file__), "file.txt")
 files = [base + ext for ext in extensions]