Merge lp:~vila/bzr/tarball-generator into lp:~xaav/bzr/tarball-generator

[xaav]

[xaav (xaav)]

review: Approve

=== modified file 'bzrlib/export/__init__.py'
--- bzrlib/export/__init__.py	2011-06-06 04:24:34 +0000
+++ bzrlib/export/__init__.py	2011-06-06 14:48:49 +0000
@@ -66,30 +66,36 @@
     register_exporter(scheme, extensions, _loader)
     
 def get_export_generator(tree, dest=None, format=None, root=None, subdir=None,
-                          filtered=False, per_file_timestamps=False, fileobj=None):
-    """Returns a generator that exports the given tree to the specific destination.
+                         filtered=False, per_file_timestamps=False,
+                         fileobj=None):
+    """Returns a generator that exports the given tree.
     
-    The generator is expected to yield None while exporting the tree
+    The generator is expected to yield None while exporting the tree while the
+    actual export is written to ``fileobj``.
 
     :param tree: A Tree (such as RevisionTree) to export
-    :param dest: The destination where the files,etc should be put
+
+    :param dest: The destination where the files, etc should be put
+
     :param format: The format (dir, zip, etc), if None, it will check the
-                   extension on dest, looking for a match
-    :param root: The root location inside the format.
-                 It is common practise to have zipfiles and tarballs
-                 extract into a subdirectory, rather than into the
-                 current working directory.
-                 If root is None, the default root will be
-                 selected as the destination without its
-                 extension.
+        extension on dest, looking for a match
+
+    :param root: The root location inside the format.  It is common practise to
+        have zipfiles and tarballs extract into a subdirectory, rather than
+        into the current working directory.  If root is None, the default root
+        will be selected as the destination without its extension.
+
     :param subdir: A starting directory within the tree. None means to export
         the entire tree, and anything else should specify the relative path to
         a directory to start exporting from.
-    :param filtered: If True, content filtering is applied to the
-                     files exported.
-    :param per_file_timestamps: Whether to use the timestamp stored in the 
-        tree rather than now(). This will do a revision lookup 
-        for every file so will be significantly slower.
+
+    :param filtered: If True, content filtering is applied to the exported
+        files.
+
+    :param per_file_timestamps: Whether to use the timestamp stored in the tree
+        rather than now(). This will do a revision lookup for every file so
+        will be significantly slower.
+
     :param fileobj: Optional file object to use
     """
     global _exporters, _exporter_extensions
@@ -118,7 +124,8 @@
     try:
         tree.lock_read()
     
-        for _ in _exporters[format](tree, dest, root, subdir, filtered=filtered, 
+        for _ in _exporters[format](tree, dest, root, subdir,
+                                    filtered=filtered, 
                                     force_mtime=force_mtime, fileobj=fileobj):
             
             yield
@@ -206,12 +213,20 @@
         yield final_path, entry
 
 
-register_lazy_exporter(None, [], 'bzrlib.export.dir_exporter', 'dir_exporter_generator')
-register_lazy_exporter('dir', [], 'bzrlib.export.dir_exporter', 'dir_exporter_generator')
-register_lazy_exporter('tar', ['.tar'], 'bzrlib.export.tar_exporter', 'plain_tar_exporter_generator')
-register_lazy_exporter('tgz', ['.tar.gz', '.tgz'], 'bzrlib.export.tar_exporter', 'tgz_exporter_generator')
-register_lazy_exporter('tbz2', ['.tar.bz2', '.tbz2'], 'bzrlib.export.tar_exporter', 'tbz_exporter_generator')
-register_lazy_exporter('tlzma', ['.tar.lzma'], 'bzrlib.export.tar_exporter', 'tar_lzma_exporter_generator')
-register_lazy_exporter('txz', ['.tar.xz'], 'bzrlib.export.tar_exporter', 'tar_xz_exporte_generatorr')
-register_lazy_exporter('zip', ['.zip'], 'bzrlib.export.zip_exporter', 'zip_exporter_generator')
+register_lazy_exporter(None, [], 'bzrlib.export.dir_exporter',
+                       'dir_exporter_generator')
+register_lazy_exporter('dir', [], 'bzrlib.export.dir_exporter',
+                       'dir_exporter_generator')
+register_lazy_exporter('tar', ['.tar'], 'bzrlib.export.tar_exporter',
+                       'plain_tar_exporter_generator')
+register_lazy_exporter('tgz', ['.tar.gz', '.tgz'], 'bzrlib.export.tar_exporter',
+                       'tgz_exporter_generator')
+register_lazy_exporter('tbz2', ['.tar.bz2', '.tbz2'],
+                       'bzrlib.export.tar_exporter', 'tbz_exporter_generator')
+register_lazy_exporter('tlzma', ['.tar.lzma'], 'bzrlib.export.tar_exporter',
+                       'tar_lzma_exporter_generator')
+register_lazy_exporter('txz', ['.tar.xz'], 'bzrlib.export.tar_exporter',
+                       'tar_xz_exporte_generatorr')
+register_lazy_exporter('zip', ['.zip'], 'bzrlib.export.zip_exporter',
+                       'zip_exporter_generator')
 

=== modified file 'bzrlib/export/dir_exporter.py'
--- bzrlib/export/dir_exporter.py	2011-06-03 17:37:56 +0000
+++ bzrlib/export/dir_exporter.py	2011-06-06 14:48:49 +0000
@@ -27,7 +27,7 @@
     )
 
 
-def dir_exporter_generator(tree, dest, root, subdir=None, filtered=False, 
+def dir_exporter_generator(tree, dest, root, subdir=None, filtered=False,
                            force_mtime=None, fileobj=None):
     """Return a generator that exports this tree to a new directory.
 
