1
# Copyright (C) 2005-2010 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
40
lazy_import(globals(), """
46
_format_version_tuple,
52
from bzrlib import plugins as _mod_plugins
55
from bzrlib.symbol_versioning import (
61
DEFAULT_PLUGIN_PATH = None
63
_plugins_disabled = False
66
def are_plugins_disabled():
67
return _plugins_disabled
70
def disable_plugins():
71
"""Disable loading plugins.
73
Future calls to load_plugins() will be ignored.
75
global _plugins_disabled
76
_plugins_disabled = True
80
def _strip_trailing_sep(path):
81
return path.rstrip("\\/")
84
def _get_specific_plugin_paths(paths):
85
"""Returns the plugin paths from a string describing the associations.
87
:param paths: A string describing the paths associated with the plugins.
89
:returns: A list of (plugin name, path) tuples.
91
For example, if paths is my_plugin@/test/my-test:her_plugin@/production/her,
92
[('my_plugin', '/test/my-test'), ('her_plugin', '/production/her')]
95
Note that ':' in the example above depends on the os.
100
for spec in paths.split(os.pathsep):
102
name, path = spec.split('@')
104
raise errors.BzrCommandError(
105
'"%s" is not a valid <plugin_name>@<plugin_path> description '
107
specs.append((name, path))
111
def set_plugins_path(path=None):
112
"""Set the path for plugins to be loaded from.
114
:param path: The list of paths to search for plugins. By default,
115
path will be determined using get_standard_plugins_path.
116
if path is [], no plugins can be loaded.
119
path = get_standard_plugins_path()
120
_mod_plugins.__path__ = path
121
PluginImporter.reset()
122
# Set up a blacklist for disabled plugins
123
disabled_plugins = os.environ.get('BZR_DISABLE_PLUGINS', None)
124
if disabled_plugins is not None:
125
for name in disabled_plugins.split(os.pathsep):
126
PluginImporter.blacklist.add('bzrlib.plugins.' + name)
127
# Set up a the specific paths for plugins
128
for plugin_name, plugin_path in _get_specific_plugin_paths(os.environ.get(
129
'BZR_PLUGINS_AT', None)):
130
PluginImporter.specific_paths[
131
'bzrlib.plugins.%s' % plugin_name] = plugin_path
135
def _append_new_path(paths, new_path):
136
"""Append a new path if it set and not already known."""
137
if new_path is not None and new_path not in paths:
138
paths.append(new_path)
142
def get_core_plugin_path():
144
bzr_exe = bool(getattr(sys, 'frozen', None))
145
if bzr_exe: # expand path for bzr.exe
146
# We need to use relative path to system-wide plugin
147
# directory because bzrlib from standalone bzr.exe
148
# could be imported by another standalone program
149
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
150
# will become standalone exe). [bialix 20071123]
151
# __file__ typically is
152
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
153
# then plugins directory is
154
# C:\Program Files\Bazaar\plugins
155
# so relative path is ../../../plugins
156
core_path = osutils.abspath(osutils.pathjoin(
157
osutils.dirname(__file__), '../../../plugins'))
158
else: # don't look inside library.zip
159
# search the plugin path before the bzrlib installed dir
160
core_path = os.path.dirname(_mod_plugins.__file__)
164
def get_site_plugin_path():
165
"""Returns the path for the site installed plugins."""
166
if sys.platform == 'win32':
167
# We don't have (yet) a good answer for windows since that is certainly
168
# related to the way we build the installers. -- vila20090821
172
from distutils.sysconfig import get_python_lib
174
# If distutuils is not available, we just don't know where they are
177
site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
181
def get_user_plugin_path():
182
return osutils.pathjoin(config.config_dir(), 'plugins')
185
def get_standard_plugins_path():
186
"""Determine a plugin path suitable for general use."""
187
# Ad-Hoc default: core is not overriden by site but user can overrides both
188
# The rationale is that:
189
# - 'site' comes last, because these plugins should always be available and
190
# are supposed to be in sync with the bzr installed on site.
191
# - 'core' comes before 'site' so that running bzr from sources or a user
192
# installed version overrides the site version.
193
# - 'user' comes first, because... user is always right.
194
# - the above rules clearly defines which plugin version will be loaded if
195
# several exist. Yet, it is sometimes desirable to disable some directory
196
# so that a set of plugins is disabled as once. This can be done via
197
# -site, -core, -user.
199
env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
200
defaults = ['+core', '+site']
202
# The predefined references
203
refs = dict(core=get_core_plugin_path(),
204
site=get_site_plugin_path(),
205
user=get_user_plugin_path())
207
# Unset paths that should be removed
208
for k,v in refs.iteritems():
210
# defaults can never mention removing paths as that will make it
211
# impossible for the user to revoke these removals.
212
if removed in env_paths:
213
env_paths.remove(removed)
218
for p in env_paths + defaults:
219
if p.startswith('+'):
220
# Resolve references if they are known
224
# Leave them untouched so user can still use paths starting
227
_append_new_path(paths, p)
229
# Get rid of trailing slashes, since Python can't handle them when
230
# it tries to import modules.
231
paths = map(_strip_trailing_sep, paths)
235
def load_plugins(path=None):
236
"""Load bzrlib plugins.
238
The environment variable BZR_PLUGIN_PATH is considered a delimited
239
set of paths to look through. Each entry is searched for *.py
240
files (and whatever other extensions are used in the platform,
243
load_from_path() provides the underlying mechanism and is called with
244
the default directory list to provide the normal behaviour.
246
:param path: The list of paths to search for plugins. By default,
247
path will be determined using get_standard_plugins_path.
248
if path is [], no plugins can be loaded.
252
# People can make sure plugins are loaded, they just won't be twice
256
# scan for all plugins in the path.
257
load_from_path(set_plugins_path(path))
260
def load_from_path(dirs):
261
"""Load bzrlib plugins found in each dir in dirs.
263
Loading a plugin means importing it into the python interpreter.
264
The plugin is expected to make calls to register commands when
265
it's loaded (or perhaps access other hooks in future.)
267
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
268
for future reference.
270
The python module path for bzrlib.plugins will be modified to be 'dirs'.
272
# Explicitly load the plugins with a specific path
273
for fullname, path in PluginImporter.specific_paths.iteritems():
274
name = fullname[len('bzrlib.plugins.'):]
275
_load_plugin_module(name, path)
277
# We need to strip the trailing separators here as well as in the
278
# set_plugins_path function because calling code can pass anything in to
279
# this function, and since it sets plugins.__path__, it should set it to
280
# something that will be valid for Python to use (in case people try to
281
# run "import bzrlib.plugins.PLUGINNAME" after calling this function).
282
_mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
286
trace.mutter('looking for plugins in %s', d)
291
# backwards compatability: load_from_dirs was the old name
292
# This was changed in 0.15
293
load_from_dirs = load_from_path
296
def _find_plugin_module(dir, name):
297
"""Check if there is a valid python module that can be loaded as a plugin.
299
:param dir: The directory where the search is performed.
300
:param path: An existing file path, either a python file or a package
303
:return: (name, path, description) name is the module name, path is the
304
file to load and description is the tuple returned by
307
path = osutils.pathjoin(dir, name)
308
if os.path.isdir(path):
309
# Check for a valid __init__.py file, valid suffixes depends on -O and
310
# can be .py, .pyc and .pyo
311
for suffix, mode, kind in imp.get_suffixes():
312
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
313
# We don't recognize compiled modules (.so, .dll, etc)
315
init_path = osutils.pathjoin(path, '__init__' + suffix)
316
if os.path.isfile(init_path):
317
return name, init_path, (suffix, mode, kind)
319
for suffix, mode, kind in imp.get_suffixes():
320
if name.endswith(suffix):
321
# Clean up the module name
322
name = name[:-len(suffix)]
323
if kind == imp.C_EXTENSION and name.endswith('module'):
324
name = name[:-len('module')]
325
return name, path, (suffix, mode, kind)
326
# There is no python module here
327
return None, None, (None, None, None)
330
def _load_plugin_module(name, dir):
331
"""Load plugin name from dir.
333
:param name: The plugin name in the bzrlib.plugins namespace.
334
:param dir: The directory the plugin is loaded from for error messages.
336
if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
339
exec "import bzrlib.plugins.%s" % name in {}
340
except KeyboardInterrupt:
342
except errors.IncompatibleAPI, e:
343
trace.warning("Unable to load plugin %r. It requested API version "
344
"%s of module %s but the minimum exported version is %s, and "
345
"the maximum is %s" %
346
(name, e.wanted, e.api, e.minimum, e.current))
348
trace.warning("%s" % e)
349
if re.search('\.|-| ', name):
350
sanitised_name = re.sub('[-. ]', '_', name)
351
if sanitised_name.startswith('bzr_'):
352
sanitised_name = sanitised_name[len('bzr_'):]
353
trace.warning("Unable to load %r in %r as a plugin because the "
354
"file path isn't a valid module name; try renaming "
355
"it to %r." % (name, dir, sanitised_name))
357
trace.warning('Unable to load plugin %r from %r' % (name, dir))
358
trace.log_exception_quietly()
359
if 'error' in debug.debug_flags:
360
trace.print_exception(sys.exc_info(), sys.stderr)
363
def load_from_dir(d):
364
"""Load the plugins in directory d.
366
d must be in the plugins module path already.
367
This function is called once for each directory in the module path.
370
for p in os.listdir(d):
371
name, path, desc = _find_plugin_module(d, p)
373
if name == '__init__':
374
# We do nothing with the __init__.py file in directories from
375
# the bzrlib.plugins module path, we may want to, one day
377
continue # We don't load __init__.py in the plugins dirs
378
elif getattr(_mod_plugins, name, None) is not None:
379
# The module has already been loaded from another directory
380
# during a previous call.
381
# FIXME: There should be a better way to report masked plugins
383
trace.mutter('Plugin name %s already loaded', name)
385
plugin_names.add(name)
387
for name in plugin_names:
388
_load_plugin_module(name, d)
392
"""Return a dictionary of the plugins.
394
Each item in the dictionary is a PlugIn object.
397
for name, plugin in _mod_plugins.__dict__.items():
398
if isinstance(plugin, types.ModuleType):
399
result[name] = PlugIn(name, plugin)
403
class PluginsHelpIndex(object):
404
"""A help index that returns help topics for plugins."""
407
self.prefix = 'plugins/'
409
def get_topics(self, topic):
410
"""Search for topic in the loaded plugins.
412
This will not trigger loading of new plugins.
414
:param topic: A topic to search for.
415
:return: A list which is either empty or contains a single
416
RegisteredTopic entry.
420
if topic.startswith(self.prefix):
421
topic = topic[len(self.prefix):]
422
plugin_module_name = 'bzrlib.plugins.%s' % topic
424
module = sys.modules[plugin_module_name]
428
return [ModuleHelpTopic(module)]
431
class ModuleHelpTopic(object):
432
"""A help topic which returns the docstring for a module."""
434
def __init__(self, module):
437
:param module: The module for which help should be generated.
441
def get_help_text(self, additional_see_also=None, verbose=True):
442
"""Return a string with the help for this topic.
444
:param additional_see_also: Additional help topics to be
447
if not self.module.__doc__:
448
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
450
result = self.module.__doc__
451
if result[-1] != '\n':
453
# there is code duplicated here and in bzrlib/help_topic.py's
454
# matching Topic code. This should probably be factored in
455
# to a helper function and a common base class.
456
if additional_see_also is not None:
457
see_also = sorted(set(additional_see_also))
461
result += 'See also: '
462
result += ', '.join(see_also)
466
def get_help_topic(self):
467
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
468
return self.module.__name__[len('bzrlib.plugins.'):]
471
class PlugIn(object):
472
"""The bzrlib representation of a plugin.
474
The PlugIn object provides a way to manipulate a given plugin module.
477
def __init__(self, name, module):
478
"""Construct a plugin for module."""
483
"""Get the path that this plugin was loaded from."""
484
if getattr(self.module, '__path__', None) is not None:
485
return os.path.abspath(self.module.__path__[0])
486
elif getattr(self.module, '__file__', None) is not None:
487
path = os.path.abspath(self.module.__file__)
488
if path[-4:] in ('.pyc', '.pyo'):
489
pypath = path[:-4] + '.py'
490
if os.path.isfile(pypath):
494
return repr(self.module)
497
return "<%s.%s object at %s, name=%s, module=%s>" % (
498
self.__class__.__module__, self.__class__.__name__, id(self),
499
self.name, self.module)
503
def test_suite(self):
504
"""Return the plugin's test suite."""
505
if getattr(self.module, 'test_suite', None) is not None:
506
return self.module.test_suite()
510
def load_plugin_tests(self, loader):
511
"""Return the adapted plugin's test suite.
513
:param loader: The custom loader that should be used to load additional
517
if getattr(self.module, 'load_tests', None) is not None:
518
return loader.loadTestsFromModule(self.module)
522
def version_info(self):
523
"""Return the plugin's version_tuple or None if unknown."""
524
version_info = getattr(self.module, 'version_info', None)
525
if version_info is not None:
527
if isinstance(version_info, types.StringType):
528
version_info = version_info.split('.')
529
elif len(version_info) == 3:
530
version_info = tuple(version_info) + ('final', 0)
532
# The given version_info isn't even iteratible
533
trace.log_exception_quietly()
534
version_info = (version_info,)
537
def _get__version__(self):
538
version_info = self.version_info()
539
if version_info is None or len(version_info) == 0:
542
version_string = _format_version_tuple(version_info)
543
except (ValueError, TypeError, IndexError), e:
544
trace.log_exception_quietly()
545
# try to return something usefull for bad plugins, in stead of
547
version_string = '.'.join(map(str, version_info))
548
return version_string
550
__version__ = property(_get__version__)
553
class _PluginImporter(object):
554
"""An importer tailored to bzr specific needs.
556
This is a singleton that takes care of:
557
- disabled plugins specified in 'blacklist',
558
- plugins that needs to be loaded from specific directories.
565
self.blacklist = set()
566
self.specific_paths = {}
568
def find_module(self, fullname, parent_path=None):
569
"""Search a plugin module.
571
Disabled plugins raise an import error, plugins with specific paths
572
returns a specific loader.
574
:return: None if the plugin doesn't need special handling, self
577
if not fullname.startswith('bzrlib.plugins.'):
579
if fullname in self.blacklist:
580
raise ImportError('%s is disabled' % fullname)
581
if fullname in self.specific_paths:
585
def load_module(self, fullname):
586
"""Load a plugin from a specific directory."""
587
# We are called only for specific paths
588
plugin_path = self.specific_paths[fullname]
590
if os.path.isdir(plugin_path):
591
for suffix, mode, kind in imp.get_suffixes():
592
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
593
# We don't recognize compiled modules (.so, .dll, etc)
595
init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
596
if os.path.isfile(init_path):
597
# We've got a module here and load_module needs specific
599
loading_path = plugin_path
602
kind = imp.PKG_DIRECTORY
605
for suffix, mode, kind in imp.get_suffixes():
606
if plugin_path.endswith(suffix):
607
loading_path = plugin_path
609
if loading_path is None:
610
raise ImportError('%s cannot be loaded from %s'
611
% (fullname, plugin_path))
612
if kind is imp.PKG_DIRECTORY:
615
f = open(loading_path, mode)
617
mod = imp.load_module(fullname, f, loading_path,
618
(suffix, mode, kind))
619
mod.__package__ = fullname
626
# Install a dedicated importer for plugins requiring special handling
627
PluginImporter = _PluginImporter()
628
sys.meta_path.append(PluginImporter)
added
removed
bzrlib/plugin.py
