1
# Copyright (C) 2004, 2005, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
36
from bzrlib.lazy_import import lazy_import
37
lazy_import(globals(), """
49
from bzrlib import plugins as _mod_plugins
52
from bzrlib.symbol_versioning import deprecated_function, one_three
53
from bzrlib.trace import mutter, warning, log_exception_quietly
56
DEFAULT_PLUGIN_PATH = None
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
67
def disable_plugins():
68
"""Disable loading plugins.
70
Future calls to load_plugins() will be ignored.
72
# TODO: jam 20060131 This should probably also disable
78
def _strip_trailing_sep(path):
79
return path.rstrip("\\/")
82
def set_plugins_path():
83
"""Set the path for plugins to be loaded from."""
84
path = os.environ.get('BZR_PLUGIN_PATH',
85
get_default_plugin_path()).split(os.pathsep)
86
bzr_exe = bool(getattr(sys, 'frozen', None))
87
if bzr_exe: # expand path for bzr.exe
88
# We need to use relative path to system-wide plugin
89
# directory because bzrlib from standalone bzr.exe
90
# could be imported by another standalone program
91
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
92
# will become standalone exe). [bialix 20071123]
93
# __file__ typically is
94
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
95
# then plugins directory is
96
# C:\Program Files\Bazaar\plugins
97
# so relative path is ../../../plugins
98
path.append(osutils.abspath(osutils.pathjoin(
99
osutils.dirname(__file__), '../../../plugins')))
100
# Get rid of trailing slashes, since Python can't handle them when
101
# it tries to import modules.
102
path = map(_strip_trailing_sep, path)
103
if not bzr_exe: # don't look inside library.zip
104
# search the plugin path before the bzrlib installed dir
105
path.append(os.path.dirname(_mod_plugins.__file__))
106
# search the arch independent path if we can determine that and
107
# the plugin is found nowhere else
108
if sys.platform != 'win32':
110
from distutils.sysconfig import get_python_lib
112
# If distutuils is not available, we just won't add that path
115
archless_path = osutils.pathjoin(get_python_lib(), 'bzrlib',
117
if archless_path not in path:
118
path.append(archless_path)
119
_mod_plugins.__path__ = path
124
"""Load bzrlib plugins.
126
The environment variable BZR_PLUGIN_PATH is considered a delimited
127
set of paths to look through. Each entry is searched for *.py
128
files (and whatever other extensions are used in the platform,
131
load_from_dirs() provides the underlying mechanism and is called with
132
the default directory list to provide the normal behaviour.
136
# People can make sure plugins are loaded, they just won't be twice
140
# scan for all plugins in the path.
141
load_from_path(set_plugins_path())
144
def load_from_path(dirs):
145
"""Load bzrlib plugins found in each dir in dirs.
147
Loading a plugin means importing it into the python interpreter.
148
The plugin is expected to make calls to register commands when
149
it's loaded (or perhaps access other hooks in future.)
151
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
152
for future reference.
154
The python module path for bzrlib.plugins will be modified to be 'dirs'.
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)
165
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."""
177
# Get the list of valid python suffixes for __init__.py?
178
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
179
# but it doesn't include compiled modules (.so, .dll, etc)
180
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
181
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
182
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
184
for f in os.listdir(d):
185
path = osutils.pathjoin(d, f)
186
if os.path.isdir(path):
187
for entry in package_entries:
188
# This directory should be a package, and thus added to
190
if os.path.isfile(osutils.pathjoin(path, entry)):
192
else: # This directory is not a package
195
for suffix_info in imp.get_suffixes():
196
if f.endswith(suffix_info[0]):
197
f = f[:-len(suffix_info[0])]
198
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
199
f = f[:-len('module')]
203
if getattr(_mod_plugins, f, None):
204
mutter('Plugin name %s already loaded', f)
206
# mutter('add plugin name %s', f)
209
for name in plugin_names:
211
exec "import bzrlib.plugins.%s" % name in {}
212
except KeyboardInterrupt:
215
## import pdb; pdb.set_trace()
216
if re.search('\.|-| ', name):
217
sanitised_name = re.sub('[-. ]', '_', name)
218
if sanitised_name.startswith('bzr_'):
219
sanitised_name = sanitised_name[len('bzr_'):]
220
warning("Unable to load %r in %r as a plugin because the "
221
"file path isn't a valid module name; try renaming "
222
"it to %r." % (name, d, sanitised_name))
224
warning('Unable to load plugin %r from %r' % (name, d))
225
log_exception_quietly()
226
if 'error' in debug.debug_flags:
227
trace.print_exception(sys.exc_info(), sys.stderr)
230
@deprecated_function(one_three)
231
def load_from_zip(zip_name):
232
"""Load all the plugins in a zip."""
233
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
236
index = zip_name.rindex('.zip')
239
archive = zip_name[:index+4]
240
prefix = zip_name[index+5:]
242
mutter('Looking for plugins in %r', zip_name)
244
# use zipfile to get list of files/dirs inside zip
246
z = zipfile.ZipFile(archive)
247
namelist = z.namelist()
249
except zipfile.error:
254
prefix = prefix.replace('\\','/')
255
if prefix[-1] != '/':
258
namelist = [name[ix:]
260
if name.startswith(prefix)]
262
mutter('Names in archive: %r', namelist)
264
for name in namelist:
265
if not name or name.endswith('/'):
268
# '/' is used to separate pathname components inside zip archives
271
head, tail = '', name
273
head, tail = name.rsplit('/',1)
275
# we don't need looking in subdirectories
278
base, suffix = osutils.splitext(tail)
279
if suffix not in valid_suffixes:
282
if base == '__init__':
293
if getattr(_mod_plugins, plugin_name, None):
294
mutter('Plugin name %s already loaded', plugin_name)
298
exec "import bzrlib.plugins.%s" % plugin_name in {}
299
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
300
except KeyboardInterrupt:
303
## import pdb; pdb.set_trace()
304
warning('Unable to load plugin %r from %r'
306
log_exception_quietly()
307
if 'error' in debug.debug_flags:
308
trace.print_exception(sys.exc_info(), sys.stderr)
312
"""Return a dictionary of the plugins.
314
Each item in the dictionary is a PlugIn object.
317
for name, plugin in _mod_plugins.__dict__.items():
318
if isinstance(plugin, types.ModuleType):
319
result[name] = PlugIn(name, plugin)
323
class PluginsHelpIndex(object):
324
"""A help index that returns help topics for plugins."""
327
self.prefix = 'plugins/'
329
def get_topics(self, topic):
330
"""Search for topic in the loaded plugins.
332
This will not trigger loading of new plugins.
334
:param topic: A topic to search for.
335
:return: A list which is either empty or contains a single
336
RegisteredTopic entry.
340
if topic.startswith(self.prefix):
341
topic = topic[len(self.prefix):]
342
plugin_module_name = 'bzrlib.plugins.%s' % topic
344
module = sys.modules[plugin_module_name]
348
return [ModuleHelpTopic(module)]
351
class ModuleHelpTopic(object):
352
"""A help topic which returns the docstring for a module."""
354
def __init__(self, module):
357
:param module: The module for which help should be generated.
361
def get_help_text(self, additional_see_also=None):
362
"""Return a string with the help for this topic.
364
:param additional_see_also: Additional help topics to be
367
if not self.module.__doc__:
368
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
370
result = self.module.__doc__
371
if result[-1] != '\n':
373
# there is code duplicated here and in bzrlib/help_topic.py's
374
# matching Topic code. This should probably be factored in
375
# to a helper function and a common base class.
376
if additional_see_also is not None:
377
see_also = sorted(set(additional_see_also))
381
result += 'See also: '
382
result += ', '.join(see_also)
386
def get_help_topic(self):
387
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
388
return self.module.__name__[len('bzrlib.plugins.'):]
391
class PlugIn(object):
392
"""The bzrlib representation of a plugin.
394
The PlugIn object provides a way to manipulate a given plugin module.
397
def __init__(self, name, module):
398
"""Construct a plugin for module."""
403
"""Get the path that this plugin was loaded from."""
404
if getattr(self.module, '__path__', None) is not None:
405
return os.path.abspath(self.module.__path__[0])
406
elif getattr(self.module, '__file__', None) is not None:
407
path = os.path.abspath(self.module.__file__)
408
if path[-4:] in ('.pyc', '.pyo'):
409
pypath = path[:-4] + '.py'
410
if os.path.isfile(pypath):
414
return repr(self.module)
417
return "<%s.%s object at %s, name=%s, module=%s>" % (
418
self.__class__.__module__, self.__class__.__name__, id(self),
419
self.name, self.module)
423
def test_suite(self):
424
"""Return the plugin's test suite."""
425
if getattr(self.module, 'test_suite', None) is not None:
426
return self.module.test_suite()
430
def load_plugin_tests(self, loader):
431
"""Return the adapted plugin's test suite.
433
:param loader: The custom loader that should be used to load additional
437
if getattr(self.module, 'load_tests', None) is not None:
438
return loader.loadTestsFromModule(self.module)
442
def version_info(self):
443
"""Return the plugin's version_tuple or None if unknown."""
444
version_info = getattr(self.module, 'version_info', None)
445
if version_info is not None and len(version_info) == 3:
446
version_info = tuple(version_info) + ('final', 0)
449
def _get__version__(self):
450
version_info = self.version_info()
451
if version_info is None:
453
if version_info[3] == 'final':
454
version_string = '%d.%d.%d' % version_info[:3]
456
version_string = '%d.%d.%d%s%d' % version_info
457
return version_string
459
__version__ = property(_get__version__)
added
removed
bzrlib/plugin.py
