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; for example, to add new
24
commands, import bzrlib.commands and add your new command to the plugin_cmds
27
BZR_PLUGIN_PATH is also honoured for any plugins imported via
28
'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.
35
from bzrlib.lazy_import import lazy_import
36
lazy_import(globals(), """
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')
48
from bzrlib import plugins as _mod_plugins
51
from bzrlib.symbol_versioning import deprecated_function, one_three
52
from bzrlib.trace import mutter, warning, log_exception_quietly
55
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):
58
def get_default_plugin_path():
59
"""Get the DEFAULT_PLUGIN_PATH"""
60
global DEFAULT_PLUGIN_PATH
61
if DEFAULT_PLUGIN_PATH is None:
62
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
63
return DEFAULT_PLUGIN_PATH
69
66
def disable_plugins():
77
def _strip_trailing_sep(path):
78
return path.rstrip("\\/")
81
def set_plugins_path():
82
"""Set the path for plugins to be loaded from."""
83
path = os.environ.get('BZR_PLUGIN_PATH',
84
get_default_plugin_path()).split(os.pathsep)
85
bzr_exe = bool(getattr(sys, 'frozen', None))
86
if bzr_exe: # expand path for bzr.exe
87
# We need to use relative path to system-wide plugin
88
# directory because bzrlib from standalone bzr.exe
89
# could be imported by another standalone program
90
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
91
# will become standalone exe). [bialix 20071123]
92
# __file__ typically is
93
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
94
# then plugins directory is
95
# C:\Program Files\Bazaar\plugins
96
# so relative path is ../../../plugins
97
path.append(osutils.abspath(osutils.pathjoin(
98
osutils.dirname(__file__), '../../../plugins')))
99
# Get rid of trailing slashes, since Python can't handle them when
100
# it tries to import modules.
101
path = map(_strip_trailing_sep, path)
102
if not bzr_exe: # don't look inside library.zip
103
# search the plugin path before the bzrlib installed dir
104
path.append(os.path.dirname(_mod_plugins.__file__))
105
# search the arch independent path if we can determine that and
106
# the plugin is found nowhere else
107
if sys.platform != 'win32':
109
from distutils.sysconfig import get_python_lib
111
# If distutuils is not available, we just won't add that path
114
archless_path = osutils.pathjoin(get_python_lib(), 'bzrlib',
116
if archless_path not in path:
117
path.append(archless_path)
118
_mod_plugins.__path__ = path
80
122
def load_plugins():
81
123
"""Load bzrlib plugins.
111
150
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
112
151
for future reference.
153
The python module path for bzrlib.plugins will be modified to be 'dirs'.
155
# We need to strip the trailing separators here as well as in the
156
# set_plugins_path function because calling code can pass anything in to
157
# this function, and since it sets plugins.__path__, it should set it to
158
# something that will be valid for Python to use (in case people try to
159
# run "import bzrlib.plugins.PLUGINNAME" after calling this function).
160
_mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
164
mutter('looking for plugins in %s', d)
169
# backwards compatability: load_from_dirs was the old name
170
# This was changed in 0.15
171
load_from_dirs = load_from_path
174
def load_from_dir(d):
175
"""Load the plugins in directory d."""
114
176
# Get the list of valid python suffixes for __init__.py?
115
177
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
116
178
# but it doesn't include compiled modules (.so, .dll, etc)
117
179
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
118
180
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
119
181
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
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:
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()
183
for f in os.listdir(d):
184
path = osutils.pathjoin(d, f)
185
if os.path.isdir(path):
186
for entry in package_entries:
187
# This directory should be a package, and thus added to
189
if os.path.isfile(osutils.pathjoin(path, entry)):
191
else: # This directory is not a package
194
for suffix_info in imp.get_suffixes():
195
if f.endswith(suffix_info[0]):
196
f = f[:-len(suffix_info[0])]
197
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
198
f = f[:-len('module')]
202
if getattr(_mod_plugins, f, None):
203
mutter('Plugin name %s already loaded', f)
205
# mutter('add plugin name %s', f)
208
for name in plugin_names:
210
exec "import bzrlib.plugins.%s" % name in {}
211
except KeyboardInterrupt:
214
## import pdb; pdb.set_trace()
215
if re.search('\.|-| ', name):
216
sanitised_name = re.sub('[-. ]', '_', name)
217
if sanitised_name.startswith('bzr_'):
218
sanitised_name = sanitised_name[len('bzr_'):]
219
warning("Unable to load %r in %r as a plugin because the "
220
"file path isn't a valid module name; try renaming "
221
"it to %r." % (name, d, sanitised_name))
171
223
warning('Unable to load plugin %r from %r' % (name, d))
172
log_exception_quietly()
224
log_exception_quietly()
225
if 'error' in debug.debug_flags:
226
trace.print_exception(sys.exc_info(), sys.stderr)
229
@deprecated_function(one_three)
230
def load_from_zip(zip_name):
231
"""Load all the plugins in a zip."""
232
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
235
index = zip_name.rindex('.zip')
238
archive = zip_name[:index+4]
239
prefix = zip_name[index+5:]
241
mutter('Looking for plugins in %r', zip_name)
243
# use zipfile to get list of files/dirs inside zip
245
z = zipfile.ZipFile(archive)
246
namelist = z.namelist()
248
except zipfile.error:
253
prefix = prefix.replace('\\','/')
254
if prefix[-1] != '/':
257
namelist = [name[ix:]
259
if name.startswith(prefix)]
261
mutter('Names in archive: %r', namelist)
263
for name in namelist:
264
if not name or name.endswith('/'):
267
# '/' is used to separate pathname components inside zip archives
270
head, tail = '', name
272
head, tail = name.rsplit('/',1)
274
# we don't need looking in subdirectories
277
base, suffix = osutils.splitext(tail)
278
if suffix not in valid_suffixes:
281
if base == '__init__':
292
if getattr(_mod_plugins, plugin_name, None):
293
mutter('Plugin name %s already loaded', plugin_name)
297
exec "import bzrlib.plugins.%s" % plugin_name in {}
298
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
299
except KeyboardInterrupt:
302
## import pdb; pdb.set_trace()
303
warning('Unable to load plugin %r from %r'
305
log_exception_quietly()
306
if 'error' in debug.debug_flags:
307
trace.print_exception(sys.exc_info(), sys.stderr)
311
"""Return a dictionary of the plugins.
313
Each item in the dictionary is a PlugIn object.
316
for name, plugin in _mod_plugins.__dict__.items():
317
if isinstance(plugin, types.ModuleType):
318
result[name] = PlugIn(name, plugin)
322
class PluginsHelpIndex(object):
323
"""A help index that returns help topics for plugins."""
326
self.prefix = 'plugins/'
328
def get_topics(self, topic):
329
"""Search for topic in the loaded plugins.
331
This will not trigger loading of new plugins.
333
:param topic: A topic to search for.
334
:return: A list which is either empty or contains a single
335
RegisteredTopic entry.
339
if topic.startswith(self.prefix):
340
topic = topic[len(self.prefix):]
341
plugin_module_name = 'bzrlib.plugins.%s' % topic
343
module = sys.modules[plugin_module_name]
347
return [ModuleHelpTopic(module)]
350
class ModuleHelpTopic(object):
351
"""A help topic which returns the docstring for a module."""
353
def __init__(self, module):
356
:param module: The module for which help should be generated.
360
def get_help_text(self, additional_see_also=None):
361
"""Return a string with the help for this topic.
363
:param additional_see_also: Additional help topics to be
366
if not self.module.__doc__:
367
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
369
result = self.module.__doc__
370
if result[-1] != '\n':
372
# there is code duplicated here and in bzrlib/help_topic.py's
373
# matching Topic code. This should probably be factored in
374
# to a helper function and a common base class.
375
if additional_see_also is not None:
376
see_also = sorted(set(additional_see_also))
380
result += 'See also: '
381
result += ', '.join(see_also)
385
def get_help_topic(self):
386
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
387
return self.module.__name__[len('bzrlib.plugins.'):]
390
class PlugIn(object):
391
"""The bzrlib representation of a plugin.
393
The PlugIn object provides a way to manipulate a given plugin module.
396
def __init__(self, name, module):
397
"""Construct a plugin for module."""
402
"""Get the path that this plugin was loaded from."""
403
if getattr(self.module, '__path__', None) is not None:
404
return os.path.abspath(self.module.__path__[0])
405
elif getattr(self.module, '__file__', None) is not None:
406
path = os.path.abspath(self.module.__file__)
407
if path[-4:] in ('.pyc', '.pyo'):
408
pypath = path[:-4] + '.py'
409
if os.path.isfile(pypath):
413
return repr(self.module)
416
return "<%s.%s object at %s, name=%s, module=%s>" % (
417
self.__class__.__module__, self.__class__.__name__, id(self),
418
self.name, self.module)
422
def test_suite(self):
423
"""Return the plugin's test suite."""
424
if getattr(self.module, 'test_suite', None) is not None:
425
return self.module.test_suite()
429
def load_plugin_tests(self, loader):
430
"""Return the adapted plugin's test suite.
432
:param loader: The custom loader that should be used to load additional
436
if getattr(self.module, 'load_tests', None) is not None:
437
return loader.loadTestsFromModule(self.module)
441
def version_info(self):
442
"""Return the plugin's version_tuple or None if unknown."""
443
version_info = getattr(self.module, 'version_info', None)
444
if version_info is not None and len(version_info) == 3:
445
version_info = tuple(version_info) + ('final', 0)
448
def _get__version__(self):
449
version_info = self.version_info()
450
if version_info is None:
452
if version_info[3] == 'final':
453
version_string = '%d.%d.%d' % version_info[:3]
455
version_string = '%d.%d.%d%s%d' % version_info
456
return version_string
458
__version__ = property(_get__version__)
added
removed
bzrlib/plugin.py
