patool 3.0.2__tar.gz → 3.0.3__tar.gz

{patool-3.0.2 → patool-3.0.3}/Makefile

@@ -32,7 +32,8 @@ GIT_MAIN_BRANCH:=master
 # -s: do not capture stdout/stderr (some tests fail otherwise)
 # --full-trace: print full stacktrace on keyboard interrupts
 # --log-file: write test output to file for easier inspection
-PYTESTOPTS?=-s --full-trace --log-file=build/test.log
+# --numprocesses auto: run tests in parallel on available CPU cores (uses pytest-xdist) 
+PYTESTOPTS?=-s --full-trace --log-file=build/test.log --numprocesses auto
 # which test modules to run
 TESTS ?= tests/
 # set test options
@@ -107,7 +108,7 @@ release-gh:	## upload a new release to github
 # anything screwed up.
 .PHONY: release
 release: distclean releasecheck ## release a new version of patool
-	$(MAKE) dist release-gh release-pypi homepage github-issues
+	$(MAKE) dist release-gh release-pypi release-homepage github-issues
 
 .PHONY: releasecheck
 releasecheck: update_webmeta checkgit checkchangelog lint test typecheck checkgitreleasetag ## check that repo is ready for release
@@ -206,7 +207,13 @@ checkoutdatedgh:	## check for outedated github tools
 
 .PHONY: test
 test: ## run tests
-	pytest $(PYTESTOPTS) $(TESTOPTS) $(TESTS)
+	uv run pytest $(PYTESTOPTS) $(TESTOPTS) $(TESTS)
+
+# Needs https://nektosact.com/ and docker
+# Uses https://github.com/catthehacker/docker_images
+.PHONY: test-github
+test-github: ## run github workflow actions
+	act -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest --matrix os:ubuntu-latest
 
 .PHONY: typecheck
 typecheck:	## run pytype
@@ -227,6 +234,6 @@ update_webmeta: ## update package metadata for the homepage
 	sed -i -e 's/version =.*/version = "$(VERSION)"/g' $(WEBMETA)
 	sed -i -e 's/author =.*/author = "$(AUTHOR)"/g' $(WEBMETA)
 
-.PHONY: homepage
-homepage: update_webmeta ## update the homepage after a release
+.PHONY: release-homepage
+release-homepage: update_webmeta ## update the homepage after a release
 	$(MAKE) -C doc/web release

