1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005, 2007 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
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.
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
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.lazy_import import lazy_import
37
lazy_import(globals(), """
48
from bzrlib.config import config_dir
49
from bzrlib.trace import log_error, mutter, log_exception, 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')
50
from bzrlib import plugins as _mod_plugins
53
from bzrlib.symbol_versioning import deprecated_function, one_three
56
DEFAULT_PLUGIN_PATH = None
61
"""Return a dictionary of the plugins."""
63
for name, plugin in bzrlib.plugins.__dict__.items():
64
if isinstance(plugin, types.ModuleType):
59
def get_default_plugin_path():
60
"""Get the DEFAULT_PLUGIN_PATH"""
61
global DEFAULT_PLUGIN_PATH
62
if DEFAULT_PLUGIN_PATH is None:
63
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
64
return DEFAULT_PLUGIN_PATH
69
67
def disable_plugins():
111
151
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
112
152
for future reference.
154
The python module path for bzrlib.plugins will be modified to be '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']
156
# We need to strip the trailing separators here as well as in the
157
# set_plugins_path function because calling code can pass anything in to
158
# this function, and since it sets plugins.__path__, it should set it to
159
# something that will be valid for Python to use (in case people try to
160
# run "import bzrlib.plugins.PLUGINNAME" after calling this function).
161
_mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
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:
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()
165
trace.mutter('looking for plugins in %s', d)
170
# backwards compatability: load_from_dirs was the old name
171
# This was changed in 0.15
172
load_from_dirs = load_from_path
175
def load_from_dir(d):
176
"""Load the plugins in directory d.
178
d must be in the plugins module path already.
180
# Get the list of valid python suffixes for __init__.py?
181
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
182
# but it doesn't include compiled modules (.so, .dll, etc)
183
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
184
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
185
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
187
for f in os.listdir(d):
188
path = osutils.pathjoin(d, f)
189
if os.path.isdir(path):
190
for entry in package_entries:
191
# This directory should be a package, and thus added to
193
if os.path.isfile(osutils.pathjoin(path, entry)):
195
else: # This directory is not a package
198
for suffix_info in imp.get_suffixes():
199
if f.endswith(suffix_info[0]):
200
f = f[:-len(suffix_info[0])]
201
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
202
f = f[:-len('module')]
206
if getattr(_mod_plugins, f, None):
207
trace.mutter('Plugin name %s already loaded', f)
209
# trace.mutter('add plugin name %s', f)
212
for name in plugin_names:
214
exec "import bzrlib.plugins.%s" % name in {}
215
except KeyboardInterrupt:
217
except errors.IncompatibleAPI, e:
218
trace.warning("Unable to load plugin %r. It requested API version "
219
"%s of module %s but the minimum exported version is %s, and "
220
"the maximum is %s" %
221
(name, e.wanted, e.api, e.minimum, e.current))
223
trace.warning("%s" % e)
224
## import pdb; pdb.set_trace()
225
if re.search('\.|-| ', name):
226
sanitised_name = re.sub('[-. ]', '_', name)
227
if sanitised_name.startswith('bzr_'):
228
sanitised_name = sanitised_name[len('bzr_'):]
229
trace.warning("Unable to load %r in %r as a plugin because the "
230
"file path isn't a valid module name; try renaming "
231
"it to %r." % (name, d, sanitised_name))
233
trace.warning('Unable to load plugin %r from %r' % (name, d))
234
trace.log_exception_quietly()
235
if 'error' in debug.debug_flags:
236
trace.print_exception(sys.exc_info(), sys.stderr)
239
@deprecated_function(one_three)
240
def load_from_zip(zip_name):
241
"""Load all the plugins in a zip."""
242
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
245
index = zip_name.rindex('.zip')
248
archive = zip_name[:index+4]
249
prefix = zip_name[index+5:]
251
trace.mutter('Looking for plugins in %r', zip_name)
253
# use zipfile to get list of files/dirs inside zip
255
z = zipfile.ZipFile(archive)
256
namelist = z.namelist()
258
except zipfile.error:
263
prefix = prefix.replace('\\','/')
264
if prefix[-1] != '/':
267
namelist = [name[ix:]
269
if name.startswith(prefix)]
271
trace.mutter('Names in archive: %r', namelist)
273
for name in namelist:
274
if not name or name.endswith('/'):
277
# '/' is used to separate pathname components inside zip archives
280
head, tail = '', name
282
head, tail = name.rsplit('/',1)
284
# we don't need looking in subdirectories
287
base, suffix = osutils.splitext(tail)
288
if suffix not in valid_suffixes:
291
if base == '__init__':
302
if getattr(_mod_plugins, plugin_name, None):
303
trace.mutter('Plugin name %s already loaded', plugin_name)
307
exec "import bzrlib.plugins.%s" % plugin_name in {}
308
trace.mutter('Load plugin %s from zip %r', plugin_name, zip_name)
309
except KeyboardInterrupt:
312
## import pdb; pdb.set_trace()
313
trace.warning('Unable to load plugin %r from %r'
315
trace.log_exception_quietly()
316
if 'error' in debug.debug_flags:
317
trace.print_exception(sys.exc_info(), sys.stderr)
321
"""Return a dictionary of the plugins.
323
Each item in the dictionary is a PlugIn object.
326
for name, plugin in _mod_plugins.__dict__.items():
327
if isinstance(plugin, types.ModuleType):
328
result[name] = PlugIn(name, plugin)
332
class PluginsHelpIndex(object):
333
"""A help index that returns help topics for plugins."""
336
self.prefix = 'plugins/'
338
def get_topics(self, topic):
339
"""Search for topic in the loaded plugins.
341
This will not trigger loading of new plugins.
343
:param topic: A topic to search for.
344
:return: A list which is either empty or contains a single
345
RegisteredTopic entry.
349
if topic.startswith(self.prefix):
350
topic = topic[len(self.prefix):]
351
plugin_module_name = 'bzrlib.plugins.%s' % topic
353
module = sys.modules[plugin_module_name]
357
return [ModuleHelpTopic(module)]
360
class ModuleHelpTopic(object):
361
"""A help topic which returns the docstring for a module."""
363
def __init__(self, module):
366
:param module: The module for which help should be generated.
370
def get_help_text(self, additional_see_also=None):
371
"""Return a string with the help for this topic.
373
:param additional_see_also: Additional help topics to be
376
if not self.module.__doc__:
377
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
379
result = self.module.__doc__
380
if result[-1] != '\n':
382
# there is code duplicated here and in bzrlib/help_topic.py's
383
# matching Topic code. This should probably be factored in
384
# to a helper function and a common base class.
385
if additional_see_also is not None:
386
see_also = sorted(set(additional_see_also))
390
result += 'See also: '
391
result += ', '.join(see_also)
395
def get_help_topic(self):
396
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
397
return self.module.__name__[len('bzrlib.plugins.'):]
400
class PlugIn(object):
401
"""The bzrlib representation of a plugin.
403
The PlugIn object provides a way to manipulate a given plugin module.
406
def __init__(self, name, module):
407
"""Construct a plugin for module."""
412
"""Get the path that this plugin was loaded from."""
413
if getattr(self.module, '__path__', None) is not None:
414
return os.path.abspath(self.module.__path__[0])
415
elif getattr(self.module, '__file__', None) is not None:
416
path = os.path.abspath(self.module.__file__)
417
if path[-4:] in ('.pyc', '.pyo'):
418
pypath = path[:-4] + '.py'
419
if os.path.isfile(pypath):
423
return repr(self.module)
426
return "<%s.%s object at %s, name=%s, module=%s>" % (
427
self.__class__.__module__, self.__class__.__name__, id(self),
428
self.name, self.module)
432
def test_suite(self):
433
"""Return the plugin's test suite."""
434
if getattr(self.module, 'test_suite', None) is not None:
435
return self.module.test_suite()
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
def version_info(self):
452
"""Return the plugin's version_tuple or None if unknown."""
453
version_info = getattr(self.module, 'version_info', None)
454
if version_info is not None and len(version_info) == 3:
455
version_info = tuple(version_info) + ('final', 0)
458
def _get__version__(self):
459
version_info = self.version_info()
460
if version_info is None:
462
if version_info[3] == 'final':
463
version_string = '%d.%d.%d' % version_info[:3]
465
version_string = '%d.%d.%d%s%d' % version_info
466
return version_string
468
__version__ = property(_get__version__)
added
removed
bzrlib/plugin.py
