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
46
from bzrlib import plugins as _mod_plugins
55
from bzrlib.symbol_versioning import (
49
from bzrlib.symbol_versioning import deprecated_function, one_three
50
from bzrlib.trace import mutter, warning, log_exception_quietly
61
53
DEFAULT_PLUGIN_PATH = None
64
@deprecated_function(deprecated_in((2, 0, 0)))
65
56
def get_default_plugin_path():
66
57
"""Get the DEFAULT_PLUGIN_PATH"""
67
58
global DEFAULT_PLUGIN_PATH
76
67
Future calls to load_plugins() will be ignored.
69
# TODO: jam 20060131 This should probably also disable
81
75
def _strip_trailing_sep(path):
82
76
return path.rstrip("\\/")
85
def set_plugins_path(path=None):
86
"""Set the path for plugins to be loaded from.
88
:param path: The list of paths to search for plugins. By default,
89
path will be determined using get_standard_plugins_path.
90
if path is [], no plugins can be loaded.
93
path = get_standard_plugins_path()
94
_mod_plugins.__path__ = path
98
def _append_new_path(paths, new_path):
99
"""Append a new path if it set and not already known."""
100
if new_path is not None and new_path not in paths:
101
paths.append(new_path)
105
def get_core_plugin_path():
79
def set_plugins_path():
80
"""Set the path for plugins to be loaded from."""
81
path = os.environ.get('BZR_PLUGIN_PATH',
82
get_default_plugin_path()).split(os.pathsep)
107
83
bzr_exe = bool(getattr(sys, 'frozen', None))
108
84
if bzr_exe: # expand path for bzr.exe
109
85
# We need to use relative path to system-wide plugin
116
92
# then plugins directory is
117
93
# C:\Program Files\Bazaar\plugins
118
94
# so relative path is ../../../plugins
119
core_path = osutils.abspath(osutils.pathjoin(
120
osutils.dirname(__file__), '../../../plugins'))
121
else: # don't look inside library.zip
122
# search the plugin path before the bzrlib installed dir
123
core_path = os.path.dirname(_mod_plugins.__file__)
127
def get_site_plugin_path():
128
"""Returns the path for the site installed plugins."""
129
if sys.platform == 'win32':
130
# We don't have (yet) a good answer for windows since that is certainly
131
# related to the way we build the installers. -- vila20090821
135
from distutils.sysconfig import get_python_lib
137
# If distutuils is not available, we just don't know where they are
140
site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
144
def get_user_plugin_path():
145
return osutils.pathjoin(config.config_dir(), 'plugins')
148
def get_standard_plugins_path():
149
"""Determine a plugin path suitable for general use."""
150
# Ad-Hoc default: core is not overriden by site but user can overrides both
151
# The rationale is that:
152
# - 'site' comes last, because these plugins should always be available and
153
# are supposed to be in sync with the bzr installed on site.
154
# - 'core' comes before 'site' so that running bzr from sources or a user
155
# installed version overrides the site version.
156
# - 'user' comes first, because... user is always right.
157
# - the above rules clearly defines which plugin version will be loaded if
158
# several exist. Yet, it is sometimes desirable to disable some directory
159
# so that a set of plugins is disabled as once. This can be done via
160
# -site, -core, -user.
162
env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
163
defaults = ['+core', '+site']
165
# The predefined references
166
refs = dict(core=get_core_plugin_path(),
167
site=get_site_plugin_path(),
168
user=get_user_plugin_path())
170
# Unset paths that should be removed
171
for k,v in refs.iteritems():
173
# defaults can never mention removing paths as that will make it
174
# impossible for the user to revoke these removals.
175
if removed in env_paths:
176
env_paths.remove(removed)
181
for p in env_paths + defaults:
182
if p.startswith('+'):
183
# Resolve reference if they are known
187
# Leave them untouched otherwise, user may have paths starting
190
_append_new_path(paths, p)
95
path.append(osutils.abspath(osutils.pathjoin(
96
osutils.dirname(__file__), '../../../plugins')))
192
97
# Get rid of trailing slashes, since Python can't handle them when
193
98
# it tries to import modules.
194
paths = map(_strip_trailing_sep, paths)
198
def load_plugins(path=None):
99
path = map(_strip_trailing_sep, path)
100
if not bzr_exe: # don't look inside library.zip
101
# search the plugin path before the bzrlib installed dir
102
path.append(os.path.dirname(_mod_plugins.__file__))
103
_mod_plugins.__path__ = path
199
108
"""Load bzrlib plugins.
201
110
The environment variable BZR_PLUGIN_PATH is considered a delimited
286
continue # We don't load __init__.py again in the plugin dir
287
elif getattr(_mod_plugins, f, None):
288
trace.mutter('Plugin name %s already loaded', f)
187
if getattr(_mod_plugins, f, None):
188
mutter('Plugin name %s already loaded', f)
290
# trace.mutter('add plugin name %s', f)
190
# mutter('add plugin name %s', f)
291
191
plugin_names.add(f)
293
193
for name in plugin_names:
295
195
exec "import bzrlib.plugins.%s" % name in {}
296
196
except KeyboardInterrupt:
298
except errors.IncompatibleAPI, e:
299
trace.warning("Unable to load plugin %r. It requested API version "
300
"%s of module %s but the minimum exported version is %s, and "
301
"the maximum is %s" %
302
(name, e.wanted, e.api, e.minimum, e.current))
303
198
except Exception, e:
304
trace.warning("%s" % e)
305
199
## import pdb; pdb.set_trace()
306
200
if re.search('\.|-| ', name):
307
201
sanitised_name = re.sub('[-. ]', '_', name)
308
if sanitised_name.startswith('bzr_'):
309
sanitised_name = sanitised_name[len('bzr_'):]
310
trace.warning("Unable to load %r in %r as a plugin because the "
311
"file path isn't a valid module name; try renaming "
312
"it to %r." % (name, d, sanitised_name))
202
warning("Unable to load %r in %r as a plugin because file path"
203
" isn't a valid module name; try renaming it to %r."
204
% (name, d, sanitised_name))
314
trace.warning('Unable to load plugin %r from %r' % (name, d))
315
trace.log_exception_quietly()
316
if 'error' in debug.debug_flags:
317
trace.print_exception(sys.exc_info(), sys.stderr)
206
warning('Unable to load plugin %r from %r' % (name, d))
207
log_exception_quietly()
210
@deprecated_function(one_three)
211
def load_from_zip(zip_name):
212
"""Load all the plugins in a zip."""
213
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
216
index = zip_name.rindex('.zip')
219
archive = zip_name[:index+4]
220
prefix = zip_name[index+5:]
222
mutter('Looking for plugins in %r', zip_name)
224
# use zipfile to get list of files/dirs inside zip
226
z = zipfile.ZipFile(archive)
227
namelist = z.namelist()
229
except zipfile.error:
234
prefix = prefix.replace('\\','/')
235
if prefix[-1] != '/':
238
namelist = [name[ix:]
240
if name.startswith(prefix)]
242
mutter('Names in archive: %r', namelist)
244
for name in namelist:
245
if not name or name.endswith('/'):
248
# '/' is used to separate pathname components inside zip archives
251
head, tail = '', name
253
head, tail = name.rsplit('/',1)
255
# we don't need looking in subdirectories
258
base, suffix = osutils.splitext(tail)
259
if suffix not in valid_suffixes:
262
if base == '__init__':
273
if getattr(_mod_plugins, plugin_name, None):
274
mutter('Plugin name %s already loaded', plugin_name)
278
exec "import bzrlib.plugins.%s" % plugin_name in {}
279
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
280
except KeyboardInterrupt:
283
## import pdb; pdb.set_trace()
284
warning('Unable to load plugin %r from %r'
286
log_exception_quietly()
321
290
"""Return a dictionary of the plugins.
323
292
Each item in the dictionary is a PlugIn object.
439
def load_plugin_tests(self, loader):
440
"""Return the adapted plugin's test suite.
442
:param loader: The custom loader that should be used to load additional
446
if getattr(self.module, 'load_tests', None) is not None:
447
return loader.loadTestsFromModule(self.module)
451
408
def version_info(self):
452
409
"""Return the plugin's version_tuple or None if unknown."""
453
410
version_info = getattr(self.module, 'version_info', None)
454
if version_info is not None:
456
if isinstance(version_info, types.StringType):
457
version_info = version_info.split('.')
458
elif len(version_info) == 3:
459
version_info = tuple(version_info) + ('final', 0)
461
# The given version_info isn't even iteratible
462
trace.log_exception_quietly()
463
version_info = (version_info,)
411
if version_info is not None and len(version_info) == 3:
412
version_info = tuple(version_info) + ('final', 0)
464
413
return version_info
466
415
def _get__version__(self):
467
416
version_info = self.version_info()
468
if version_info is None or len(version_info) == 0:
417
if version_info is None:
471
version_string = _format_version_tuple(version_info)
472
except (ValueError, TypeError, IndexError), e:
473
trace.log_exception_quietly()
474
# try to return something usefull for bad plugins, in stead of
476
version_string = '.'.join(map(str, version_info))
419
if version_info[3] == 'final':
420
version_string = '%d.%d.%d' % version_info[:3]
422
version_string = '%d.%d.%d%s%d' % version_info
477
423
return version_string
479
425
__version__ = property(_get__version__)
added
removed
bzrlib/plugin.py
