32
# Maps format name => export function
34
# Maps filename extensions => export format name
35
_exporter_extensions = {}
38
def register_exporter(format, extensions, func, override=False):
39
"""Register an exporter.
41
:param format: This is the name of the format, such as 'tgz' or 'zip'
42
:param extensions: Extensions which should be used in the case that a
43
format was not explicitly specified.
44
:type extensions: List
45
:param func: The function. It will be called with (tree, dest, root)
46
:param override: Whether to override an object which already exists.
47
Frequently plugins will want to provide functionality
48
until it shows up in mainline, so the default is False.
50
global _exporters, _exporter_extensions
52
if (format not in _exporters) or override:
53
_exporters[format] = func
55
for ext in extensions:
56
if (ext not in _exporter_extensions) or override:
57
_exporter_extensions[ext] = format
60
def register_lazy_exporter(scheme, extensions, module, funcname):
61
"""Register lazy-loaded exporter function.
63
When requesting a specific type of export, load the respective path.
65
def _loader(tree, dest, root, subdir, force_mtime, fileobj):
66
func = pyutils.get_named_object(module, funcname)
67
return func(tree, dest, root, subdir, force_mtime=force_mtime,
70
register_exporter(scheme, extensions, _loader)
73
33
def get_stream_export_generator(tree, name=None, format=None, root=None,
74
34
subdir=None, per_file_timestamps=False):
75
35
"""Returns a generator that exports the given tree as a stream.
143
103
yield temp.read()
146
def get_format_from_filename(name):
147
global _exporter_extensions
149
for ext in _exporter_extensions:
150
if name.endswith(ext):
151
return _exporter_extensions[ext]
154
106
def get_export_generator(tree, dest=None, format=None, root=None, subdir=None,
155
107
per_file_timestamps=False, fileobj=None):
156
108
"""Returns a generator that exports the given tree.
296
248
register_lazy_exporter('dir', [], 'breezy.export.dir_exporter',
297
249
'dir_exporter_generator')
298
register_lazy_exporter('tar', ['.tar'], 'breezy.export.tar_exporter',
299
'plain_tar_exporter_generator')
300
register_lazy_exporter('tgz', ['.tar.gz', '.tgz'],
301
'breezy.export.tar_exporter',
302
'tgz_exporter_generator')
303
register_lazy_exporter('tbz2', ['.tar.bz2', '.tbz2'],
304
'breezy.export.tar_exporter', 'tbz_exporter_generator')
305
register_lazy_exporter('tlzma', ['.tar.lzma'], 'breezy.export.tar_exporter',
306
'tar_lzma_exporter_generator')
307
register_lazy_exporter('txz', ['.tar.xz'], 'breezy.export.tar_exporter',
308
'tar_xz_exporter_generator')
309
register_lazy_exporter('zip', ['.zip'], 'breezy.export.zip_exporter',
310
'zip_exporter_generator')