1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005 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.
47
from bzrlib.config import config_dir
48
from bzrlib.trace import log_error, mutter, log_exception, warning, \
50
from bzrlib.errors import BzrError
51
from bzrlib import plugins
53
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
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
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
# search the plugin path before the bzrlib installed dir
88
path.append(os.path.dirname(plugins.__file__))
89
plugins.__path__ = path
59
93
def load_plugins():
60
"""Find all python plugins and load them.
62
Loading a plugin means importing it into the python interpreter.
63
The plugin is expected to make calls to register commands when
64
it's loaded (or perhaps access other hooks in future.)
66
A list of plugs is stored in bzrlib.plugin.all_plugins for future
94
"""Load bzrlib plugins.
69
96
The environment variable BZR_PLUGIN_PATH is considered a delimited
70
97
set of paths to look through. Each entry is searched for *.py
71
98
files (and whatever other extensions are used in the platform,
101
load_from_dirs() provides the underlying mechanism and is called with
102
the default directory list to provide the normal behaviour.
75
global all_plugins, _loaded
77
106
# People can make sure plugins are loaded, they just won't be twice
79
#raise BzrError("plugins already initialized")
82
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
83
dirs.insert(0, os.path.dirname(plugins.__file__))
85
# The problem with imp.get_suffixes() is that it doesn't include
86
# .pyo which is technically valid
87
# It also means that "testmodule.so" will show up as both test and testmodule
88
# though it is only valid as 'test'
89
# but you should be careful, because "testmodule.py" loads as testmodule.
90
suffixes = imp.get_suffixes()
91
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
92
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
110
# scan for all plugins in the path.
111
load_from_path(set_plugins_path())
114
def load_from_path(dirs):
115
"""Load bzrlib plugins found in each dir in dirs.
117
Loading a plugin means importing it into the python interpreter.
118
The plugin is expected to make calls to register commands when
119
it's loaded (or perhaps access other hooks in future.)
121
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
122
for future reference.
124
The python module path for bzrlib.plugins will be modified to be 'dirs'.
126
plugins.__path__ = dirs
94
# going through them one by one allows different plugins with the same
95
# filename in different directories in the path
96
130
mutter('looking for plugins in %s', d)
100
if not os.path.isdir(d):
102
for f in os.listdir(d):
103
path = os.path.join(d, f)
104
if os.path.isdir(path):
105
for entry in package_entries:
106
# This directory should be a package, and thus added to
108
if os.path.isfile(os.path.join(path, entry)):
110
else: # This directory is not a package
134
# it might be a zip: try loading from the zip.
139
# backwards compatability: load_from_dirs was the old name
140
# This was changed in 0.15
141
load_from_dirs = load_from_path
144
def load_from_dir(d):
145
"""Load the plugins in directory d."""
146
# Get the list of valid python suffixes for __init__.py?
147
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
148
# but it doesn't include compiled modules (.so, .dll, etc)
149
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
150
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
151
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
153
for f in os.listdir(d):
154
path = osutils.pathjoin(d, f)
155
if os.path.isdir(path):
156
for entry in package_entries:
157
# This directory should be a package, and thus added to
159
if os.path.isfile(osutils.pathjoin(path, entry)):
161
else: # This directory is not a package
164
for suffix_info in imp.get_suffixes():
165
if f.endswith(suffix_info[0]):
166
f = f[:-len(suffix_info[0])]
167
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
168
f = f[:-len('module')]
113
for suffix_info in suffixes:
114
if f.endswith(suffix_info[0]):
115
f = f[:-len(suffix_info[0])]
116
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
117
f = f[:-len('module')]
121
mutter('add plugin name %s', f)
172
if getattr(plugins, f, None):
173
mutter('Plugin name %s already loaded', f)
175
# mutter('add plugin name %s', f)
122
176
plugin_names.add(f)
124
plugin_names = list(plugin_names)
126
for name in plugin_names:
128
plugin_info = imp.find_module(name, [d])
129
mutter('load plugin %r', plugin_info)
131
plugin = imp.load_module('bzrlib.plugins.' + name,
133
all_plugins.append(plugin)
134
setattr(bzrlib.plugins, name, plugin)
136
if plugin_info[0] is not None:
137
plugin_info[0].close()
139
mutter('loaded succesfully')
140
except KeyboardInterrupt:
143
## import pdb; pdb.set_trace()
178
for name in plugin_names:
180
exec "import bzrlib.plugins.%s" % name in {}
181
except KeyboardInterrupt:
184
## import pdb; pdb.set_trace()
185
if re.search('\.|-| ', name):
186
warning('Unable to load plugin %r from %r: '
187
'It is not a valid python module name.' % (name, d))
144
189
warning('Unable to load plugin %r from %r' % (name, d))
145
log_exception_quietly()
190
log_exception_quietly()
193
def load_from_zip(zip_name):
194
"""Load all the plugins in a zip."""
195
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
197
if '.zip' not in zip_name:
200
ziobj = zipimport.zipimporter(zip_name)
201
except zipimport.ZipImportError:
204
mutter('Looking for plugins in %r', zip_name)
208
# use zipfile to get list of files/dirs inside zip
209
z = zipfile.ZipFile(ziobj.archive)
210
namelist = z.namelist()
214
prefix = ziobj.prefix.replace('\\','/')
216
namelist = [name[ix:]
218
if name.startswith(prefix)]
220
mutter('Names in archive: %r', namelist)
222
for name in namelist:
223
if not name or name.endswith('/'):
226
# '/' is used to separate pathname components inside zip archives
229
head, tail = '', name
231
head, tail = name.rsplit('/',1)
233
# we don't need looking in subdirectories
236
base, suffix = osutils.splitext(tail)
237
if suffix not in valid_suffixes:
240
if base == '__init__':
251
if getattr(plugins, plugin_name, None):
252
mutter('Plugin name %s already loaded', plugin_name)
256
plugin = ziobj.load_module(plugin_name)
257
setattr(plugins, plugin_name, plugin)
258
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
259
except zipimport.ZipImportError, e:
260
mutter('Unable to load plugin %r from %r: %s',
261
plugin_name, zip_name, str(e))
263
except KeyboardInterrupt:
266
## import pdb; pdb.set_trace()
267
warning('Unable to load plugin %r from %r'
269
log_exception_quietly()
272
class PluginsHelpIndex(object):
273
"""A help index that returns help topics for plugins."""
276
self.prefix = 'plugins/'
278
def get_topics(self, topic):
279
"""Search for topic in the loaded plugins.
281
This will not trigger loading of new plugins.
283
:param topic: A topic to search for.
284
:return: A list which is either empty or contains a single
285
RegisteredTopic entry.
289
if topic.startswith(self.prefix):
290
topic = topic[len(self.prefix):]
291
plugin_module_name = 'bzrlib.plugins.%s' % topic
293
module = sys.modules[plugin_module_name]
297
return [ModuleHelpTopic(module)]
300
class ModuleHelpTopic(object):
301
"""A help topic which returns the docstring for a module."""
303
def __init__(self, module):
306
:param module: The module for which help should be generated.
310
def get_help_text(self, additional_see_also=None):
311
"""Return a string with the help for this topic.
313
:param additional_see_also: Additional help topics to be
316
if not self.module.__doc__:
317
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
319
result = self.module.__doc__
320
if result[-1] != '\n':
322
# there is code duplicated here and in bzrlib/help_topic.py's
323
# matching Topic code. This should probably be factored in
324
# to a helper function and a common base class.
325
if additional_see_also is not None:
326
see_also = sorted(set(additional_see_also))
330
result += 'See also: '
331
result += ', '.join(see_also)
335
def get_help_topic(self):
336
"""Return the modules help topic - its __name__ after bzrlib.plugins.."""
337
return self.module.__name__[len('bzrlib.plugins.'):]
added
removed
bzrlib/plugin.py
