1
# Copyright (C) 2004, 2005 by 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
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.
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.
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
54
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
60
"""Return a dictionary of the plugins."""
62
for name, plugin in bzrlib.plugins.__dict__.items():
63
if isinstance(plugin, types.ModuleType):
69
"""Load bzrlib plugins.
71
The environment variable BZR_PLUGIN_PATH is considered a delimited
72
set of paths to look through. Each entry is searched for *.py
73
files (and whatever other extensions are used in the platform,
76
load_from_dirs() provides the underlying mechanism and is called with
77
the default directory list to provide the normal behaviour.
81
# People can make sure plugins are loaded, they just won't be twice
83
#raise BzrError("plugins already initialized")
86
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
87
dirs.insert(0, os.path.dirname(plugins.__file__))
92
def load_from_dirs(dirs):
93
"""Load bzrlib plugins found in each dir in dirs.
95
Loading a plugin means importing it into the python interpreter.
96
The plugin is expected to make calls to register commands when
97
it's loaded (or perhaps access other hooks in future.)
99
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
100
for future reference.
102
# The problem with imp.get_suffixes() is that it doesn't include
103
# .pyo which is technically valid
104
# It also means that "testmodule.so" will show up as both test and testmodule
105
# though it is only valid as 'test'
106
# but you should be careful, because "testmodule.py" loads as testmodule.
107
suffixes = imp.get_suffixes()
108
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
109
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
113
mutter('looking for plugins in %s', d)
115
if not os.path.isdir(d):
117
for f in os.listdir(d):
118
path = os.path.join(d, f)
119
if os.path.isdir(path):
120
for entry in package_entries:
121
# This directory should be a package, and thus added to
123
if os.path.isfile(os.path.join(path, entry)):
125
else: # This directory is not a package
128
for suffix_info in suffixes:
129
if f.endswith(suffix_info[0]):
130
f = f[:-len(suffix_info[0])]
131
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
132
f = f[:-len('module')]
136
if getattr(bzrlib.plugins, f, None):
137
mutter('Plugin name %s already loaded', f)
139
mutter('add plugin name %s', f)
142
plugin_names = list(plugin_names)
144
for name in plugin_names:
146
plugin_info = imp.find_module(name, [d])
147
mutter('load plugin %r', plugin_info)
149
plugin = imp.load_module('bzrlib.plugins.' + name,
151
setattr(bzrlib.plugins, name, plugin)
153
if plugin_info[0] is not None:
154
plugin_info[0].close()
156
mutter('loaded succesfully')
157
except KeyboardInterrupt:
160
## import pdb; pdb.set_trace()
161
warning('Unable to load plugin %r from %r' % (name, d))
162
log_exception_quietly()
added
removed
bzrlib/plugin.py
