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; 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
35
from bzrlib.lazy_import import lazy_import
36
lazy_import(globals(), """
46
from bzrlib import plugins as _mod_plugins
49
from bzrlib.symbol_versioning import deprecated_function, zero_ninetyone
50
from bzrlib.trace import mutter, warning, log_exception_quietly
53
DEFAULT_PLUGIN_PATH = None
56
def get_default_plugin_path():
57
"""Get the DEFAULT_PLUGIN_PATH"""
58
global DEFAULT_PLUGIN_PATH
59
if DEFAULT_PLUGIN_PATH is None:
60
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
61
return DEFAULT_PLUGIN_PATH
64
@deprecated_function(zero_ninetyone)
66
"""Return a dictionary of the plugins."""
67
return dict((name, plugin.module) for name, plugin in plugins().items())
70
def disable_plugins():
71
"""Disable loading plugins.
73
Future calls to load_plugins() will be ignored.
75
# TODO: jam 20060131 This should probably also disable
80
def _strip_trailing_sep(path):
81
return path.rstrip("\\/")
83
def set_plugins_path():
84
"""Set the path for plugins to be loaded from."""
85
path = os.environ.get('BZR_PLUGIN_PATH',
86
get_default_plugin_path()).split(os.pathsep)
87
# Get rid of trailing slashes, since Python can't handle them when
88
# it tries to import modules.
89
path = map(_strip_trailing_sep, path)
90
# search the plugin path before the bzrlib installed dir
91
path.append(os.path.dirname(_mod_plugins.__file__))
92
_mod_plugins.__path__ = path
97
"""Load bzrlib plugins.
99
The environment variable BZR_PLUGIN_PATH is considered a delimited
100
set of paths to look through. Each entry is searched for *.py
101
files (and whatever other extensions are used in the platform,
104
load_from_dirs() provides the underlying mechanism and is called with
105
the default directory list to provide the normal behaviour.
109
# People can make sure plugins are loaded, they just won't be twice
113
# scan for all plugins in the path.
114
load_from_path(set_plugins_path())
117
def load_from_path(dirs):
118
"""Load bzrlib plugins found in each dir in dirs.
120
Loading a plugin means importing it into the python interpreter.
121
The plugin is expected to make calls to register commands when
122
it's loaded (or perhaps access other hooks in future.)
124
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
125
for future reference.
127
The python module path for bzrlib.plugins will be modified to be 'dirs'.
129
# We need to strip the trailing separators here as well as in the
130
# set_plugins_path function because calling code can pass anything in to
131
# this function, and since it sets plugins.__path__, it should set it to
132
# something that will be valid for Python to use (in case people try to
133
# run "import bzrlib.plugins.PLUGINNAME" after calling this function).
134
_mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
138
mutter('looking for plugins in %s', d)
142
# it might be a zip: try loading from the zip.
147
# backwards compatability: load_from_dirs was the old name
148
# This was changed in 0.15
149
load_from_dirs = load_from_path
152
def load_from_dir(d):
153
"""Load the plugins in directory d."""
154
# Get the list of valid python suffixes for __init__.py?
155
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
156
# but it doesn't include compiled modules (.so, .dll, etc)
157
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
158
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
159
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
161
for f in os.listdir(d):
162
path = osutils.pathjoin(d, f)
163
if os.path.isdir(path):
164
for entry in package_entries:
165
# This directory should be a package, and thus added to
167
if os.path.isfile(osutils.pathjoin(path, entry)):
169
else: # This directory is not a package
172
for suffix_info in imp.get_suffixes():
173
if f.endswith(suffix_info[0]):
174
f = f[:-len(suffix_info[0])]
175
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
176
f = f[:-len('module')]
180
if getattr(_mod_plugins, f, None):
181
mutter('Plugin name %s already loaded', f)
183
# mutter('add plugin name %s', f)
186
for name in plugin_names:
188
exec "import bzrlib.plugins.%s" % name in {}
189
except KeyboardInterrupt:
192
## import pdb; pdb.set_trace()
193
if re.search('\.|-| ', name):
194
warning('Unable to load plugin %r from %r: '
195
'It is not a valid python module name.' % (name, d))
197
warning('Unable to load plugin %r from %r' % (name, d))
198
log_exception_quietly()
201
def load_from_zip(zip_name):
202
"""Load all the plugins in a zip."""
203
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
207
index = zip_name.rindex('.zip')
210
archive = zip_name[:index+4]
211
prefix = zip_name[index+5:]
213
mutter('Looking for plugins in %r', zip_name)
215
# use zipfile to get list of files/dirs inside zip
217
z = zipfile.ZipFile(archive)
218
namelist = z.namelist()
220
except zipfile.error:
225
prefix = prefix.replace('\\','/')
226
if prefix[-1] != '/':
229
namelist = [name[ix:]
231
if name.startswith(prefix)]
233
mutter('Names in archive: %r', namelist)
235
for name in namelist:
236
if not name or name.endswith('/'):
239
# '/' is used to separate pathname components inside zip archives
242
head, tail = '', name
244
head, tail = name.rsplit('/',1)
246
# we don't need looking in subdirectories
249
base, suffix = osutils.splitext(tail)
250
if suffix not in valid_suffixes:
253
if base == '__init__':
264
if getattr(_mod_plugins, plugin_name, None):
265
mutter('Plugin name %s already loaded', plugin_name)
269
exec "import bzrlib.plugins.%s" % plugin_name in {}
270
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
271
except KeyboardInterrupt:
274
## import pdb; pdb.set_trace()
275
warning('Unable to load plugin %r from %r'
277
log_exception_quietly()
281
"""Return a dictionary of the plugins.
283
Each item in the dictionary is a PlugIn object.
286
for name, plugin in _mod_plugins.__dict__.items():
287
if isinstance(plugin, types.ModuleType):
288
result[name] = PlugIn(name, plugin)
292
class PluginsHelpIndex(object):
293
"""A help index that returns help topics for plugins."""
296
self.prefix = 'plugins/'
298
def get_topics(self, topic):
299
"""Search for topic in the loaded plugins.
301
This will not trigger loading of new plugins.
303
:param topic: A topic to search for.
304
:return: A list which is either empty or contains a single
305
RegisteredTopic entry.
309
if topic.startswith(self.prefix):
310
topic = topic[len(self.prefix):]
311
plugin_module_name = 'bzrlib.plugins.%s' % topic
313
module = sys.modules[plugin_module_name]
317
return [ModuleHelpTopic(module)]
320
class ModuleHelpTopic(object):
321
"""A help topic which returns the docstring for a module."""
323
def __init__(self, module):
326
:param module: The module for which help should be generated.
330
def get_help_text(self, additional_see_also=None):
331
"""Return a string with the help for this topic.
333
:param additional_see_also: Additional help topics to be
336
if not self.module.__doc__:
337
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
339
result = self.module.__doc__
340
if result[-1] != '\n':
342
# there is code duplicated here and in bzrlib/help_topic.py's
343
# matching Topic code. This should probably be factored in
344
# to a helper function and a common base class.
345
if additional_see_also is not None:
346
see_also = sorted(set(additional_see_also))
350
result += 'See also: '
351
result += ', '.join(see_also)
355
def get_help_topic(self):
356
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
357
return self.module.__name__[len('bzrlib.plugins.'):]
360
class PlugIn(object):
361
"""The bzrlib representation of a plugin.
363
The PlugIn object provides a way to manipulate a given plugin module.
366
def __init__(self, name, module):
367
"""Construct a plugin for module."""
372
"""Get the path that this plugin was loaded from."""
373
if getattr(self.module, '__path__', None) is not None:
374
return os.path.abspath(self.module.__path__[0])
375
elif getattr(self.module, '__file__', None) is not None:
376
return os.path.abspath(self.module.__file__)
378
return repr(self.module)
381
return "<%s.%s object at %s, name=%s, module=%s>" % (
382
self.__class__.__module__, self.__class__.__name__, id(self),
383
self.name, self.module)
387
def test_suite(self):
388
"""Return the plugin's test suite."""
389
if getattr(self.module, 'test_suite', None) is not None:
390
return self.module.test_suite()
394
def version_info(self):
395
"""Return the plugin's version_tuple or None if unknown."""
396
version_info = getattr(self.module, 'version_info', None)
397
if version_info is not None and len(version_info) == 3:
398
version_info = tuple(version_info) + ('final', 0)
401
def _get__version__(self):
402
version_info = self.version_info()
403
if version_info is None:
405
if version_info[3] == 'final':
406
version_string = '%d.%d.%d' % version_info[:3]
408
version_string = '%d.%d.%d%s%d' % version_info
409
return version_string
411
__version__ = property(_get__version__)
added
removed
bzrlib/plugin.py
