patool 2.3.0__tar.gz → 2.4.0__tar.gz

{patool-2.3.0 → patool-2.4.0}/Makefile

@@ -27,7 +27,7 @@ HOMEPAGE:=$(HOME)/public_html/patool-webpage.git
 WEBMETA:=doc/web/source/conf.py
 CHANGELOG:=doc/changelog.txt
 GIT_MAIN_BRANCH:=master
-PIP_VERSION:=24.1
+PIP_VERSION:=24.2
 # Pytest options:
 # -s: do not capture stdout/stderr (some tests fail otherwise)
 # --full-trace: print full stacktrace on keyboard interrupts
@@ -89,7 +89,11 @@ upload: ## upload a new release to pypi
 
 .PHONY: hub
 hub: ## add and push a github release
-	hub release create -a dist/$(ARCHIVE_SOURCE) -a dist/$(ARCHIVE_WHEEL) upstream/$(VERSION)
+	hub release create \
+	  -a dist/$(ARCHIVE_SOURCE) \
+	  -a dist/$(ARCHIVE_WHEEL) \
+	  -m "Release $(VERSION)" \ 
+	  upstream/$(VERSION)
 
 # Make a new release by calling all the distinct steps in the correct order.
 # Each step is a separate target so that it's easy to do this manually if

{patool-2.3.0/patool.egg-info → patool-2.4.0}/PKG-INFO

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

{patool-2.3.0 → patool-2.4.0}/doc/changelog.txt

@@ -1,3 +1,11 @@
+2.4.0 (released 21.08.2024)
+  * Document that patool extracts the archive for the search and repack commands.
+    Closes: GH bug #154
+  * Add supported_formats() API function listing supported formats and operations
+    for each format.
+    Idea and patch by github user nohr-ai, thanks!
+
+
 2.3.0 (released 26.06.2024)
   * Add linting check to github workflow CI.
     Idea and patch by sorairolake, thanks!

{patool-2.3.0 → patool-2.4.0}/doc/patool.1

@@ -127,14 +127,15 @@ The diff options used are \fB\-urN\fP.
 .SS search
 \fBpatool\fP \fBsearch\fP <\fIpattern\fP> <\fIarchive\fP>
 .PP
-Search in archive contents for given pattern using the \fBgrep(1)\fP program.
+Unpack the given archive in a temporary directory and search in archive
+contents for given pattern using the \fBgrep(1)\fP program.
 The grep options used are \fB\-r\fP; additional options can be supplied
 with the \fBGREP_OPTIONS\fP environment variable.
 .SS repack
 \fBpatool\fP \fBrepack\fP <\fIarchive\fP> <\fIarchive_new\fP>
 .PP
-Repackage archive to a different format. The target archive format is
-determined by the file extension of \fIarchive_new\fP.
+Extract and re-compress archive to a different format.
+The target archive format is determined by the file extension of \fIarchive_new\fP.
 .SS formats
 \fBpatool\fP \fBformats\fP
 .PP

{patool-2.3.0 → patool-2.4.0}/doc/patool.txt

@@ -125,15 +125,17 @@ COMMANDS
    search
        patool search <pattern> <archive>
 
-       Search in archive contents for given pattern using the  grep(1)
-       program.   The grep options used are -r; additional options can
-       be supplied with the GREP_OPTIONS environment variable.
+       Unpack the given archive in a temporary directory and search in
+       archive  contents  for given pattern using the grep(1) program.
+       The grep options used are -r; additional options  can  be  sup‐
+       plied with the GREP_OPTIONS environment variable.
 
    repack
        patool repack <archive> <archive_new>
 
-       Repackage archive to a different  format.  The  target  archive
-       format is determined by the file extension of archive_new.
+       Extract  and  re-compress  archive  to a different format.  The
+       target archive format is determined by the  file  extension  of
+       archive_new.
 
    formats
        patool formats

{patool-2.3.0 → patool-2.4.0/patool.egg-info}/PKG-INFO

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

{patool-2.3.0 → patool-2.4.0}/patoolib/__init__.py

@@ -31,6 +31,7 @@ from . import fileutil, log, util
 # export API functions
 __all__ = [
     'list_formats',
+    'supported_formats',
     'list_archive',
     'extract_archive',
     'test_archive',
@@ -605,7 +606,7 @@ def list_formats():
         for command in ArchiveCommands:
             programs = ArchivePrograms[format]
             if command not in programs and None not in programs:
-                print("   {command:>8}: - (not supported)")
+                print(f"   {command:>8}: - (not supported)")
                 continue
             try:
                 program = find_archive_program(format, command)
@@ -631,6 +632,28 @@ def list_formats():
                 )
 
 
+def supported_formats(operations=ArchiveCommands):
+    """Return a list of supported archive formats for an iterable of operations.
+
+    :param operations: The operations to check for, defaults to ArchiveCommands.
+    :type operations:  List|Tuple|Set|Dict[str]
+    :return:           A list of supported archive formats.
+    :rtype:            List[str]
+    """
+    supported = list(ArchiveFormats)
+    for format in ArchiveFormats:
+        # NOTE: If we wish to include supported formats in the CLI
+        # argparse default nargs to an empty list, so we would need some
+        # check to set operations to ArchiveCommands if bool(operations) is False.
+        for command in operations:
+            try:
+                find_archive_program(format, command)
+            except util.PatoolError:
+                supported.remove(format)
+                break
+    return supported
+
+
 def check_program_compression(archive, command, program, compression):
     """Check if a program supports the given compression."""
     program = os.path.basename(program)

{patool-2.3.0 → patool-2.4.0}/patoolib/configuration.py

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