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
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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
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.
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 import osutils
38
from bzrlib.lazy_import import lazy_import
40
lazy_import(globals(), """
46
_format_version_tuple,
52
from bzrlib import plugins as _mod_plugins
55
from bzrlib.symbol_versioning import deprecated_function
58
DEFAULT_PLUGIN_PATH = None
48
from bzrlib.config import config_dir
49
from bzrlib.trace import log_error, mutter, 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')
61
def get_default_plugin_path():
62
"""Get the DEFAULT_PLUGIN_PATH"""
63
global DEFAULT_PLUGIN_PATH
64
if DEFAULT_PLUGIN_PATH is None:
65
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
66
return DEFAULT_PLUGIN_PATH
61
"""Return a dictionary of the plugins."""
63
for name, plugin in bzrlib.plugins.__dict__.items():
64
if isinstance(plugin, types.ModuleType):
69
69
def disable_plugins():
72
72
Future calls to load_plugins() will be ignored.
77
def _strip_trailing_sep(path):
78
return path.rstrip("\\/")
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."""
96
path = os.environ.get('BZR_PLUGIN_PATH',
97
get_default_plugin_path()).split(os.pathsep)
98
# Get rid of trailing slashes, since Python can't handle them when
99
# it tries to import modules.
100
path = map(_strip_trailing_sep, 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):
74
# TODO: jam 20060131 This should probably also disable
135
81
"""Load bzrlib plugins.
137
83
The environment variable BZR_PLUGIN_PATH is considered a delimited
198
117
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
199
118
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
200
119
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
202
for f in os.listdir(d):
203
path = osutils.pathjoin(d, f)
204
if os.path.isdir(path):
205
for entry in package_entries:
206
# This directory should be a package, and thus added to
208
if os.path.isfile(osutils.pathjoin(path, entry)):
210
else: # This directory is not a package
213
for suffix_info in imp.get_suffixes():
214
if f.endswith(suffix_info[0]):
215
f = f[:-len(suffix_info[0])]
216
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
217
f = f[:-len('module')]
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)
226
# trace.mutter('add plugin name %s', f)
229
for name in plugin_names:
231
exec "import bzrlib.plugins.%s" % name in {}
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))
240
trace.warning("%s" % e)
241
## import pdb; pdb.set_trace()
242
if re.search('\.|-| ', name):
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))
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)
257
"""Return a dictionary of the plugins.
259
Each item in the dictionary is a PlugIn object.
262
for name, plugin in _mod_plugins.__dict__.items():
263
if isinstance(plugin, types.ModuleType):
264
result[name] = PlugIn(name, plugin)
268
class PluginsHelpIndex(object):
269
"""A help index that returns help topics for plugins."""
272
self.prefix = 'plugins/'
274
def get_topics(self, topic):
275
"""Search for topic in the loaded plugins.
277
This will not trigger loading of new plugins.
279
:param topic: A topic to search for.
280
:return: A list which is either empty or contains a single
281
RegisteredTopic entry.
285
if topic.startswith(self.prefix):
286
topic = topic[len(self.prefix):]
287
plugin_module_name = 'bzrlib.plugins.%s' % topic
289
module = sys.modules[plugin_module_name]
293
return [ModuleHelpTopic(module)]
296
class ModuleHelpTopic(object):
297
"""A help topic which returns the docstring for a module."""
299
def __init__(self, module):
302
:param module: The module for which help should be generated.
306
def get_help_text(self, additional_see_also=None, verbose=True):
307
"""Return a string with the help for this topic.
309
:param additional_see_also: Additional help topics to be
312
if not self.module.__doc__:
313
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
315
result = self.module.__doc__
316
if result[-1] != '\n':
318
# there is code duplicated here and in bzrlib/help_topic.py's
319
# matching Topic code. This should probably be factored in
320
# to a helper function and a common base class.
321
if additional_see_also is not None:
322
see_also = sorted(set(additional_see_also))
326
result += 'See also: '
327
result += ', '.join(see_also)
331
def get_help_topic(self):
332
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
333
return self.module.__name__[len('bzrlib.plugins.'):]
336
class PlugIn(object):
337
"""The bzrlib representation of a plugin.
339
The PlugIn object provides a way to manipulate a given plugin module.
342
def __init__(self, name, module):
343
"""Construct a plugin for module."""
348
"""Get the path that this plugin was loaded from."""
349
if getattr(self.module, '__path__', None) is not None:
350
return os.path.abspath(self.module.__path__[0])
351
elif getattr(self.module, '__file__', None) is not None:
352
path = os.path.abspath(self.module.__file__)
353
if path[-4:] in ('.pyc', '.pyo'):
354
pypath = path[:-4] + '.py'
355
if os.path.isfile(pypath):
359
return repr(self.module)
362
return "<%s.%s object at %s, name=%s, module=%s>" % (
363
self.__class__.__module__, self.__class__.__name__, id(self),
364
self.name, self.module)
368
def test_suite(self):
369
"""Return the plugin's test suite."""
370
if getattr(self.module, 'test_suite', None) is not None:
371
return self.module.test_suite()
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)
387
def version_info(self):
388
"""Return the plugin's version_tuple or None if unknown."""
389
version_info = getattr(self.module, 'version_info', None)
390
if version_info is not None:
123
mutter('looking for plugins in %s', d)
125
if not os.path.isdir(d):
127
for f in os.listdir(d):
128
path = pathjoin(d, f)
129
if os.path.isdir(path):
130
for entry in package_entries:
131
# This directory should be a package, and thus added to
133
if os.path.isfile(pathjoin(path, entry)):
135
else: # This directory is not a package
138
for suffix_info in imp.get_suffixes():
139
if f.endswith(suffix_info[0]):
140
f = f[:-len(suffix_info[0])]
141
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
142
f = f[:-len('module')]
146
if getattr(bzrlib.plugins, f, None):
147
mutter('Plugin name %s already loaded', f)
149
mutter('add plugin name %s', f)
152
plugin_names = list(plugin_names)
154
for name in plugin_names:
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,)
402
def _get__version__(self):
403
version_info = self.version_info()
404
if version_info is None or len(version_info) == 0:
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))
413
return version_string
415
__version__ = property(_get__version__)
156
plugin_info = imp.find_module(name, [d])
157
mutter('load plugin %r', plugin_info)
159
plugin = imp.load_module('bzrlib.plugins.' + name,
161
setattr(bzrlib.plugins, name, plugin)
163
if plugin_info[0] is not None:
164
plugin_info[0].close()
166
mutter('loaded succesfully')
167
except KeyboardInterrupt:
170
## import pdb; pdb.set_trace()
171
warning('Unable to load plugin %r from %r' % (name, d))
172
log_exception_quietly()
added
removed
bzrlib/plugin.py
