bzrlib.export.tar_exporter : API documentation

Function	prepare_tarball_item	Prepare a tarball item for exporting
Function	export_tarball_generator	Export tree contents to a tarball.
Function	tgz_exporter_generator	Export this tree to a new tar file.
Function	tbz_exporter_generator	Export this tree to a new tar file.
Function	plain_tar_exporter_generator	Export this tree to a new tar file.
Function	tar_xz_exporter_generator	Undocumented
Function	tar_lzma_exporter_generator	Export this tree to a new .tar.lzma file.

def prepare_tarball_item(tree, root, final_path, entry, force_mtime=None):

Prepare a tarball item for exporting

Returns a (tarinfo, fileobj) tuple

Parameters	tree	Tree to export
	final_path	Final path to place item
	entry	Entry to export
	force_mtime	Option mtime to force, instead of using tree timestamps.

def export_tarball_generator(tree, ball, root, subdir=None, force_mtime=None):

Export tree contents to a tarball.

Parameters	tree	Tree to export
	ball	Tarball to export to; it will be closed when writing is complete.
	subdir	Sub directory to export
	force_mtime	Option mtime to force, instead of using tree timestamps.
Returns	A generator that will repeatedly produce None as each file is emitted. The entire generator must be consumed to complete writing the file.

def tgz_exporter_generator(tree, dest, root, subdir, 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".

def tbz_exporter_generator(tree, dest, root, subdir, 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".

def plain_tar_exporter_generator(tree, dest, root, subdir, compression=None, 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".

def tar_xz_exporter_generator(tree, dest, root, subdir, force_mtime=None, fileobj=None):

Undocumented

def tar_lzma_exporter_generator(tree, dest, root, subdir, 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".

b.e.tar_exporter : module documentation