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; for example, to add new
24
commands, import bzrlib.commands and add your new command to the plugin_cmds
23
update any bzrlib registries it wants to extend.
25
See the plugin-api developer documentation for information about writing
27
28
BZR_PLUGIN_PATH is also honoured for any plugins imported via
28
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
29
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
36
from bzrlib import osutils
35
38
from bzrlib.lazy_import import lazy_import
36
40
lazy_import(globals(), """
42
45
from bzrlib import (
46
_format_version_tuple,
46
52
from bzrlib import plugins as _mod_plugins
49
from bzrlib.symbol_versioning import deprecated_function, zero_ninetyone
50
from bzrlib.trace import mutter, warning, log_exception_quietly
55
from bzrlib.symbol_versioning import deprecated_function
53
58
DEFAULT_PLUGIN_PATH = None
61
66
return DEFAULT_PLUGIN_PATH
64
@deprecated_function(zero_ninetyone)
66
"""Return a dictionary of the plugins."""
67
return dict((name, plugin.module) for name, plugin in plugins().items())
70
69
def disable_plugins():
71
70
"""Disable loading plugins.
73
72
Future calls to load_plugins() will be ignored.
75
# TODO: jam 20060131 This should probably also disable
80
77
def _strip_trailing_sep(path):
81
78
return path.rstrip("\\/")
83
def set_plugins_path():
84
"""Set the path for plugins to be loaded from."""
81
def set_plugins_path(path=None):
82
"""Set the path for plugins to be loaded from.
84
:param path: The list of paths to search for plugins. By default,
85
path will be determined using get_standard_plugins_path.
86
if path is [], no plugins can be loaded.
89
path = get_standard_plugins_path()
90
_mod_plugins.__path__ = path
94
def get_standard_plugins_path():
95
"""Determine a plugin path suitable for general use."""
85
96
path = os.environ.get('BZR_PLUGIN_PATH',
86
97
get_default_plugin_path()).split(os.pathsep)
87
98
# Get rid of trailing slashes, since Python can't handle them when
88
99
# it tries to import modules.
89
100
path = map(_strip_trailing_sep, path)
90
# search the plugin path before the bzrlib installed dir
91
path.append(os.path.dirname(_mod_plugins.__file__))
92
_mod_plugins.__path__ = path
101
bzr_exe = bool(getattr(sys, 'frozen', None))
102
if bzr_exe: # expand path for bzr.exe
103
# We need to use relative path to system-wide plugin
104
# directory because bzrlib from standalone bzr.exe
105
# could be imported by another standalone program
106
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
107
# will become standalone exe). [bialix 20071123]
108
# __file__ typically is
109
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
110
# then plugins directory is
111
# C:\Program Files\Bazaar\plugins
112
# so relative path is ../../../plugins
113
path.append(osutils.abspath(osutils.pathjoin(
114
osutils.dirname(__file__), '../../../plugins')))
115
if not bzr_exe: # don't look inside library.zip
116
# search the plugin path before the bzrlib installed dir
117
path.append(os.path.dirname(_mod_plugins.__file__))
118
# search the arch independent path if we can determine that and
119
# the plugin is found nowhere else
120
if sys.platform != 'win32':
122
from distutils.sysconfig import get_python_lib
124
# If distutuils is not available, we just won't add that path
127
archless_path = osutils.pathjoin(get_python_lib(), 'bzrlib',
129
if archless_path not in path:
130
path.append(archless_path)
134
def load_plugins(path=None):
97
135
"""Load bzrlib plugins.
99
137
The environment variable BZR_PLUGIN_PATH is considered a delimited
180
if getattr(_mod_plugins, f, None):
181
mutter('Plugin name %s already loaded', f)
222
continue # We don't load __init__.py again in the plugin dir
223
elif getattr(_mod_plugins, f, None):
224
trace.mutter('Plugin name %s already loaded', f)
183
# mutter('add plugin name %s', f)
226
# trace.mutter('add plugin name %s', f)
184
227
plugin_names.add(f)
186
229
for name in plugin_names:
188
231
exec "import bzrlib.plugins.%s" % name in {}
189
232
except KeyboardInterrupt:
234
except errors.IncompatibleAPI, e:
235
trace.warning("Unable to load plugin %r. It requested API version "
236
"%s of module %s but the minimum exported version is %s, and "
237
"the maximum is %s" %
238
(name, e.wanted, e.api, e.minimum, e.current))
191
239
except Exception, e:
240
trace.warning("%s" % e)
192
241
## import pdb; pdb.set_trace()
193
242
if re.search('\.|-| ', name):
194
warning('Unable to load plugin %r from %r: '
195
'It is not a valid python module name.' % (name, d))
243
sanitised_name = re.sub('[-. ]', '_', name)
244
if sanitised_name.startswith('bzr_'):
245
sanitised_name = sanitised_name[len('bzr_'):]
246
trace.warning("Unable to load %r in %r as a plugin because the "
247
"file path isn't a valid module name; try renaming "
248
"it to %r." % (name, d, sanitised_name))
197
warning('Unable to load plugin %r from %r' % (name, d))
198
log_exception_quietly()
201
def load_from_zip(zip_name):
202
"""Load all the plugins in a zip."""
203
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
207
index = zip_name.rindex('.zip')
210
archive = zip_name[:index+4]
211
prefix = zip_name[index+5:]
213
mutter('Looking for plugins in %r', zip_name)
215
# use zipfile to get list of files/dirs inside zip
217
z = zipfile.ZipFile(archive)
218
namelist = z.namelist()
220
except zipfile.error:
225
prefix = prefix.replace('\\','/')
226
if prefix[-1] != '/':
229
namelist = [name[ix:]
231
if name.startswith(prefix)]
233
mutter('Names in archive: %r', namelist)
235
for name in namelist:
236
if not name or name.endswith('/'):
239
# '/' is used to separate pathname components inside zip archives
242
head, tail = '', name
244
head, tail = name.rsplit('/',1)
246
# we don't need looking in subdirectories
249
base, suffix = osutils.splitext(tail)
250
if suffix not in valid_suffixes:
253
if base == '__init__':
264
if getattr(_mod_plugins, plugin_name, None):
265
mutter('Plugin name %s already loaded', plugin_name)
269
exec "import bzrlib.plugins.%s" % plugin_name in {}
270
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
271
except KeyboardInterrupt:
274
## import pdb; pdb.set_trace()
275
warning('Unable to load plugin %r from %r'
277
log_exception_quietly()
250
trace.warning('Unable to load plugin %r from %r' % (name, d))
251
trace.log_exception_quietly()
252
if 'error' in debug.debug_flags:
253
trace.print_exception(sys.exc_info(), sys.stderr)
281
257
"""Return a dictionary of the plugins.
283
259
Each item in the dictionary is a PlugIn object.
375
def load_plugin_tests(self, loader):
376
"""Return the adapted plugin's test suite.
378
:param loader: The custom loader that should be used to load additional
382
if getattr(self.module, 'load_tests', None) is not None:
383
return loader.loadTestsFromModule(self.module)
394
387
def version_info(self):
395
388
"""Return the plugin's version_tuple or None if unknown."""
396
389
version_info = getattr(self.module, 'version_info', None)
397
if version_info is not None and len(version_info) == 3:
398
version_info = tuple(version_info) + ('final', 0)
390
if version_info is not None:
392
if isinstance(version_info, types.StringType):
393
version_info = version_info.split('.')
394
elif len(version_info) == 3:
395
version_info = tuple(version_info) + ('final', 0)
397
# The given version_info isn't even iteratible
398
trace.log_exception_quietly()
399
version_info = (version_info,)
399
400
return version_info
401
402
def _get__version__(self):
402
403
version_info = self.version_info()
403
if version_info is None:
404
if version_info is None or len(version_info) == 0:
405
if version_info[3] == 'final':
406
version_string = '%d.%d.%d' % version_info[:3]
408
version_string = '%d.%d.%d%s%d' % version_info
407
version_string = _format_version_tuple(version_info)
408
except (ValueError, TypeError, IndexError), e:
409
trace.log_exception_quietly()
410
# try to return something usefull for bad plugins, in stead of
412
version_string = '.'.join(map(str, version_info))
409
413
return version_string
411
415
__version__ = property(_get__version__)
added
removed
bzrlib/plugin.py
