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
"""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, log_exception, 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')
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
61
64
"""Return a dictionary of the plugins."""
63
for name, plugin in bzrlib.plugins.__dict__.items():
66
for name, plugin in plugins.__dict__.items():
64
67
if isinstance(plugin, types.ModuleType):
65
68
result[name] = plugin
111
126
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
112
127
for future reference.
129
The python module path for bzrlib.plugins will be modified to be 'dirs'.
114
# The problem with imp.get_suffixes() is that it doesn't include
115
# .pyo which is technically valid
116
# It also means that "testmodule.so" will show up as both test and testmodule
117
# though it is only valid as 'test'
118
# but you should be careful, because "testmodule.py" loads as testmodule.
119
suffixes = imp.get_suffixes()
120
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
121
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
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)
125
140
mutter('looking for plugins in %s', d)
127
if not os.path.isdir(d):
144
# it might be a zip: try loading from the zip.
129
for f in os.listdir(d):
130
path = pathjoin(d, f)
131
if os.path.isdir(path):
132
for entry in package_entries:
133
# This directory should be a package, and thus added to
135
if os.path.isfile(pathjoin(path, entry)):
137
else: # This directory is not a package
140
for suffix_info in suffixes:
141
if f.endswith(suffix_info[0]):
142
f = f[:-len(suffix_info[0])]
143
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
144
f = f[:-len('module')]
148
if getattr(bzrlib.plugins, f, None):
149
mutter('Plugin name %s already loaded', f)
151
mutter('add plugin name %s', f)
154
plugin_names = list(plugin_names)
156
for name in plugin_names:
158
plugin_info = imp.find_module(name, [d])
159
mutter('load plugin %r', plugin_info)
161
plugin = imp.load_module('bzrlib.plugins.' + name,
163
setattr(bzrlib.plugins, name, plugin)
165
if plugin_info[0] is not None:
166
plugin_info[0].close()
168
mutter('loaded succesfully')
169
except KeyboardInterrupt:
172
## import pdb; pdb.set_trace()
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))
173
199
warning('Unable to load plugin %r from %r' % (name, d))
174
log_exception_quietly()
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
