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(), """
49
from bzrlib.trace import mutter, warning, log_exception_quietly
52
DEFAULT_PLUGIN_PATH = None
55
def get_default_plugin_path():
56
"""Get the DEFAULT_PLUGIN_PATH"""
57
global DEFAULT_PLUGIN_PATH
58
if DEFAULT_PLUGIN_PATH is None:
59
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
60
return DEFAULT_PLUGIN_PATH
64
"""Return a dictionary of the plugins."""
66
for name, plugin in plugins.__dict__.items():
67
if isinstance(plugin, types.ModuleType):
72
def disable_plugins():
73
"""Disable loading plugins.
75
Future calls to load_plugins() will be ignored.
77
# TODO: jam 20060131 This should probably also disable
82
def _strip_trailing_sep(path):
83
return path.rstrip("\\/")
85
def set_plugins_path():
86
"""Set the path for plugins to be loaded from."""
87
path = os.environ.get('BZR_PLUGIN_PATH',
88
get_default_plugin_path()).split(os.pathsep)
89
# Get rid of trailing slashes, since Python can't handle them when
90
# it tries to import modules.
91
path = map(_strip_trailing_sep, path)
92
# search the plugin path before the bzrlib installed dir
93
path.append(os.path.dirname(plugins.__file__))
94
plugins.__path__ = path
99
"""Load bzrlib plugins.
101
The environment variable BZR_PLUGIN_PATH is considered a delimited
102
set of paths to look through. Each entry is searched for *.py
103
files (and whatever other extensions are used in the platform,
106
load_from_dirs() provides the underlying mechanism and is called with
107
the default directory list to provide the normal behaviour.
111
# People can make sure plugins are loaded, they just won't be twice
115
# scan for all plugins in the path.
116
load_from_path(set_plugins_path())
119
def load_from_path(dirs):
120
"""Load bzrlib plugins found in each dir in dirs.
122
Loading a plugin means importing it into the python interpreter.
123
The plugin is expected to make calls to register commands when
124
it's loaded (or perhaps access other hooks in future.)
126
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
127
for future reference.
129
The python module path for bzrlib.plugins will be modified to be 'dirs'.
131
# We need to strip the trailing separators here as well as in the
132
# set_plugins_path function because calling code can pass anything in to
133
# this function, and since it sets plugins.__path__, it should set it to
134
# something that will be valid for Python to use (in case people try to
135
# run "import bzrlib.plugins.PLUGINNAME" after calling this function).
136
plugins.__path__ = map(_strip_trailing_sep, dirs)
140
mutter('looking for plugins in %s', d)
144
# it might be a zip: try loading from the zip.
149
# backwards compatability: load_from_dirs was the old name
150
# This was changed in 0.15
151
load_from_dirs = load_from_path
154
def load_from_dir(d):
155
"""Load the plugins in directory d."""
156
# Get the list of valid python suffixes for __init__.py?
157
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
158
# but it doesn't include compiled modules (.so, .dll, etc)
159
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
160
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
161
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
163
for f in os.listdir(d):
164
path = osutils.pathjoin(d, f)
165
if os.path.isdir(path):
166
for entry in package_entries:
167
# This directory should be a package, and thus added to
169
if os.path.isfile(osutils.pathjoin(path, entry)):
171
else: # This directory is not a package
174
for suffix_info in imp.get_suffixes():
175
if f.endswith(suffix_info[0]):
176
f = f[:-len(suffix_info[0])]
177
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
178
f = f[:-len('module')]
182
if getattr(plugins, f, None):
183
mutter('Plugin name %s already loaded', f)
185
# mutter('add plugin name %s', f)
188
for name in plugin_names:
190
exec "import bzrlib.plugins.%s" % name in {}
191
except KeyboardInterrupt:
194
## import pdb; pdb.set_trace()
195
if re.search('\.|-| ', name):
196
warning('Unable to load plugin %r from %r: '
197
'It is not a valid python module name.' % (name, d))
199
warning('Unable to load plugin %r from %r' % (name, d))
200
log_exception_quietly()
203
def load_from_zip(zip_name):
204
"""Load all the plugins in a zip."""
205
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
209
index = zip_name.rindex('.zip')
212
archive = zip_name[:index+4]
213
prefix = zip_name[index+5:]
215
mutter('Looking for plugins in %r', zip_name)
217
# use zipfile to get list of files/dirs inside zip
219
z = zipfile.ZipFile(archive)
220
namelist = z.namelist()
222
except zipfile.error:
227
prefix = prefix.replace('\\','/')
228
if prefix[-1] != '/':
231
namelist = [name[ix:]
233
if name.startswith(prefix)]
235
mutter('Names in archive: %r', namelist)
237
for name in namelist:
238
if not name or name.endswith('/'):
241
# '/' is used to separate pathname components inside zip archives
244
head, tail = '', name
246
head, tail = name.rsplit('/',1)
248
# we don't need looking in subdirectories
251
base, suffix = osutils.splitext(tail)
252
if suffix not in valid_suffixes:
255
if base == '__init__':
266
if getattr(plugins, plugin_name, None):
267
mutter('Plugin name %s already loaded', plugin_name)
271
exec "import bzrlib.plugins.%s" % plugin_name in {}
272
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
273
except KeyboardInterrupt:
276
## import pdb; pdb.set_trace()
277
warning('Unable to load plugin %r from %r'
279
log_exception_quietly()
282
class PluginsHelpIndex(object):
283
"""A help index that returns help topics for plugins."""
286
self.prefix = 'plugins/'
288
def get_topics(self, topic):
289
"""Search for topic in the loaded plugins.
291
This will not trigger loading of new plugins.
293
:param topic: A topic to search for.
294
:return: A list which is either empty or contains a single
295
RegisteredTopic entry.
299
if topic.startswith(self.prefix):
300
topic = topic[len(self.prefix):]
301
plugin_module_name = 'bzrlib.plugins.%s' % topic
303
module = sys.modules[plugin_module_name]
307
return [ModuleHelpTopic(module)]
310
class ModuleHelpTopic(object):
311
"""A help topic which returns the docstring for a module."""
313
def __init__(self, module):
316
:param module: The module for which help should be generated.
320
def get_help_text(self, additional_see_also=None):
321
"""Return a string with the help for this topic.
323
:param additional_see_also: Additional help topics to be
326
if not self.module.__doc__:
327
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
329
result = self.module.__doc__
330
if result[-1] != '\n':
332
# there is code duplicated here and in bzrlib/help_topic.py's
333
# matching Topic code. This should probably be factored in
334
# to a helper function and a common base class.
335
if additional_see_also is not None:
336
see_also = sorted(set(additional_see_also))
340
result += 'See also: '
341
result += ', '.join(see_also)
345
def get_help_topic(self):
346
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
347
return self.module.__name__[len('bzrlib.plugins.'):]
added
removed
bzrlib/plugin.py