@@ -45,7 +45,8 @@
         if e.errno == errno.EEXIST:
             # check if directory empty
             if os.listdir(dest) != []:
-                raise errors.BzrError("Can't export tree to non-empty directory.")
+                raise errors.BzrError(
+                    "Can't export tree to non-empty directory.")
         else:
             raise
     # Iterate everything, building up the files we will want to export, and
@@ -105,4 +106,4 @@
 
     for _ in dir_exporter_generator(tree, dest, root, subdir, filtered,
                                     force_mtime, fileobj):
-        pass
\ No newline at end of file
+        pass

=== modified file 'bzrlib/export/tar_exporter.py'
--- bzrlib/export/tar_exporter.py	2011-06-03 17:33:02 +0000
+++ bzrlib/export/tar_exporter.py	2011-06-06 14:48:49 +0000
@@ -31,19 +31,22 @@
     filtered_output_bytes,
     )
 
-def prepare_tarball_item(tree, root, final_path, entry, filtered=False, 
+def prepare_tarball_item(tree, root, final_path, entry, filtered=False,
                          force_mtime=None):
     """Prepare a tarball item for exporting
         
     :param tree: Tree to export
+
     :param final_path: Final path to place item
+
     :param entry: Entry to export
+
     :param filtered: Whether to apply filters
+
     :param force_mtime: Option mtime to force, instead of using tree timestamps.
     
     Returns a (tarinfo, fileobj) tuple
     """
-    
     filename = osutils.pathjoin(root, final_path).encode('utf8')
     item = tarfile.TarInfo(filename)
     if force_mtime is not None:
@@ -85,40 +88,45 @@
     
     return (item, fileobj)
 
-def export_tarball_generator(tree, ball, root, subdir=None, filtered=False, 
+def export_tarball_generator(tree, ball, root, subdir=None, filtered=False,
                    force_mtime=None):
     """Export tree contents to a tarball. This is a generator.
 
     :param tree: Tree to export
+
     :param ball: Tarball to export to
+
     :param filtered: Whether to apply filters
+
     :param subdir: Sub directory to export
-    :param force_mtime: Option mtime to force, instead of using
-        tree timestamps.
+
+    :param force_mtime: Option mtime to force, instead of using tree
+        timestamps.
     """
     for final_path, entry in _export_iter_entries(tree, subdir):
 
-        (item, fileobj) = prepare_tarball_item(tree, root, final_path, 
+        (item, fileobj) = prepare_tarball_item(tree, root, final_path,
                                                entry, filtered, force_mtime)
         ball.addfile(item, fileobj)
-        
-        yield    
-        
-def export_tarball(tree, ball, root, subdir=None, filtered=False, force_mtime=None):
-    
-    for _ in export_tarball_generator(tree, ball, root, subdir, filtered, force_mtime):
-        
+
+        yield
+
+
+def export_tarball(tree, ball, root, subdir=None, filtered=False,
+                   force_mtime=None):
+
+    for _ in export_tarball_generator(tree, ball, root, subdir, filtered,
+                                      force_mtime):
         pass
 
-def tgz_exporter_generator(tree, dest, root, subdir, filtered=False, force_mtime=None, 
-                 fileobj=None):
+def tgz_exporter_generator(tree, dest, root, subdir, filtered=False,
+                           force_mtime=None, fileobj=None):
     """Export this tree to a new tar file.
 
     `dest` will be created holding the contents of this tree; if it
     already exists, it will be clobbered, like with "tar -c".
     """
     import gzip
-    
     if force_mtime is not None:
         root_mtime = force_mtime
     elif (getattr(tree, "repository", None) and
@@ -132,7 +140,6 @@
         root_mtime = None
 
     is_stdout = False
-    
     if fileobj is not None:
         stream = fileobj
     elif dest == '-':
@@ -146,32 +153,33 @@
         # dest. (bug 102234)
         basename = os.path.basename(dest)
     try:
-        zipstream = gzip.GzipFile(basename, 'w', fileobj=stream, 
+        zipstream = gzip.GzipFile(basename, 'w', fileobj=stream,
                                   mtime=root_mtime)
     except TypeError:
         # Python < 2.7 doesn't support the mtime argument
         zipstream = gzip.GzipFile(basename, 'w', fileobj=stream)
     ball = tarfile.open(None, 'w|', fileobj=zipstream)
 
-    for _ in export_tarball_generator(tree, ball, root, subdir, filtered, force_mtime):
-        
+    for _ in export_tarball_generator(tree, ball, root, subdir, filtered,
+                                      force_mtime):
+
         yield
 
     zipstream.close()
-    
     if not is_stdout:
         stream.close()
-        
-def tgz_exporter(tree, dest, root, subdir, filtered=False, force_mtime=None, fileobj=None):
-    
-    for _ in tgz_exporter_generator(tree, dest, root, subdir, filtered, force_mtime, 
-                                    fileobj):
-        
+
+
+def tgz_exporter(tree, dest, root, subdir, filtered=False, force_mtime=None,
+                 fileobj=None):
+
+    for _ in tgz_exporter_generator(tree, dest, root, subdir, filtered,
+                                    force_mtime, fileobj):
         pass
 
 
-def tbz_exporter_generator(tree, dest, root, subdir, filtered=False, force_mtime=None,
-                 fileobj=None):
+def tbz_exporter_generator(tree, dest, root, subdir, filtered=False,
+                           force_mtime=None, fileobj=None):
     """Export this tree to a new tar file.
 
     `dest` will be created holding the contents of this tree; if it
@@ -189,76 +197,80 @@
         # (fixed in Python 2.6.5 and 2.7b1)
         ball = tarfile.open(dest.encode(osutils._fs_enc), 'w:bz2')
 
-    for _ in export_tarball_generator(tree, ball, root, subdir, filtered, force_mtime):
-        
+    for _ in export_tarball_generator(tree, ball, root, subdir, filtered,
+                                      force_mtime):
         yield
 
     ball.close()
-    
+
+
 def tbz_exporter(tree, dest, root, subdir, filtered=False, force_mtime=None,
                  fileobj=None):
-    
-    for _ in tbz_exporter_generator(tree, dest, root, subdir, filtered, force_mtime, 
-                                    fileobj):
+
+    for _ in tbz_exporter_generator(tree, dest, root, subdir, filtered,
+                                    force_mtime, fileobj):
         pass
 
 
-def plain_tar_exporter_generator(tree, dest, root, subdir, compression=None, filtered=False,
-                                force_mtime=None, fileobj=None):
+def plain_tar_exporter_generator(tree, dest, root, subdir, compression=None,
+                                 filtered=False, force_mtime=None,
+                                 fileobj=None):
     """Export this tree to a new tar file.
 
     `dest` will be created holding the contents of this tree; if it
     already exists, it will be clobbered, like with "tar -c".
     """
     if fileobj is not None:
-        stream = fileobj  
+        stream = fileobj
     elif dest == '-':
         stream = sys.stdout
     else:
         stream = open(dest, 'wb')
     ball = tarfile.open(None, 'w|', stream)
 
-    for _ in export_tarball_generator(tree, ball, root, subdir, filtered, force_mtime):
+    for _ in export_tarball_generator(tree, ball, root, subdir, filtered,
+                                      force_mtime):
 
         yield
 
     ball.close()
-    
-def plain_tar_exporter(tree, dest, root, subdir, compression=None, filtered=False, 
-                       force_mtime=None, fileobj=None):
-    
-    for _ in plain_tar_exporter_generator(tree, dest, root, subdir, compression, 
-                                          filtered, force_mtime, fileobj): 
-        pass 
-
-
-def tar_xz_exporter_generator(tree, dest, root, subdir, filtered=False, force_mtime=None,
-                     fileobj=None):
-    
-    return tar_lzma_exporter_generator(tree, dest, root, subdir, filtered, force_mtime,
-                              fileobj, "xz")
-    
+
+def plain_tar_exporter(tree, dest, root, subdir, compression=None,
+                       filtered=False, force_mtime=None, fileobj=None):
+
+    for _ in plain_tar_exporter_generator(
+        tree, dest, root, subdir, compression, filtered, force_mtime, fileobj):
+        pass
+
+
+def tar_xz_exporter_generator(tree, dest, root, subdir, filtered=False,
+                              force_mtime=None, fileobj=None):
+
+    return tar_lzma_exporter_generator(tree, dest, root, subdir, filtered,
+                                       force_mtime, fileobj, "xz")
+
+
 def tar_xz_exporter(tree, dest, root, subdir, filtered=False, force_mtime=None,
                      fileobj=None):
-    for _ in tar_xz_exporter_generator(tree, dest, root, subdir, filtered, force_mtime,
-                                       fileobj):
+    for _ in tar_xz_exporter_generator(tree, dest, root, subdir, filtered,
+                                       force_mtime, fileobj):
         pass
 
 
-def tar_lzma_exporter_generator(tree, dest, root, subdir, filtered=False, 
-                      force_mtime=None, fileobj=None, compression_format="alone"):
+def tar_lzma_exporter_generator(tree, dest, root, subdir, filtered=False,
+                      force_mtime=None, fileobj=None,
+                                compression_format="alone"):
     """Export this tree to a new .tar.lzma file.
 
     `dest` will be created holding the contents of this tree; if it
     already exists, it will be clobbered, like with "tar -c".
     """
-    
     if dest == '-':
         raise errors.BzrError("Writing to stdout not supported for .tar.lzma")
 
     if fileobj is not None:
-        raise errors.BzrError("Writing to fileobject not supported for .tar.lzma")
-        
+        raise errors.BzrError(
+            "Writing to fileobject not supported for .tar.lzma")
     try:
         import lzma
     except ImportError, e:
@@ -268,17 +280,17 @@
             options={"format": compression_format})
     ball = tarfile.open(None, 'w:', fileobj=stream)
 
-    for _ in export_tarball_generator(tree, ball, root, subdir, filtered=filtered, 
-                            force_mtime=force_mtime):
-        
+    for _ in export_tarball_generator(
+        tree, ball, root, subdir, filtered=filtered, force_mtime=force_mtime):
         yield
 
     ball.close()
 
-def tar_lzma_exporter(tree, dest, root, subdir, filtered=False, force_mtime=None,
-                  fileobj=None, compression_format="alone"):
-    
-    for _ in tar_lzma_exporter_generator(tree, dest, root, subdir, filtered, force_mtime,
-                                         fileobj, compression_format):
-        
+
+def tar_lzma_exporter(tree, dest, root, subdir, filtered=False,
+                      force_mtime=None, fileobj=None,
+                      compression_format="alone"):
+    for _ in tar_lzma_exporter_generator(tree, dest, root, subdir, filtered,
+                                         force_mtime, fileobj,
+                                         compression_format):
         pass