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
39
36
lazy_import(globals(), """
44
42
from bzrlib import (
45
_format_version_tuple,
51
from bzrlib import plugins as _mod_plugins
49
from bzrlib.trace import mutter, warning, log_exception_quietly
55
52
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
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):
69
72
def disable_plugins():
72
75
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
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
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
94
"""Load bzrlib plugins.
274
96
The environment variable BZR_PLUGIN_PATH is considered a delimited
275
set of paths to look through. Each entry is searched for `*.py`
97
set of paths to look through. Each entry is searched for *.py
276
98
files (and whatever other extensions are used in the platform,
279
load_from_path() provides the underlying mechanism and is called with
101
load_from_dirs() provides the underlying mechanism and is called with
280
102
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.
329
141
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
144
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.
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]
414
152
plugin_names = set()
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)
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')]
430
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)
432
178
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)
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()
459
272
class PluginsHelpIndex(object):
522
335
def get_help_topic(self):
523
336
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
524
337
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:
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)
added
removed
bzrlib/plugin.py
