20
20
When load_plugins() is invoked, any python module in any directory in
21
21
$BZR_PLUGIN_PATH will be imported. The module will be imported as
22
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
23
update any bzrlib registries it wants to extend; for example, to add new
24
commands, import bzrlib.commands and add your new command to the plugin_cmds
28
27
BZR_PLUGIN_PATH is also honoured for any plugins imported via
29
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
28
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
36
from bzrlib import osutils
38
35
from bzrlib.lazy_import import lazy_import
40
36
lazy_import(globals(), """
45
42
from bzrlib import (
46
_format_version_tuple,
52
from bzrlib import plugins as _mod_plugins
55
from bzrlib.symbol_versioning import (
49
from bzrlib.trace import mutter, warning, log_exception_quietly
61
52
DEFAULT_PLUGIN_PATH = None
63
_plugins_disabled = False
66
def are_plugins_disabled():
67
return _plugins_disabled
55
def get_default_plugin_path():
56
"""Get the DEFAULT_PLUGIN_PATH"""
57
global DEFAULT_PLUGIN_PATH
58
if DEFAULT_PLUGIN_PATH is None:
59
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
60
return DEFAULT_PLUGIN_PATH
64
"""Return a dictionary of the plugins."""
66
for name, plugin in plugins.__dict__.items():
67
if isinstance(plugin, types.ModuleType):
70
72
def disable_plugins():
73
75
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 set_plugins_path(path=None):
85
"""Set the path for plugins to be loaded from.
87
:param path: The list of paths to search for plugins. By default,
88
path will be determined using get_standard_plugins_path.
89
if path is [], no plugins can be loaded.
92
path = get_standard_plugins_path()
93
_mod_plugins.__path__ = path
94
PluginImporter.reset()
95
# Set up a blacklist for disabled plugins
96
disabled_plugins = os.environ.get('BZR_DISABLE_PLUGINS', None)
97
if disabled_plugins is not None:
98
for name in disabled_plugins.split(os.pathsep):
99
PluginImporter.blacklist.add('bzrlib.plugins.' + name)
100
# Set up a the specific paths for plugins
101
specific_plugins = os.environ.get('BZR_PLUGINS_AT', None)
102
if specific_plugins is not None:
103
for spec in specific_plugins.split(os.pathsep):
104
plugin_name, plugin_path = spec.split('@')
105
PluginImporter.specific_paths[
106
'bzrlib.plugins.%s' % plugin_name] = plugin_path
77
# TODO: jam 20060131 This should probably also disable
83
def set_plugins_path():
84
"""Set the path for plugins to be loaded from."""
85
path = os.environ.get('BZR_PLUGIN_PATH',
86
get_default_plugin_path()).split(os.pathsep)
87
# search the plugin path before the bzrlib installed dir
88
path.append(os.path.dirname(plugins.__file__))
89
plugins.__path__ = path
110
def _append_new_path(paths, new_path):
111
"""Append a new path if it set and not already known."""
112
if new_path is not None and new_path not in paths:
113
paths.append(new_path)
117
def get_core_plugin_path():
119
bzr_exe = bool(getattr(sys, 'frozen', None))
120
if bzr_exe: # expand path for bzr.exe
121
# We need to use relative path to system-wide plugin
122
# directory because bzrlib from standalone bzr.exe
123
# could be imported by another standalone program
124
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
125
# will become standalone exe). [bialix 20071123]
126
# __file__ typically is
127
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
128
# then plugins directory is
129
# C:\Program Files\Bazaar\plugins
130
# so relative path is ../../../plugins
131
core_path = osutils.abspath(osutils.pathjoin(
132
osutils.dirname(__file__), '../../../plugins'))
133
else: # don't look inside library.zip
134
# search the plugin path before the bzrlib installed dir
135
core_path = os.path.dirname(_mod_plugins.__file__)
139
def get_site_plugin_path():
140
"""Returns the path for the site installed plugins."""
141
if sys.platform == 'win32':
142
# We don't have (yet) a good answer for windows since that is certainly
143
# related to the way we build the installers. -- vila20090821
147
from distutils.sysconfig import get_python_lib
149
# If distutuils is not available, we just don't know where they are
152
site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
156
def get_user_plugin_path():
157
return osutils.pathjoin(config.config_dir(), 'plugins')
160
def get_standard_plugins_path():
161
"""Determine a plugin path suitable for general use."""
162
# Ad-Hoc default: core is not overriden by site but user can overrides both
163
# The rationale is that:
164
# - 'site' comes last, because these plugins should always be available and
165
# are supposed to be in sync with the bzr installed on site.
166
# - 'core' comes before 'site' so that running bzr from sources or a user
167
# installed version overrides the site version.
168
# - 'user' comes first, because... user is always right.
169
# - the above rules clearly defines which plugin version will be loaded if
170
# several exist. Yet, it is sometimes desirable to disable some directory
171
# so that a set of plugins is disabled as once. This can be done via
172
# -site, -core, -user.
174
env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
175
defaults = ['+core', '+site']
177
# The predefined references
178
refs = dict(core=get_core_plugin_path(),
179
site=get_site_plugin_path(),
180
user=get_user_plugin_path())
182
# Unset paths that should be removed
183
for k,v in refs.iteritems():
185
# defaults can never mention removing paths as that will make it
186
# impossible for the user to revoke these removals.
187
if removed in env_paths:
188
env_paths.remove(removed)
193
for p in env_paths + defaults:
194
if p.startswith('+'):
195
# Resolve references if they are known
199
# Leave them untouched so user can still use paths starting
202
_append_new_path(paths, p)
204
# Get rid of trailing slashes, since Python can't handle them when
205
# it tries to import modules.
206
paths = map(_strip_trailing_sep, paths)
210
def load_plugins(path=None):
211
94
"""Load bzrlib plugins.
213
96
The environment variable BZR_PLUGIN_PATH is considered a delimited
268
141
load_from_dirs = load_from_path
271
def _find_plugin_module(dir, name):
272
"""Check if there is a valid python module that can be loaded as a plugin.
274
:param dir: The directory where the search is performed.
275
:param path: An existing file path, either a python file or a package
278
:return: (name, path, description) name is the module name, path is the
279
file to load and description is the tuple returned by
282
path = osutils.pathjoin(dir, name)
283
if os.path.isdir(path):
284
# Check for a valid __init__.py file, valid suffixes depends on -O and
285
# can be .py, .pyc and .pyo
286
for suffix, mode, kind in imp.get_suffixes():
287
if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
288
# We don't recognize compiled modules (.so, .dll, etc)
290
init_path = osutils.pathjoin(path, '__init__' + suffix)
291
if os.path.isfile(init_path):
292
return name, init_path, (suffix, mode, kind)
294
for suffix, mode, kind in imp.get_suffixes():
295
if name.endswith(suffix):
296
# Clean up the module name
297
name = name[:-len(suffix)]
298
if kind == imp.C_EXTENSION and name.endswith('module'):
299
name = name[:-len('module')]
300
return name, path, (suffix, mode, kind)
301
# There is no python module here
302
return None, None, (None, None, None)
305
def _load_plugin_module(name, dir):
306
"""Load plugine name from dir.
308
:param name: The plugin name in the bzrlib.plugins namespace.
309
:param dir: The directory the plugin is loaded from for error messages.
311
if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
314
exec "import bzrlib.plugins.%s" % name in {}
315
except KeyboardInterrupt:
317
except errors.IncompatibleAPI, e:
318
trace.warning("Unable to load plugin %r. It requested API version "
319
"%s of module %s but the minimum exported version is %s, and "
320
"the maximum is %s" %
321
(name, e.wanted, e.api, e.minimum, e.current))
323
trace.warning("%s" % e)
324
if re.search('\.|-| ', name):
325
sanitised_name = re.sub('[-. ]', '_', name)
326
if sanitised_name.startswith('bzr_'):
327
sanitised_name = sanitised_name[len('bzr_'):]
328
trace.warning("Unable to load %r in %r as a plugin because the "
329
"file path isn't a valid module name; try renaming "
330
"it to %r." % (name, dir, sanitised_name))
332
trace.warning('Unable to load plugin %r from %r' % (name, dir))
333
trace.log_exception_quietly()
334
if 'error' in debug.debug_flags:
335
trace.print_exception(sys.exc_info(), sys.stderr)
338
144
def load_from_dir(d):
339
"""Load the plugins in directory d.
341
d must be in the plugins module path already.
342
This function is called once for each directory in the module path.
145
"""Load the plugins in directory d."""
146
# Get the list of valid python suffixes for __init__.py?
147
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
148
# but it doesn't include compiled modules (.so, .dll, etc)
149
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
150
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
151
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
344
152
plugin_names = set()
345
for p in os.listdir(d):
346
name, path, desc = _find_plugin_module(d, p)
348
if name == '__init__':
349
# We do nothing with the __init__.py file in directories from
350
# the bzrlib.plugins module path, we may want to, one day
352
continue # We don't load __init__.py in the plugins dirs
353
elif getattr(_mod_plugins, name, None) is not None:
354
# The module has already been loaded from another directory
355
# during a previous call.
356
# FIXME: There should be a better way to report masked plugins
358
trace.mutter('Plugin name %s already loaded', name)
153
for f in os.listdir(d):
154
path = osutils.pathjoin(d, f)
155
if os.path.isdir(path):
156
for entry in package_entries:
157
# This directory should be a package, and thus added to
159
if os.path.isfile(osutils.pathjoin(path, entry)):
161
else: # This directory is not a package
164
for suffix_info in imp.get_suffixes():
165
if f.endswith(suffix_info[0]):
166
f = f[:-len(suffix_info[0])]
167
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
168
f = f[:-len('module')]
360
plugin_names.add(name)
172
if getattr(plugins, f, None):
173
mutter('Plugin name %s already loaded', f)
175
# mutter('add plugin name %s', f)
362
178
for name in plugin_names:
363
_load_plugin_module(name, d)
367
"""Return a dictionary of the plugins.
369
Each item in the dictionary is a PlugIn object.
372
for name, plugin in _mod_plugins.__dict__.items():
373
if isinstance(plugin, types.ModuleType):
374
result[name] = PlugIn(name, plugin)
180
exec "import bzrlib.plugins.%s" % name in {}
181
except KeyboardInterrupt:
184
## import pdb; pdb.set_trace()
185
if re.search('\.|-| ', name):
186
warning('Unable to load plugin %r from %r: '
187
'It is not a valid python module name.' % (name, d))
189
warning('Unable to load plugin %r from %r' % (name, d))
190
log_exception_quietly()
193
def load_from_zip(zip_name):
194
"""Load all the plugins in a zip."""
195
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
199
index = zip_name.rindex('.zip')
202
archive = zip_name[:index+4]
203
prefix = zip_name[index+5:]
205
mutter('Looking for plugins in %r', zip_name)
207
# use zipfile to get list of files/dirs inside zip
209
z = zipfile.ZipFile(archive)
210
namelist = z.namelist()
212
except zipfile.error:
217
prefix = prefix.replace('\\','/')
218
if prefix[-1] != '/':
221
namelist = [name[ix:]
223
if name.startswith(prefix)]
225
mutter('Names in archive: %r', namelist)
227
for name in namelist:
228
if not name or name.endswith('/'):
231
# '/' is used to separate pathname components inside zip archives
234
head, tail = '', name
236
head, tail = name.rsplit('/',1)
238
# we don't need looking in subdirectories
241
base, suffix = osutils.splitext(tail)
242
if suffix not in valid_suffixes:
245
if base == '__init__':
256
if getattr(plugins, plugin_name, None):
257
mutter('Plugin name %s already loaded', plugin_name)
261
exec "import bzrlib.plugins.%s" % plugin_name in {}
262
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
263
except KeyboardInterrupt:
266
## import pdb; pdb.set_trace()
267
warning('Unable to load plugin %r from %r'
269
log_exception_quietly()
378
272
class PluginsHelpIndex(object):
441
335
def get_help_topic(self):
442
336
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
443
337
return self.module.__name__[len('bzrlib.plugins.'):]
446
class PlugIn(object):
447
"""The bzrlib representation of a plugin.
449
The PlugIn object provides a way to manipulate a given plugin module.
452
def __init__(self, name, module):
453
"""Construct a plugin for module."""
458
"""Get the path that this plugin was loaded from."""
459
if getattr(self.module, '__path__', None) is not None:
460
return os.path.abspath(self.module.__path__[0])
461
elif getattr(self.module, '__file__', None) is not None:
462
path = os.path.abspath(self.module.__file__)
463
if path[-4:] in ('.pyc', '.pyo'):
464
pypath = path[:-4] + '.py'
465
if os.path.isfile(pypath):
469
return repr(self.module)
472
return "<%s.%s object at %s, name=%s, module=%s>" % (
473
self.__class__.__module__, self.__class__.__name__, id(self),
474
self.name, self.module)
478
def test_suite(self):
479
"""Return the plugin's test suite."""
480
if getattr(self.module, 'test_suite', None) is not None:
481
return self.module.test_suite()
485
def load_plugin_tests(self, loader):
486
"""Return the adapted plugin's test suite.
488
:param loader: The custom loader that should be used to load additional
492
if getattr(self.module, 'load_tests', None) is not None:
493
return loader.loadTestsFromModule(self.module)
497
def version_info(self):
498
"""Return the plugin's version_tuple or None if unknown."""
499
version_info = getattr(self.module, 'version_info', None)
500
if version_info is not None:
502
if isinstance(version_info, types.StringType):
503
version_info = version_info.split('.')
504
elif len(version_info) == 3:
505
version_info = tuple(version_info) + ('final', 0)
507
# The given version_info isn't even iteratible
508
trace.log_exception_quietly()
509
version_info = (version_info,)
512
def _get__version__(self):
513
version_info = self.version_info()
514
if version_info is None or len(version_info) == 0:
517
version_string = _format_version_tuple(version_info)
518
except (ValueError, TypeError, IndexError), e:
519
trace.log_exception_quietly()
520
# try to return something usefull for bad plugins, in stead of
522
version_string = '.'.join(map(str, version_info))
523
return version_string
525
__version__ = property(_get__version__)
528
class _PluginImporter(object):
529
"""An importer tailored to bzr specific needs.
531
This is a singleton that takes care of:
532
- disabled plugins specified in 'blacklist',
533
- plugins that needs to be loaded from specific directories.
540
self.blacklist = set()
541
self.specific_paths = {}
543
def find_module(self, fullname, parent_path=None):
544
"""Search a plugin module.
546
Disabled plugins raise an import error, plugins with specific paths
547
returns a specific loader.
549
:return: None if the plugin doesn't need special handling, self
552
if not fullname.startswith('bzrlib.plugins.'):
554
if fullname in self.blacklist:
555
raise ImportError('%s is disabled' % fullname)
556
if fullname in self.specific_paths:
560
def load_module(self, fullname):
561
"""Load a plugin from a specific directory."""
562
# We are called only for specific paths
563
plugin_dir = self.specific_paths[fullname]
565
maybe_package = False
566
for p in os.listdir(plugin_dir):
567
if os.path.isdir(osutils.pathjoin(plugin_dir, p)):
568
# We're searching for files only and don't want submodules to
569
# be recognized as plugins (they are submodules inside the
573
suffix, mode, kind) = _find_plugin_module(plugin_dir, p)
575
candidate = (name, path, suffix, mode, kind)
576
if kind == imp.PY_SOURCE:
577
# We favour imp.PY_SOURCE (which will use the compiled
578
# version if available) over imp.PY_COMPILED (which is used
579
# only if the source is not available)
581
if candidate is None:
582
raise ImportError('%s cannot be loaded from %s'
583
% (fullname, plugin_dir))
586
mod = imp.load_module(fullname, f, path, (suffix, mode, kind))
587
# The plugin can contain modules, so be ready
588
mod.__path__ = [plugin_dir]
589
mod.__package__ = fullname
595
# Install a dedicated importer for plugins requiring special handling
596
PluginImporter = _PluginImporter()
597
sys.meta_path.append(PluginImporter)
added
removed
bzrlib/plugin.py
