1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""bzr python plugin support
20
Any python module in $BZR_PLUGIN_PATH will be imported upon initialization of
21
bzrlib. The module will be imported as 'bzrlib.plugins.$BASENAME(PLUGIN)'.
22
In the plugin's main body, it should update any bzrlib registries it wants to
23
extend; for example, to add new commands, import bzrlib.commands and add your
24
new command to the plugin_cmds variable.
27
# TODO: Refactor this to make it more testable. The main problem at the
28
# moment is that loading plugins affects the global process state -- for bzr
29
# in general use it's a reasonable assumption that all plugins are loaded at
30
# startup and then stay loaded, but this is less good for testing.
32
# Several specific issues:
33
# - plugins can't be unloaded and will continue to effect later tests
34
# - load_plugins does nothing if called a second time
35
# - plugin hooks can't be removed
37
# Our options are either to remove these restrictions, or work around them by
38
# loading the plugins into a different space than the one running the tests.
39
# That could be either a separate Python interpreter or perhaps a new
40
# namespace inside this interpreter.
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
48
from bzrlib.config import config_dir
49
from bzrlib.trace import log_error, mutter, warning, \
51
from bzrlib.errors import BzrError
52
from bzrlib import plugins
53
from bzrlib.osutils import pathjoin
55
DEFAULT_PLUGIN_PATH = pathjoin(config_dir(), 'plugins')
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
61
"""Return a dictionary of the plugins."""
63
for name, plugin in bzrlib.plugins.__dict__.items():
64
if isinstance(plugin, types.ModuleType):
69
69
def disable_plugins():
72
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):
74
# TODO: jam 20060131 This should probably also disable
272
81
"""Load bzrlib plugins.
274
83
The environment variable BZR_PLUGIN_PATH is considered a delimited
275
set of paths to look through. Each entry is searched for `*.py`
84
set of paths to look through. Each entry is searched for *.py
276
85
files (and whatever other extensions are used in the platform,
279
load_from_path() provides the underlying mechanism and is called with
88
load_from_dirs() provides the underlying mechanism and is called with
280
89
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
93
# People can make sure plugins are loaded, they just won't be twice
95
#raise BzrError("plugins already initialized")
292
# scan for all plugins in the path.
293
load_from_path(set_plugins_path(path))
296
def load_from_path(dirs):
98
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
99
dirs.insert(0, os.path.dirname(plugins.__file__))
104
def load_from_dirs(dirs):
297
105
"""Load bzrlib plugins found in each dir in dirs.
299
107
Loading a plugin means importing it into the python interpreter.
303
111
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
304
112
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)
114
# The problem with imp.get_suffixes() is that it doesn't include
115
# .pyo which is technically valid
116
# It also means that "testmodule.so" will show up as both test and testmodule
117
# though it is only valid as 'test'
118
# but you should be careful, because "testmodule.py" loads as testmodule.
119
suffixes = imp.get_suffixes()
120
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
121
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
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
# there is code duplicated here and in bzrlib/help_topic.py's
510
# matching Topic code. This should probably be factored in
511
# to a helper function and a common base class.
512
if additional_see_also is not None:
513
see_also = sorted(set(additional_see_also))
517
result += 'See also: '
518
result += ', '.join(see_also)
522
def get_help_topic(self):
523
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
524
return self.module.__name__[len('bzrlib.plugins.'):]
527
class PlugIn(object):
528
"""The bzrlib representation of a plugin.
530
The PlugIn object provides a way to manipulate a given plugin module.
533
def __init__(self, name, module):
534
"""Construct a plugin for module."""
539
"""Get the path that this plugin was loaded from."""
540
if getattr(self.module, '__path__', None) is not None:
541
return os.path.abspath(self.module.__path__[0])
542
elif getattr(self.module, '__file__', None) is not None:
543
path = os.path.abspath(self.module.__file__)
544
if path[-4:] in ('.pyc', '.pyo'):
545
pypath = path[:-4] + '.py'
546
if os.path.isfile(pypath):
550
return repr(self.module)
553
return "<%s.%s object at %s, name=%s, module=%s>" % (
554
self.__class__.__module__, self.__class__.__name__, id(self),
555
self.name, self.module)
559
def test_suite(self):
560
"""Return the plugin's test suite."""
561
if getattr(self.module, 'test_suite', None) is not None:
562
return self.module.test_suite()
566
def load_plugin_tests(self, loader):
567
"""Return the adapted plugin's test suite.
569
:param loader: The custom loader that should be used to load additional
573
if getattr(self.module, 'load_tests', None) is not None:
574
return loader.loadTestsFromModule(self.module)
578
def version_info(self):
579
"""Return the plugin's version_tuple or None if unknown."""
580
version_info = getattr(self.module, 'version_info', None)
581
if version_info is not None:
125
mutter('looking for plugins in %s', d)
127
if not os.path.isdir(d):
129
for f in os.listdir(d):
130
path = pathjoin(d, f)
131
if os.path.isdir(path):
132
for entry in package_entries:
133
# This directory should be a package, and thus added to
135
if os.path.isfile(pathjoin(path, entry)):
137
else: # This directory is not a package
140
for suffix_info in suffixes:
141
if f.endswith(suffix_info[0]):
142
f = f[:-len(suffix_info[0])]
143
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
144
f = f[:-len('module')]
148
if getattr(bzrlib.plugins, f, None):
149
mutter('Plugin name %s already loaded', f)
151
mutter('add plugin name %s', f)
154
plugin_names = list(plugin_names)
156
for name in plugin_names:
583
if isinstance(version_info, types.StringType):
584
version_info = version_info.split('.')
585
elif len(version_info) == 3:
586
version_info = tuple(version_info) + ('final', 0)
588
# The given version_info isn't even iteratible
589
trace.log_exception_quietly()
590
version_info = (version_info,)
593
def _get__version__(self):
594
version_info = self.version_info()
595
if version_info is None or len(version_info) == 0:
598
version_string = _format_version_tuple(version_info)
599
except (ValueError, TypeError, IndexError), e:
600
trace.log_exception_quietly()
601
# try to return something usefull for bad plugins, in stead of
603
version_string = '.'.join(map(str, version_info))
604
return version_string
606
__version__ = property(_get__version__)
609
class _PluginImporter(object):
610
"""An importer tailored to bzr specific needs.
612
This is a singleton that takes care of:
613
- disabled plugins specified in 'blacklist',
614
- plugins that needs to be loaded from specific directories.
621
self.blacklist = set()
622
self.specific_paths = {}
624
def find_module(self, fullname, parent_path=None):
625
"""Search a plugin module.
627
Disabled plugins raise an import error, plugins with specific paths
628
returns a specific loader.
630
:return: None if the plugin doesn't need special handling, self
633
if not fullname.startswith('bzrlib.plugins.'):
635
if fullname in self.blacklist:
636
raise ImportError('%s is disabled' % fullname)
637
if fullname in self.specific_paths:
641
def load_module(self, fullname):
642
"""Load a plugin from a specific directory."""
643
# We are called only for specific paths
644
plugin_path = self.specific_paths[fullname]
646
if os.path.isdir(plugin_path):
647
for suffix, mode, kind in imp.get_suffixes():
648
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
649
# We don't recognize compiled modules (.so, .dll, etc)
651
init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
652
if os.path.isfile(init_path):
653
# We've got a module here and load_module needs specific
655
loading_path = plugin_path
658
kind = imp.PKG_DIRECTORY
661
for suffix, mode, kind in imp.get_suffixes():
662
if plugin_path.endswith(suffix):
663
loading_path = plugin_path
665
if loading_path is None:
666
raise ImportError('%s cannot be loaded from %s'
667
% (fullname, plugin_path))
668
if kind is imp.PKG_DIRECTORY:
671
f = open(loading_path, mode)
673
mod = imp.load_module(fullname, f, loading_path,
674
(suffix, mode, kind))
675
mod.__package__ = fullname
682
# Install a dedicated importer for plugins requiring special handling
683
PluginImporter = _PluginImporter()
684
sys.meta_path.append(PluginImporter)
158
plugin_info = imp.find_module(name, [d])
159
mutter('load plugin %r', plugin_info)
161
plugin = imp.load_module('bzrlib.plugins.' + name,
163
setattr(bzrlib.plugins, name, plugin)
165
if plugin_info[0] is not None:
166
plugin_info[0].close()
168
mutter('loaded succesfully')
169
except KeyboardInterrupt:
172
## import pdb; pdb.set_trace()
173
warning('Unable to load plugin %r from %r' % (name, d))
174
log_exception_quietly()
added
removed
bzrlib/plugin.py
