1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""bzr python plugin support.
20
When load_plugins() is invoked, any python module in any directory in
21
$BZR_PLUGIN_PATH will be imported. The module will be imported as
22
'bzrlib.plugins.$BASENAME(PLUGIN)'. In the plugin's main body, it should
23
update any bzrlib registries it wants to extend.
25
See the plugin-api developer documentation for information about writing
28
BZR_PLUGIN_PATH is also honoured for any plugins imported via
29
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
36
from bzrlib import osutils
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
45
_format_version_tuple,
51
from bzrlib import plugins as _mod_plugins
55
DEFAULT_PLUGIN_PATH = None
57
_plugins_disabled = False
61
# Map from plugin name, to list of string warnings about eg plugin
65
def are_plugins_disabled():
66
return _plugins_disabled
69
def disable_plugins():
70
"""Disable loading plugins.
72
Future calls to load_plugins() will be ignored.
74
global _plugins_disabled
75
_plugins_disabled = True
79
def describe_plugins(show_paths=False):
80
"""Generate text description of plugins.
82
Includes both those that have loaded, and those that failed to
85
:param show_paths: If true,
86
:returns: Iterator of text lines (including newlines.)
88
from inspect import getdoc
89
loaded_plugins = plugins()
90
all_names = sorted(list(set(
91
loaded_plugins.keys() + plugin_warnings.keys())))
92
for name in all_names:
93
if name in loaded_plugins:
94
plugin = loaded_plugins[name]
95
version = plugin.__version__
96
if version == 'unknown':
98
yield '%s %s\n' % (name, version)
99
d = getdoc(plugin.module)
101
doc = d.split('\n')[0]
103
doc = '(no description)'
104
yield (" %s\n" % doc)
106
yield (" %s\n" % plugin.path())
109
yield "%s (failed to load)\n" % name
110
if name in plugin_warnings:
111
for line in plugin_warnings[name]:
112
yield " ** " + line + '\n'
116
def _strip_trailing_sep(path):
117
return path.rstrip("\\/")
120
def _get_specific_plugin_paths(paths):
121
"""Returns the plugin paths from a string describing the associations.
123
:param paths: A string describing the paths associated with the plugins.
125
:returns: A list of (plugin name, path) tuples.
127
For example, if paths is my_plugin@/test/my-test:her_plugin@/production/her,
128
[('my_plugin', '/test/my-test'), ('her_plugin', '/production/her')]
131
Note that ':' in the example above depends on the os.
136
for spec in paths.split(os.pathsep):
138
name, path = spec.split('@')
140
raise errors.BzrCommandError(
141
'"%s" is not a valid <plugin_name>@<plugin_path> description '
143
specs.append((name, path))
147
def set_plugins_path(path=None):
148
"""Set the path for plugins to be loaded from.
150
:param path: The list of paths to search for plugins. By default,
151
path will be determined using get_standard_plugins_path.
152
if path is [], no plugins can be loaded.
155
path = get_standard_plugins_path()
156
_mod_plugins.__path__ = path
157
PluginImporter.reset()
158
# Set up a blacklist for disabled plugins
159
disabled_plugins = os.environ.get('BZR_DISABLE_PLUGINS', None)
160
if disabled_plugins is not None:
161
for name in disabled_plugins.split(os.pathsep):
162
PluginImporter.blacklist.add('bzrlib.plugins.' + name)
163
# Set up a the specific paths for plugins
164
for plugin_name, plugin_path in _get_specific_plugin_paths(os.environ.get(
165
'BZR_PLUGINS_AT', None)):
166
PluginImporter.specific_paths[
167
'bzrlib.plugins.%s' % plugin_name] = plugin_path
171
def _append_new_path(paths, new_path):
172
"""Append a new path if it set and not already known."""
173
if new_path is not None and new_path not in paths:
174
paths.append(new_path)
178
def get_core_plugin_path():
180
bzr_exe = bool(getattr(sys, 'frozen', None))
181
if bzr_exe: # expand path for bzr.exe
182
# We need to use relative path to system-wide plugin
183
# directory because bzrlib from standalone bzr.exe
184
# could be imported by another standalone program
185
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
186
# will become standalone exe). [bialix 20071123]
187
# __file__ typically is
188
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
189
# then plugins directory is
190
# C:\Program Files\Bazaar\plugins
191
# so relative path is ../../../plugins
192
core_path = osutils.abspath(osutils.pathjoin(
193
osutils.dirname(__file__), '../../../plugins'))
194
else: # don't look inside library.zip
195
# search the plugin path before the bzrlib installed dir
196
core_path = os.path.dirname(_mod_plugins.__file__)
200
def get_site_plugin_path():
201
"""Returns the path for the site installed plugins."""
202
if sys.platform == 'win32':
203
# We don't have (yet) a good answer for windows since that is certainly
204
# related to the way we build the installers. -- vila20090821
208
from distutils.sysconfig import get_python_lib
210
# If distutuils is not available, we just don't know where they are
213
site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
217
def get_user_plugin_path():
218
return osutils.pathjoin(config.config_dir(), 'plugins')
221
def get_standard_plugins_path():
222
"""Determine a plugin path suitable for general use."""
223
# Ad-Hoc default: core is not overriden by site but user can overrides both
224
# The rationale is that:
225
# - 'site' comes last, because these plugins should always be available and
226
# are supposed to be in sync with the bzr installed on site.
227
# - 'core' comes before 'site' so that running bzr from sources or a user
228
# installed version overrides the site version.
229
# - 'user' comes first, because... user is always right.
230
# - the above rules clearly defines which plugin version will be loaded if
231
# several exist. Yet, it is sometimes desirable to disable some directory
232
# so that a set of plugins is disabled as once. This can be done via
233
# -site, -core, -user.
235
env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
236
defaults = ['+core', '+site']
238
# The predefined references
239
refs = dict(core=get_core_plugin_path(),
240
site=get_site_plugin_path(),
241
user=get_user_plugin_path())
243
# Unset paths that should be removed
244
for k,v in refs.iteritems():
246
# defaults can never mention removing paths as that will make it
247
# impossible for the user to revoke these removals.
248
if removed in env_paths:
249
env_paths.remove(removed)
254
for p in env_paths + defaults:
255
if p.startswith('+'):
256
# Resolve references if they are known
260
# Leave them untouched so user can still use paths starting
263
_append_new_path(paths, p)
265
# Get rid of trailing slashes, since Python can't handle them when
266
# it tries to import modules.
267
paths = map(_strip_trailing_sep, paths)
271
def load_plugins(path=None):
272
"""Load bzrlib plugins.
274
The environment variable BZR_PLUGIN_PATH is considered a delimited
275
set of paths to look through. Each entry is searched for `*.py`
276
files (and whatever other extensions are used in the platform,
279
load_from_path() provides the underlying mechanism and is called with
280
the default directory list to provide the normal behaviour.
282
:param path: The list of paths to search for plugins. By default,
283
path will be determined using get_standard_plugins_path.
284
if path is [], no plugins can be loaded.
288
# People can make sure plugins are loaded, they just won't be twice
292
# scan for all plugins in the path.
293
load_from_path(set_plugins_path(path))
296
def load_from_path(dirs):
297
"""Load bzrlib plugins found in each dir in dirs.
299
Loading a plugin means importing it into the python interpreter.
300
The plugin is expected to make calls to register commands when
301
it's loaded (or perhaps access other hooks in future.)
303
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
304
for future reference.
306
The python module path for bzrlib.plugins will be modified to be 'dirs'.
308
# Explicitly load the plugins with a specific path
309
for fullname, path in PluginImporter.specific_paths.iteritems():
310
name = fullname[len('bzrlib.plugins.'):]
311
_load_plugin_module(name, path)
313
# We need to strip the trailing separators here as well as in the
314
# set_plugins_path function because calling code can pass anything in to
315
# this function, and since it sets plugins.__path__, it should set it to
316
# something that will be valid for Python to use (in case people try to
317
# run "import bzrlib.plugins.PLUGINNAME" after calling this function).
318
_mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
322
trace.mutter('looking for plugins in %s', d)
327
# backwards compatability: load_from_dirs was the old name
328
# This was changed in 0.15
329
load_from_dirs = load_from_path
332
def _find_plugin_module(dir, name):
333
"""Check if there is a valid python module that can be loaded as a plugin.
335
:param dir: The directory where the search is performed.
336
:param path: An existing file path, either a python file or a package
339
:return: (name, path, description) name is the module name, path is the
340
file to load and description is the tuple returned by
343
path = osutils.pathjoin(dir, name)
344
if os.path.isdir(path):
345
# Check for a valid __init__.py file, valid suffixes depends on -O and
346
# can be .py, .pyc and .pyo
347
for suffix, mode, kind in imp.get_suffixes():
348
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
349
# We don't recognize compiled modules (.so, .dll, etc)
351
init_path = osutils.pathjoin(path, '__init__' + suffix)
352
if os.path.isfile(init_path):
353
return name, init_path, (suffix, mode, kind)
355
for suffix, mode, kind in imp.get_suffixes():
356
if name.endswith(suffix):
357
# Clean up the module name
358
name = name[:-len(suffix)]
359
if kind == imp.C_EXTENSION and name.endswith('module'):
360
name = name[:-len('module')]
361
return name, path, (suffix, mode, kind)
362
# There is no python module here
363
return None, None, (None, None, None)
366
def record_plugin_warning(plugin_name, warning_message):
367
trace.mutter(warning_message)
368
plugin_warnings.setdefault(plugin_name, []).append(warning_message)
371
def _load_plugin_module(name, dir):
372
"""Load plugin name from dir.
374
:param name: The plugin name in the bzrlib.plugins namespace.
375
:param dir: The directory the plugin is loaded from for error messages.
377
if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
380
exec "import bzrlib.plugins.%s" % name in {}
381
except KeyboardInterrupt:
383
except errors.IncompatibleAPI, e:
385
"Unable to load plugin %r. It requested API version "
386
"%s of module %s but the minimum exported version is %s, and "
387
"the maximum is %s" %
388
(name, e.wanted, e.api, e.minimum, e.current))
389
record_plugin_warning(name, warning_message)
391
trace.warning("%s" % e)
392
if re.search('\.|-| ', name):
393
sanitised_name = re.sub('[-. ]', '_', name)
394
if sanitised_name.startswith('bzr_'):
395
sanitised_name = sanitised_name[len('bzr_'):]
396
trace.warning("Unable to load %r in %r as a plugin because the "
397
"file path isn't a valid module name; try renaming "
398
"it to %r." % (name, dir, sanitised_name))
400
record_plugin_warning(
402
'Unable to load plugin %r from %r' % (name, dir))
403
trace.log_exception_quietly()
404
if 'error' in debug.debug_flags:
405
trace.print_exception(sys.exc_info(), sys.stderr)
408
def load_from_dir(d):
409
"""Load the plugins in directory d.
411
d must be in the plugins module path already.
412
This function is called once for each directory in the module path.
415
for p in os.listdir(d):
416
name, path, desc = _find_plugin_module(d, p)
418
if name == '__init__':
419
# We do nothing with the __init__.py file in directories from
420
# the bzrlib.plugins module path, we may want to, one day
422
continue # We don't load __init__.py in the plugins dirs
423
elif getattr(_mod_plugins, name, None) is not None:
424
# The module has already been loaded from another directory
425
# during a previous call.
426
# FIXME: There should be a better way to report masked plugins
428
trace.mutter('Plugin name %s already loaded', name)
430
plugin_names.add(name)
432
for name in plugin_names:
433
_load_plugin_module(name, d)
437
"""Return a dictionary of the plugins.
439
Each item in the dictionary is a PlugIn object.
442
for name, plugin in _mod_plugins.__dict__.items():
443
if isinstance(plugin, types.ModuleType):
444
result[name] = PlugIn(name, plugin)
448
def format_concise_plugin_list():
449
"""Return a string holding a concise list of plugins and their version.
452
for name, a_plugin in sorted(plugins().items()):
453
items.append("%s[%s]" %
454
(name, a_plugin.__version__))
455
return ', '.join(items)
459
class PluginsHelpIndex(object):
460
"""A help index that returns help topics for plugins."""
463
self.prefix = 'plugins/'
465
def get_topics(self, topic):
466
"""Search for topic in the loaded plugins.
468
This will not trigger loading of new plugins.
470
:param topic: A topic to search for.
471
:return: A list which is either empty or contains a single
472
RegisteredTopic entry.
476
if topic.startswith(self.prefix):
477
topic = topic[len(self.prefix):]
478
plugin_module_name = 'bzrlib.plugins.%s' % topic
480
module = sys.modules[plugin_module_name]
484
return [ModuleHelpTopic(module)]
487
class ModuleHelpTopic(object):
488
"""A help topic which returns the docstring for a module."""
490
def __init__(self, module):
493
:param module: The module for which help should be generated.
497
def get_help_text(self, additional_see_also=None, verbose=True):
498
"""Return a string with the help for this topic.
500
:param additional_see_also: Additional help topics to be
503
if not self.module.__doc__:
504
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
506
result = self.module.__doc__
507
if result[-1] != '\n':
509
from bzrlib import help_topics
510
result += help_topics._format_see_also(additional_see_also)
513
def get_help_topic(self):
514
"""Return the module help topic: its basename."""
515
return self.module.__name__[len('bzrlib.plugins.'):]
518
class PlugIn(object):
519
"""The bzrlib representation of a plugin.
521
The PlugIn object provides a way to manipulate a given plugin module.
524
def __init__(self, name, module):
525
"""Construct a plugin for module."""
530
"""Get the path that this plugin was loaded from."""
531
if getattr(self.module, '__path__', None) is not None:
532
return os.path.abspath(self.module.__path__[0])
533
elif getattr(self.module, '__file__', None) is not None:
534
path = os.path.abspath(self.module.__file__)
535
if path[-4:] in ('.pyc', '.pyo'):
536
pypath = path[:-4] + '.py'
537
if os.path.isfile(pypath):
541
return repr(self.module)
544
return "<%s.%s object at %s, name=%s, module=%s>" % (
545
self.__class__.__module__, self.__class__.__name__, id(self),
546
self.name, self.module)
550
def test_suite(self):
551
"""Return the plugin's test suite."""
552
if getattr(self.module, 'test_suite', None) is not None:
553
return self.module.test_suite()
557
def load_plugin_tests(self, loader):
558
"""Return the adapted plugin's test suite.
560
:param loader: The custom loader that should be used to load additional
564
if getattr(self.module, 'load_tests', None) is not None:
565
return loader.loadTestsFromModule(self.module)
569
def version_info(self):
570
"""Return the plugin's version_tuple or None if unknown."""
571
version_info = getattr(self.module, 'version_info', None)
572
if version_info is not None:
574
if isinstance(version_info, types.StringType):
575
version_info = version_info.split('.')
576
elif len(version_info) == 3:
577
version_info = tuple(version_info) + ('final', 0)
579
# The given version_info isn't even iteratible
580
trace.log_exception_quietly()
581
version_info = (version_info,)
584
def _get__version__(self):
585
version_info = self.version_info()
586
if version_info is None or len(version_info) == 0:
589
version_string = _format_version_tuple(version_info)
590
except (ValueError, TypeError, IndexError), e:
591
trace.log_exception_quietly()
592
# try to return something usefull for bad plugins, in stead of
594
version_string = '.'.join(map(str, version_info))
595
return version_string
597
__version__ = property(_get__version__)
600
class _PluginImporter(object):
601
"""An importer tailored to bzr specific needs.
603
This is a singleton that takes care of:
604
- disabled plugins specified in 'blacklist',
605
- plugins that needs to be loaded from specific directories.
612
self.blacklist = set()
613
self.specific_paths = {}
615
def find_module(self, fullname, parent_path=None):
616
"""Search a plugin module.
618
Disabled plugins raise an import error, plugins with specific paths
619
returns a specific loader.
621
:return: None if the plugin doesn't need special handling, self
624
if not fullname.startswith('bzrlib.plugins.'):
626
if fullname in self.blacklist:
627
raise ImportError('%s is disabled' % fullname)
628
if fullname in self.specific_paths:
632
def load_module(self, fullname):
633
"""Load a plugin from a specific directory."""
634
# We are called only for specific paths
635
plugin_path = self.specific_paths[fullname]
637
if os.path.isdir(plugin_path):
638
for suffix, mode, kind in imp.get_suffixes():
639
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
640
# We don't recognize compiled modules (.so, .dll, etc)
642
init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
643
if os.path.isfile(init_path):
644
# We've got a module here and load_module needs specific
646
loading_path = plugin_path
649
kind = imp.PKG_DIRECTORY
652
for suffix, mode, kind in imp.get_suffixes():
653
if plugin_path.endswith(suffix):
654
loading_path = plugin_path
656
if loading_path is None:
657
raise ImportError('%s cannot be loaded from %s'
658
% (fullname, plugin_path))
659
if kind is imp.PKG_DIRECTORY:
662
f = open(loading_path, mode)
664
mod = imp.load_module(fullname, f, loading_path,
665
(suffix, mode, kind))
666
mod.__package__ = fullname
673
# Install a dedicated importer for plugins requiring special handling
674
PluginImporter = _PluginImporter()
675
sys.meta_path.append(PluginImporter)
added
removed
bzrlib/plugin.py
