73
76
Future calls to load_plugins() will be ignored.
75
global _plugins_disabled
76
_plugins_disabled = True
80
def describe_plugins(show_paths=False):
81
"""Generate text description of plugins.
83
Includes both those that have loaded, and those that failed to
86
:param show_paths: If true,
87
:returns: Iterator of text lines (including newlines.)
89
from inspect import getdoc
90
loaded_plugins = plugins()
91
all_names = sorted(list(set(
92
loaded_plugins.keys() + plugin_warnings.keys())))
93
for name in all_names:
94
if name in loaded_plugins:
95
plugin = loaded_plugins[name]
96
version = plugin.__version__
97
if version == 'unknown':
99
yield '%s %s\n' % (name, version)
100
d = getdoc(plugin.module)
102
doc = d.split('\n')[0]
104
doc = '(no description)'
105
yield (" %s\n" % doc)
107
yield (" %s\n" % plugin.path())
110
yield "%s (failed to load)\n" % name
111
if name in plugin_warnings:
112
for line in plugin_warnings[name]:
113
yield " ** " + line + '\n'
117
81
def _strip_trailing_sep(path):
118
82
return path.rstrip("\\/")
121
def _get_specific_plugin_paths(paths):
122
"""Returns the plugin paths from a string describing the associations.
124
:param paths: A string describing the paths associated with the plugins.
126
:returns: A list of (plugin name, path) tuples.
128
For example, if paths is my_plugin@/test/my-test:her_plugin@/production/her,
129
[('my_plugin', '/test/my-test'), ('her_plugin', '/production/her')]
132
Note that ':' in the example above depends on the os.
137
for spec in paths.split(os.pathsep):
139
name, path = spec.split('@')
141
raise errors.BzrCommandError(gettext(
142
'"%s" is not a valid <plugin_name>@<plugin_path> description ')
144
specs.append((name, path))
148
85
def set_plugins_path(path=None):
149
86
"""Set the path for plugins to be loaded from.
330
251
load_from_dirs = load_from_path
333
def _find_plugin_module(dir, name):
334
"""Check if there is a valid python module that can be loaded as a plugin.
336
:param dir: The directory where the search is performed.
337
:param path: An existing file path, either a python file or a package
340
:return: (name, path, description) name is the module name, path is the
341
file to load and description is the tuple returned by
344
path = osutils.pathjoin(dir, name)
345
if os.path.isdir(path):
346
# Check for a valid __init__.py file, valid suffixes depends on -O and
347
# can be .py, .pyc and .pyo
348
for suffix, mode, kind in imp.get_suffixes():
349
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
350
# We don't recognize compiled modules (.so, .dll, etc)
352
init_path = osutils.pathjoin(path, '__init__' + suffix)
353
if os.path.isfile(init_path):
354
return name, init_path, (suffix, mode, kind)
356
for suffix, mode, kind in imp.get_suffixes():
357
if name.endswith(suffix):
358
# Clean up the module name
359
name = name[:-len(suffix)]
360
if kind == imp.C_EXTENSION and name.endswith('module'):
361
name = name[:-len('module')]
362
return name, path, (suffix, mode, kind)
363
# There is no python module here
364
return None, None, (None, None, None)
367
def record_plugin_warning(plugin_name, warning_message):
368
trace.mutter(warning_message)
369
plugin_warnings.setdefault(plugin_name, []).append(warning_message)
372
def _load_plugin_module(name, dir):
373
"""Load plugin name from dir.
375
:param name: The plugin name in the bzrlib.plugins namespace.
376
:param dir: The directory the plugin is loaded from for error messages.
378
if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
381
exec "import bzrlib.plugins.%s" % name in {}
382
except KeyboardInterrupt:
384
except errors.IncompatibleAPI, e:
386
"Unable to load plugin %r. It requested API version "
387
"%s of module %s but the minimum exported version is %s, and "
388
"the maximum is %s" %
389
(name, e.wanted, e.api, e.minimum, e.current))
390
record_plugin_warning(name, warning_message)
392
trace.warning("%s" % e)
393
if re.search('\.|-| ', name):
394
sanitised_name = re.sub('[-. ]', '_', name)
395
if sanitised_name.startswith('bzr_'):
396
sanitised_name = sanitised_name[len('bzr_'):]
397
trace.warning("Unable to load %r in %r as a plugin because the "
398
"file path isn't a valid module name; try renaming "
399
"it to %r." % (name, dir, sanitised_name))
401
record_plugin_warning(
403
'Unable to load plugin %r from %r' % (name, dir))
404
trace.log_exception_quietly()
405
if 'error' in debug.debug_flags:
406
trace.print_exception(sys.exc_info(), sys.stderr)
409
254
def load_from_dir(d):
410
255
"""Load the plugins in directory d.
412
257
d must be in the plugins module path already.
413
This function is called once for each directory in the module path.
259
# Get the list of valid python suffixes for __init__.py?
260
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
261
# but it doesn't include compiled modules (.so, .dll, etc)
262
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
263
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
264
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
415
265
plugin_names = set()
416
for p in os.listdir(d):
417
name, path, desc = _find_plugin_module(d, p)
419
if name == '__init__':
420
# We do nothing with the __init__.py file in directories from
421
# the bzrlib.plugins module path, we may want to, one day
423
continue # We don't load __init__.py in the plugins dirs
424
elif getattr(_mod_plugins, name, None) is not None:
425
# The module has already been loaded from another directory
426
# during a previous call.
427
# FIXME: There should be a better way to report masked plugins
429
trace.mutter('Plugin name %s already loaded', name)
266
for f in os.listdir(d):
267
path = osutils.pathjoin(d, f)
268
if os.path.isdir(path):
269
for entry in package_entries:
270
# This directory should be a package, and thus added to
272
if os.path.isfile(osutils.pathjoin(path, entry)):
274
else: # This directory is not a package
277
for suffix_info in imp.get_suffixes():
278
if f.endswith(suffix_info[0]):
279
f = f[:-len(suffix_info[0])]
280
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
281
f = f[:-len('module')]
431
plugin_names.add(name)
286
continue # We don't load __init__.py again in the plugin dir
287
elif getattr(_mod_plugins, f, None):
288
trace.mutter('Plugin name %s already loaded', f)
290
# trace.mutter('add plugin name %s', f)
433
293
for name in plugin_names:
434
_load_plugin_module(name, d)
295
exec "import bzrlib.plugins.%s" % name in {}
296
except KeyboardInterrupt:
298
except errors.IncompatibleAPI, e:
299
trace.warning("Unable to load plugin %r. It requested API version "
300
"%s of module %s but the minimum exported version is %s, and "
301
"the maximum is %s" %
302
(name, e.wanted, e.api, e.minimum, e.current))
304
trace.warning("%s" % e)
305
## import pdb; pdb.set_trace()
306
if re.search('\.|-| ', name):
307
sanitised_name = re.sub('[-. ]', '_', name)
308
if sanitised_name.startswith('bzr_'):
309
sanitised_name = sanitised_name[len('bzr_'):]
310
trace.warning("Unable to load %r in %r as a plugin because the "
311
"file path isn't a valid module name; try renaming "
312
"it to %r." % (name, d, sanitised_name))
314
trace.warning('Unable to load plugin %r from %r' % (name, d))
315
trace.log_exception_quietly()
316
if 'error' in debug.debug_flags:
317
trace.print_exception(sys.exc_info(), sys.stderr)
596
477
return version_string
598
479
__version__ = property(_get__version__)
601
class _PluginImporter(object):
602
"""An importer tailored to bzr specific needs.
604
This is a singleton that takes care of:
605
- disabled plugins specified in 'blacklist',
606
- plugins that needs to be loaded from specific directories.
613
self.blacklist = set()
614
self.specific_paths = {}
616
def find_module(self, fullname, parent_path=None):
617
"""Search a plugin module.
619
Disabled plugins raise an import error, plugins with specific paths
620
returns a specific loader.
622
:return: None if the plugin doesn't need special handling, self
625
if not fullname.startswith('bzrlib.plugins.'):
627
if fullname in self.blacklist:
628
raise ImportError('%s is disabled' % fullname)
629
if fullname in self.specific_paths:
633
def load_module(self, fullname):
634
"""Load a plugin from a specific directory."""
635
# We are called only for specific paths
636
plugin_path = self.specific_paths[fullname]
638
if os.path.isdir(plugin_path):
639
for suffix, mode, kind in imp.get_suffixes():
640
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
641
# We don't recognize compiled modules (.so, .dll, etc)
643
init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
644
if os.path.isfile(init_path):
645
# We've got a module here and load_module needs specific
647
loading_path = plugin_path
650
kind = imp.PKG_DIRECTORY
653
for suffix, mode, kind in imp.get_suffixes():
654
if plugin_path.endswith(suffix):
655
loading_path = plugin_path
657
if loading_path is None:
658
raise ImportError('%s cannot be loaded from %s'
659
% (fullname, plugin_path))
660
if kind is imp.PKG_DIRECTORY:
663
f = open(loading_path, mode)
665
mod = imp.load_module(fullname, f, loading_path,
666
(suffix, mode, kind))
667
mod.__package__ = fullname
674
# Install a dedicated importer for plugins requiring special handling
675
PluginImporter = _PluginImporter()
676
sys.meta_path.append(PluginImporter)
added
removed
bzrlib/plugin.py
