1
# Copyright (C) 2004, 2005 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(), """
48
from bzrlib.trace import mutter, warning, log_exception_quietly
51
DEFAULT_PLUGIN_PATH = None
54
def get_default_plugin_path():
55
"""Get the DEFAULT_PLUGIN_PATH"""
56
global DEFAULT_PLUGIN_PATH
57
if DEFAULT_PLUGIN_PATH is None:
58
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
59
return DEFAULT_PLUGIN_PATH
63
"""Return a dictionary of the plugins."""
65
for name, plugin in plugins.__dict__.items():
66
if isinstance(plugin, types.ModuleType):
71
def disable_plugins():
72
"""Disable loading plugins.
74
Future calls to load_plugins() will be ignored.
76
# TODO: jam 20060131 This should probably also disable
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
# search the bzrlib installed dir before anything else.
87
path.insert(0, os.path.dirname(plugins.__file__))
88
plugins.__path__ = path
93
"""Load bzrlib plugins.
95
The environment variable BZR_PLUGIN_PATH is considered a delimited
96
set of paths to look through. Each entry is searched for *.py
97
files (and whatever other extensions are used in the platform,
100
load_from_dirs() provides the underlying mechanism and is called with
101
the default directory list to provide the normal behaviour.
105
# People can make sure plugins are loaded, they just won't be twice
109
# scan for all plugins in the path.
110
load_from_path(set_plugins_path())
113
def load_from_path(dirs):
114
"""Load bzrlib plugins found in each dir in dirs.
116
Loading a plugin means importing it into the python interpreter.
117
The plugin is expected to make calls to register commands when
118
it's loaded (or perhaps access other hooks in future.)
120
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
121
for future reference.
123
The python module path for bzrlib.plugins will be modified to be 'dirs'.
125
plugins.__path__ = dirs
129
mutter('looking for plugins in %s', d)
133
# it might be a zip: try loading from the zip.
138
# backwards compatability: load_from_dirs was the old name
139
# This was changed in 0.15
140
load_from_dirs = load_from_path
143
def load_from_dir(d):
144
"""Load the plugins in directory d."""
145
# Get the list of valid python suffixes for __init__.py?
146
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
147
# but it doesn't include compiled modules (.so, .dll, etc)
148
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
149
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
150
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
152
for f in os.listdir(d):
153
path = osutils.pathjoin(d, f)
154
if os.path.isdir(path):
155
for entry in package_entries:
156
# This directory should be a package, and thus added to
158
if os.path.isfile(osutils.pathjoin(path, entry)):
160
else: # This directory is not a package
163
for suffix_info in imp.get_suffixes():
164
if f.endswith(suffix_info[0]):
165
f = f[:-len(suffix_info[0])]
166
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
167
f = f[:-len('module')]
171
if getattr(plugins, f, None):
172
mutter('Plugin name %s already loaded', f)
174
# mutter('add plugin name %s', f)
177
for name in plugin_names:
179
exec "import bzrlib.plugins.%s" % name
180
except KeyboardInterrupt:
183
## import pdb; pdb.set_trace()
184
warning('Unable to load plugin %r from %r' % (name, d))
185
log_exception_quietly()
188
def load_from_zip(zip_name):
189
"""Load all the plugins in a zip."""
190
valid_suffixes = ('.py', '.pyc', '.pyo') # only python modules/packages
192
if '.zip' not in zip_name:
195
ziobj = zipimport.zipimporter(zip_name)
196
except zipimport.ZipImportError:
199
mutter('Looking for plugins in %r', zip_name)
203
# use zipfile to get list of files/dirs inside zip
204
z = zipfile.ZipFile(ziobj.archive)
205
namelist = z.namelist()
209
prefix = ziobj.prefix.replace('\\','/')
211
namelist = [name[ix:]
213
if name.startswith(prefix)]
215
mutter('Names in archive: %r', namelist)
217
for name in namelist:
218
if not name or name.endswith('/'):
221
# '/' is used to separate pathname components inside zip archives
224
head, tail = '', name
226
head, tail = name.rsplit('/',1)
228
# we don't need looking in subdirectories
231
base, suffix = osutils.splitext(tail)
232
if suffix not in valid_suffixes:
235
if base == '__init__':
246
if getattr(plugins, plugin_name, None):
247
mutter('Plugin name %s already loaded', plugin_name)
251
plugin = ziobj.load_module(plugin_name)
252
setattr(plugins, plugin_name, plugin)
253
mutter('Load plugin %s from zip %r', plugin_name, zip_name)
254
except zipimport.ZipImportError, e:
255
mutter('Unable to load plugin %r from %r: %s',
256
plugin_name, zip_name, str(e))
258
except KeyboardInterrupt:
261
## import pdb; pdb.set_trace()
262
warning('Unable to load plugin %r from %r'
264
log_exception_quietly()
added
removed
bzrlib/plugin.py