{patool-3.0.2/patool.egg-info → patool-3.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: patool
-Version: 3.0.2
+Version: 3.0.3
 Summary: portable archive file manager
 Home-page: https://github.com/wummel/patool
 Author: Bastian Kleineidam

{patool-3.0.2 → patool-3.0.3}/doc/changelog.txt

@@ -1,3 +1,12 @@
+3.0.3 (released 04.11.2024)
+  * Fix UnicodeDecode errors when logging, especially on windows systems.
+    Closes: GH bug #170
+  * Added support for WIM (windows image) archives with 7z.
+  * If the MIME database cannot detect the file type, check again with a lowercase filenanme extension.
+  * Use 7z option -aou to rename files when extracting instead of overwriting them.
+  * Use rar option -or to rename files when extracting instead of overwriting them.
+  * Use rar option -kb to keep files when extracting broken RAR archives.
+
 3.0.2 (released 21.10.2024)
   * When running in verbose mode (-vv), print mime and compression info.
   * Use official github command line client "gh" for releases.

{patool-3.0.2 → patool-3.0.3}/doc/development.md

@@ -3,13 +3,11 @@ Development
 
 Development for patool needs the following environment:
 
-1. Python >= 3.10 from https://www.python.org/
+1. Debian Linux or a similar distribution like Ubuntu
 
-2. uv from https://github.com/astral-sh/uv
+2. GNU make
 
-   Install the `uv` binary into a local directory in your PATH.
-
-3. GNU make
+3. A user with sudo permissions.
 
 
 To start developing, run the following commands:
@@ -20,14 +18,10 @@ To start developing, run the following commands:
 
 2. Initialize the source directory
 
-   $ make init
-
-   This creates a virtual Python environment in the directory `.venv/` and installs
-   required modules for development.
-
-   You should add the virtual Python environment binaries to PATH
+   $ scripts/install_dev.sh
 
-   $ export PATH=.venv/bin:$PATH
+   This installs required packages, creates a virtual Python environment in the directory `.venv/`
+   and installs required modules for development.
 
 3. Run the tests
 

{patool-3.0.2 → patool-3.0.3/patool.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: patool
-Version: 3.0.2
+Version: 3.0.3
 Summary: portable archive file manager
 Home-page: https://github.com/wummel/patool
 Author: Bastian Kleineidam

{patool-3.0.2 → patool-3.0.3}/patool.egg-info/SOURCES.txt

@@ -302,6 +302,8 @@ tests/data/t.txt.zst
 tests/data/t.txt.zst.foo
 tests/data/t.vhd
 tests/data/t.wav
+tests/data/t.wim
+tests/data/t.wim.foo
 tests/data/t.zip
 tests/data/t.zip.foo
 tests/data/t.zoo

{patool-3.0.2 → patool-3.0.3}/patoolib/__init__.py

@@ -83,6 +83,7 @@ ArchiveFormats: tuple[str, ...] = (
     'shn',
     'tar',
     'vhd',
+    'wim',
     'xz',
     'zip',
     'zoo',
@@ -134,6 +135,7 @@ ArchiveMimetypes: dict[str, str] = {
     'application/x-lha': 'lzh',
     'application/x-lrzip': 'lrzip',
     'application/x-lzh': 'lzh',
+    'application/x-ms-wim': 'wim',
     'application/x-rar': 'rar',
     'application/x-redhat-package-manager': 'rpm',
     'application/x-rpm': 'rpm',
@@ -344,6 +346,9 @@ ArchivePrograms: dict[str, dict[str | None, tuple[str, ...]]] = {
             '7zzs',
         ),
     },
+    'wim': {
+        None: ('7z', '7zz', '7zzs'),
+    },
     'xz': {
         None: ('xz', '7z', '7zz', '7zzs'),
         'extract': (

{patool-3.0.2 → patool-3.0.3}/patoolib/configuration.py

@@ -2,7 +2,7 @@
 """Define basic configuration data like version or application name."""
 
 AppName: str = "patool"
-Version: str = "3.0.2"
+Version: str = "3.0.3"
 MyName: str = "Bastian Kleineidam"
 MyEmail: str = "bastian.kleineidam@web.de"
 

{patool-3.0.2 → patool-3.0.3}/patoolib/log.py

@@ -47,7 +47,7 @@ def encode_safe(*args, encoding=default_encoding):
     with the given encoding
     """
     return " ".join(
-        [str(arg).encode(encoding, errors="replace").decode() for arg in args]
+        [str(arg).encode(encoding, errors="replace").decode(encoding) for arg in args]
     )
 
 

{patool-3.0.2 → patool-3.0.3}/patoolib/mime.py

@@ -73,6 +73,7 @@ def add_mimedb_data(mimedb: mimetypes.MimeTypes) -> None:
     add_mimetype(mimedb, 'application/x-rzip', '.rz')
     add_mimetype(mimedb, 'application/x-zoo', '.zoo')
     add_mimetype(mimedb, 'application/x-dms', '.dms')
+    add_mimetype(mimedb, 'application/x-ms-wim', '.wim')
     add_mimetype(mimedb, 'application/x-zip-compressed', '.crx')
     add_mimetype(mimedb, 'application/x-shar', '.shar')
     add_mimetype(mimedb, 'application/x-tar', '.cbt')
@@ -145,6 +146,11 @@ def guess_mime_mimedb(filename: str) -> tuple[str | None, str | None]:
     mime, encoding = None, None
     if mimedb is not None:
         mime, encoding = mimedb.guess_type(filename, strict=False)
+    if mime is None and encoding is None:
+        # try with lowercase extension, since we configure our mimedb entries only with lowercase
+        # this way, files like "t.GZ" are recognized
+        root, ext = os.path.splitext(filename)
+        mime, encoding = mimedb.guess_type(root + ext.lower(), strict=False)
     if mime not in ArchiveMimetypes and encoding in ArchiveCompressions:
         # Files like 't.txt.gz' are recognized with encoding as format, and
         # an unsupported mime-type like 'text/plain'. Fix this.

{patool-3.0.2 → patool-3.0.3}/patoolib/programs/p7zip.py

@@ -26,7 +26,7 @@ def extract_7z(
         cmdlist.append(f'-p{password}')
     elif not interactive:
         cmdlist.append('-p-')
-    cmdlist.extend([f'-o{outdir}', '--', archive])
+    cmdlist.extend(['-aou', f'-o{outdir}', '--', archive])
     return cmdlist
 
 
@@ -54,7 +54,7 @@ extract_bzip2 = extract_gzip = extract_compress = extract_xz = extract_lzma = (
 
 extract_zip = extract_rar = extract_cab = extract_chm = extract_arj = extract_cpio = (
     extract_rpm
-) = extract_deb = extract_iso = extract_vhd = extract_7z
+) = extract_deb = extract_iso = extract_vhd = extract_wim = extract_7z
 
 
 def list_7z(archive, compression, cmd, verbosity, interactive, password=None):
@@ -73,8 +73,8 @@ def list_7z(archive, compression, cmd, verbosity, interactive, password=None):
 list_bzip2 = list_gzip = list_zip = list_compress = list_rar = list_cab = list_chm = (
     list_arj
 ) = list_cpio = list_rpm = list_deb = list_iso = list_xz = list_lzma = list_vhd = (
-    list_7z
-)
+    list_wim
+) = list_7z
 
 
 def test_7z(archive, compression, cmd, verbosity, interactive, password=None):
@@ -93,8 +93,8 @@ def test_7z(archive, compression, cmd, verbosity, interactive, password=None):
 test_bzip2 = test_gzip = test_zip = test_compress = test_rar = test_cab = test_chm = (
     test_arj
 ) = test_cpio = test_rpm = test_deb = test_iso = test_xz = test_lzma = test_vhd = (
-    test_7z
-)
+    test_wim
+) = test_7z
 
 
 def create_7z(
@@ -167,3 +167,17 @@ def create_bzip2(
     cmdlist.extend(['-tbzip2', '--', archive])
     cmdlist.extend(filenames)
     return cmdlist
+
+
+def create_wim(
+    archive, compression, cmd, verbosity, interactive, filenames, password=None
+):
+    """Create a WIM archive."""
+    cmdlist = [cmd, 'a']
+    if not interactive:
+        cmdlist.append('-y')
+    if password:
+        cmdlist.append(f'-p{password}')
+    cmdlist.extend(['-twim', '--', archive])
+    cmdlist.extend(filenames)
+    return cmdlist

{patool-3.0.2 → patool-3.0.3}/patoolib/programs/p7zz.py

@@ -28,23 +28,30 @@ extract_bzip2 = extract_gzip = extract_compress = extract_xz = extract_lzma = (
 
 extract_zip = extract_rar = extract_cab = extract_chm = extract_arj = extract_cpio = (
     extract_rpm
-) = extract_deb = extract_iso = extract_vhd = extract_7z
+) = extract_deb = extract_iso = extract_vhd = extract_wim = extract_7z
 
 from .p7zip import list_7z
 
 list_bzip2 = list_gzip = list_zip = list_compress = list_rar = list_cab = list_chm = (
     list_arj
 ) = list_cpio = list_rpm = list_deb = list_iso = list_xz = list_lzma = list_vhd = (
-    list_7z
-)
+    list_wim
+) = list_7z
 
 from .p7zip import test_7z
 
 test_bzip2 = test_gzip = test_zip = test_compress = test_rar = test_cab = test_chm = (
     test_arj
 ) = test_cpio = test_rpm = test_deb = test_iso = test_xz = test_lzma = test_vhd = (
-    test_7z
-)
+    test_wim
+) = test_7z
 
 # ruff: noqa: F401
-from .p7zip import create_7z, create_zip, create_xz, create_gzip, create_bzip2
+from .p7zip import (
+    create_7z,
+    create_zip,
+    create_xz,
+    create_gzip,
+    create_bzip2,
+    create_wim,
+)

{patool-3.0.2 → patool-3.0.3}/patoolib/programs/rar.py

@@ -26,7 +26,7 @@ def extract_rar(
         cmdlist.extend(['-p-', '-y'])
     if password:
         cmdlist.append(f'-p{password}')
-    cmdlist.extend(['--', os.path.abspath(archive)])
+    cmdlist.extend(['-kb', '-or', '--', os.path.abspath(archive)])
     return (cmdlist, {'cwd': outdir})
 
 

{patool-3.0.2 → patool-3.0.3}/patoolib/util.py

@@ -61,16 +61,16 @@ def run(cmd: Sequence[str], verbosity: int = 0, **kwargs) -> int:
         )
     # try to prevent hangs for programs requiring input
     kwargs["input"] = ""
+    if verbosity < 1:
+        # hide command output on stdout
+        kwargs['stdout'] = subprocess.DEVNULL
     if kwargs:
-        if verbosity >= 0:
+        if verbosity > 0:
             info = ", ".join(f"{k}={shell_quote(str(v))}" for k, v in kwargs.items())
             log_info(f"    with {info}")
         if kwargs.get("shell"):
             # for shell calls the command must be a string
             cmd = " ".join(cmd)
-    if verbosity < 1:
-        # hide command output on stdout
-        kwargs['stdout'] = subprocess.DEVNULL
     res = subprocess.run(cmd, **kwargs)
     return res.returncode
 

{patool-3.0.2 → patool-3.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "patool"
-version = "3.0.2"
+version = "3.0.3"
 requires-python = ">=3.10"
 dependencies = []
 # these values are set by setup.py
@@ -20,13 +20,17 @@ argcompletion = [
 [tool.uv]
 dev-dependencies = [
   # for using setuptools.setup() in setup.py
-  "setuptools==75.2.0",
+  "setuptools==75.3.0",
 
   # for testing
   "pytest==8.3.3",
+  # plugin to run tests in parallel
+  "pytest-xdist[psutil]==3.6.1",
+  # plugin to run tests in random order
+  "pytest-randomly==3.16.0",
 
   # for python code linting
-  "ruff==0.7.0",
+  "ruff==0.7.2",
 
   # for python type checking
   "pytype==2024.10.11",
@@ -44,3 +48,8 @@ dev-dependencies = [
   # test optional functionality
   "patool[argcompletion]",
 ]
+
+[tool.patool]
+# pin versions of Python and uv for development
+python_version_dev = "3.12.7"
+uv_version_dev = "0.4.29"

{patool-3.0.2 → patool-3.0.3}/tests/archives/test_7z.py

@@ -31,6 +31,7 @@ class Test7z(ArchiveTest):
         self.archive_commands('t.zip')
         self.archive_commands('t.cbz')
         self.archive_commands('t.txt.xz', check=Content.Singlefile)
+        self.archive_commands('t.wim')
         self.archive_list('t.txt.gz')
         self.archive_list('t.txt.bz2')
         self.archive_list('t.txt.lzma')
@@ -93,6 +94,7 @@ class Test7z(ArchiveTest):
         self.archive_commands(
             't.txt.xz.foo', skip_create=True, check=Content.Singlefile
         )
+        self.archive_commands('t.wim.foo', skip_create=True)
         self.archive_list('t.txt.gz.foo')
         self.archive_list('t.txt.bz2.foo')
         self.archive_list('t.jar.foo')

{patool-3.0.2 → patool-3.0.3}/tests/archives/test_7zz.py

@@ -31,6 +31,7 @@ class Test7zz(ArchiveTest):
         self.archive_commands('t.zip')
         self.archive_commands('t.cbz')
         self.archive_commands('t.txt.xz', check=Content.Singlefile)
+        self.archive_commands('t.wim')
         self.archive_list('t.txt.gz')
         self.archive_list('t.txt.bz2')
         self.archive_list('t.txt.lzma')
@@ -92,6 +93,7 @@ class Test7zz(ArchiveTest):
         self.archive_commands(
             't.txt.xz.foo', skip_create=True, check=Content.Singlefile
         )
+        self.archive_commands('t.wim.foo', skip_create=True)
         self.archive_list('t.txt.gz.foo')
         self.archive_list('t.txt.bz2.foo')
         self.archive_list('t.jar.foo')

{patool-3.0.2 → patool-3.0.3}/tests/archives/test_7zzs.py

@@ -31,6 +31,7 @@ class Test7zzs(ArchiveTest):
         self.archive_commands('t.zip')
         self.archive_commands('t.cbz')
         self.archive_commands('t.txt.xz', check=Content.Singlefile)
+        self.archive_commands('t.wim')
         self.archive_list('t.txt.gz')
         self.archive_list('t.txt.bz2')
         self.archive_list('t.txt.lzma')
@@ -92,6 +93,7 @@ class Test7zzs(ArchiveTest):
         self.archive_commands(
             't.txt.xz.foo', skip_create=True, check=Content.Singlefile
         )
+        self.archive_commands('t.wim.foo', skip_create=True)
         self.archive_list('t.txt.gz.foo')
         self.archive_list('t.txt.bz2.foo')
         self.archive_list('t.jar.foo')

{patool-3.0.2 → patool-3.0.3}/tests/test_mime.py

@@ -174,6 +174,8 @@ class TestMime(unittest.TestCase):
                 "application/vnd.android.package-archive",
             ),
         )
+        self.mime_test_file("t.wim", "application/x-ms-wim")
+        self.mime_test_file("t.wim.foo", "application/x-ms-wim")
         self.mime_test_file("t.zpaq", "application/zpaq")
         self.mime_test_file("t.zpaq.foo", "application/zpaq")
 
@@ -239,6 +241,7 @@ class TestMime(unittest.TestCase):
         self.mime_test_mimedb("t.cpio", "application/x-cpio")
         self.mime_test_mimedb("t.deb", "application/x-debian-package")
         self.mime_test_mimedb("t.gz", "application/gzip")
+        self.mime_test_mimedb("t.GZ", "application/gzip")
         self.mime_test_mimedb("t.jar", "application/java-archive")
         self.mime_test_mimedb("t.lzma", "application/x-lzma")
         self.mime_test_mimedb("t.txt.lz", "application/x-lzip")
@@ -293,4 +296,5 @@ class TestMime(unittest.TestCase):
         self.mime_test_mimedb("t.epub", "application/zip")
         self.mime_test_mimedb("t.apk", "application/zip")
         self.mime_test_mimedb("t.vhd", "application/x-vhd")
+        self.mime_test_mimedb("t.wim", "application/x-ms-wim")
         self.mime_test_mimedb("t.zpaq", "application/zpaq")