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
# This module implements plug-in support.
19
# Any python module in $BZR_PLUGIN_PATH will be imported upon initialization
20
# of bzrlib (and then forgotten about). In the plugin's main body, it should
21
# update any bzrlib registries it wants to extend; for example, to add new
22
# commands, import bzrlib.commands and add your new command to the
23
# 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
from bzrlib.osutils import config_dir
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
36
from bzrlib.lazy_import import lazy_import
37
lazy_import(globals(), """
50
from bzrlib import plugins as _mod_plugins
53
from bzrlib.symbol_versioning import deprecated_function, one_three
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
34
123
def load_plugins():
36
Find all python plugins and load them.
38
Loading a plugin means importing it into the python interpreter.
39
The plugin is expected to make calls to register commands when
40
it's loaded (or perhaps access other hooks in future.)
42
A list of plugs is stored in bzrlib.plugin.all_plugins for future
124
"""Load bzrlib plugins.
45
126
The environment variable BZR_PLUGIN_PATH is considered a delimited
46
127
set of paths to look through. Each entry is searched for *.py
47
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.
51
global all_plugins, _loaded
53
136
# People can make sure plugins are loaded, they just won't be twice
55
#raise BzrError("plugins already initialized")
60
from bzrlib.trace import log_error, mutter, log_exception
61
from bzrlib.errors import BzrError
62
from bzrlib import plugins
64
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
65
dirs.insert(0, os.path.dirname(plugins.__file__))
67
# The problem with imp.get_suffixes() is that it doesn't include
68
# .pyo which is technically valid
69
# It also means that "testmodule.so" will show up as both test and testmodule
70
# though it is only valid as 'test'
71
# but you should be careful, because "testmodule.py" loads as testmodule.
72
suffixes = imp.get_suffixes()
73
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
74
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
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)
76
# going through them one by one allows different plugins with the same
77
# filename in different directories in the path
78
mutter('looking for plugins in %s' % d)
82
if not os.path.isdir(d):
84
for f in os.listdir(d):
85
path = os.path.join(d, f)
86
if os.path.isdir(path):
87
for entry in package_entries:
88
# This directory should be a package, and thus added to
90
if os.path.isfile(os.path.join(path, entry)):
92
else: # This directory is not a package
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')]
95
for suffix_info in suffixes:
96
if f.endswith(suffix_info[0]):
97
f = f[:-len(suffix_info[0])]
98
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
99
f = f[:-len('module')]
103
mutter('add plugin name %s' % f)
206
if getattr(_mod_plugins, f, None):
207
trace.mutter('Plugin name %s already loaded', f)
209
# trace.mutter('add plugin name %s', f)
104
210
plugin_names.add(f)
106
plugin_names = list(plugin_names)
108
for name in plugin_names:
110
plugin_info = imp.find_module(name, [d])
111
mutter('load plugin %r' % (plugin_info,))
113
plugin = imp.load_module('bzrlib.plugin.' + name,
115
all_plugins.append(plugin)
117
if plugin_info[0] is not None:
118
plugin_info[0].close()
120
mutter('loaded succesfully')
122
log_error('Unable to load plugin %r from %r' % (name, d))
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
