From 8987927edb79092bc51e877fce5f10fc6ee876c8 Mon Sep 17 00:00:00 2001
From: Bastian Kleineidam <calvin@debian.org>
Date: Mon, 9 Apr 2012 12:23:02 +0200
Subject: [PATCH] Added convenience library functions for handling archives.

---
 doc/changelog.txt    |  4 ++-
 patoolib/__init__.py | 76 +++++++++++++++++++++++++++++++-------------
 2 files changed, 57 insertions(+), 23 deletions(-)

diff --git a/doc/changelog.txt b/doc/changelog.txt
index 2cb7862..0c5aa12 100644
--- a/doc/changelog.txt
+++ b/doc/changelog.txt
@@ -1,7 +1,9 @@
 0.16 "" (released xx.xx.2012)
 
   * Document the --outdir option for the extract command.
-    Closes: SF Bug #3363964
+    Closes: SF bug #3363964
+  * Added convenience library function to handle archives.
+    Closes: SF bug #3351936
 
 0.15 "Contraband" (released 8.4.2012)
 
diff --git a/patoolib/__init__.py b/patoolib/__init__.py
index 10f3539..391484c 100644
--- a/patoolib/__init__.py
+++ b/patoolib/__init__.py
@@ -462,28 +462,6 @@ def get_archive_cmdlist_func (program, command, format):
     return locals()['func']
 
 
-def handle_archive (archive, command, *args, **kwargs):
-    """Handle archive file command; with nice error reporting."""
-    try:
-        if command == "diff":
-            res = _diff_archives(archive, args[0])
-        elif command == "repack":
-            res = _repack_archive(archive, args[0])
-        else:
-            _handle_archive(archive, command, *args, **kwargs)
-            res = 0
-    except KeyboardInterrupt, msg:
-        util.log_info("aborted")
-        res = 1
-    except util.PatoolError, msg:
-        util.log_error(msg)
-        res = 1
-    except StandardError, msg:
-        util.log_internal_error()
-        res = 1
-    return res
-
-
 def rmtree_log_error (func, path, exc):
     """Error function for shutil.rmtree(). Raises a PatoolError."""
     msg = "Error in %s(%s): %s" % (func.__name__, path, str(exc[1]))
@@ -518,3 +496,57 @@ def _repack_archive (archive1, archive2):
         return 0
     finally:
         shutil.rmtree(tmpdir, onerror=rmtree_log_error)
+
+
+def handle_archive (archive, command, *args, **kwargs):
+    """Handle archive file command; with nice error reporting."""
+    try:
+        if command == "diff":
+            res = _diff_archives(archive, args[0])
+        elif command == "repack":
+            res = _repack_archive(archive, args[0])
+        else:
+            _handle_archive(archive, command, *args, **kwargs)
+            res = 0
+    except KeyboardInterrupt, msg:
+        util.log_info("aborted")
+        res = 1
+    except util.PatoolError, msg:
+        util.log_error(msg)
+        res = 1
+    except StandardError, msg:
+        util.log_internal_error()
+        res = 1
+    return res
+
+
+# convenience functions
+
+def extract (archive, verbose=False, outdir=None):
+    """Extract given archive."""
+    return handle_archive(archive, 'extract', verbose=verbose, outdir=outdir)
+
+
+def list (archive, verbose=False):
+    """List given archive."""
+    return handle_archive(archive, 'list', verbose=verbose)
+
+
+def test (archive, verbose=False):
+    """Test given archive."""
+    return handle_archive(archive, 'test', verbose=verbose)
+
+
+def create (archive, *files, verbose=False):
+    """Create given archive with given files."""
+    return handle_archive(archive, 'create', *files, verbose=verbose)
+
+
+def diff (archive1, archive2, verbose=False):
+    """Print differences between two archives."""
+    return handle_archive(archive1, 'diff', archive2, verbose=verbose)
+
+
+def repack (archive1, archive2, verbose=False):
+    """Repacke archive to different file and/or format."""
+    return handle_archive(archive1, 'repack', archive2, verbose=verbose)