15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# This module implements plug-in support.
19
# Any python module in $BZR_PLUGIN_PATH will be imported upon initialization
20
# of bzrlib (and then forgotten about). In the plugin's main body, it should
21
# update any bzrlib registries it wants to extend; for example, to add new
22
# commands, import bzrlib.commands and add your new command to the
23
# plugin_cmds variable.
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.
28
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
29
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):
35
68
def load_plugins():
37
Find all python plugins and load them.
39
Loading a plugin means importing it into the python interpreter.
40
The plugin is expected to make calls to register commands when
41
it's loaded (or perhaps access other hooks in future.)
43
A list of plugs is stored in bzrlib.plugin.all_plugins for future
69
"""Load bzrlib plugins.
46
71
The environment variable BZR_PLUGIN_PATH is considered a delimited
47
72
set of paths to look through. Each entry is searched for *.py
48
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.
52
global all_plugins, _loaded
54
81
# People can make sure plugins are loaded, they just won't be twice
56
83
#raise BzrError("plugins already initialized")
61
from bzrlib.trace import log_error, mutter, log_exception
62
from bzrlib.errors import BzrError
63
from bzrlib import plugins
65
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
86
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
66
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.
68
102
# The problem with imp.get_suffixes() is that it doesn't include
69
103
# .pyo which is technically valid
70
104
# It also means that "testmodule.so" will show up as both test and testmodule
104
mutter('add plugin name %s' % f)
136
if getattr(bzrlib.plugins, f, None):
137
mutter('Plugin name %s already loaded', f)
139
mutter('add plugin name %s', f)
107
142
plugin_names = list(plugin_names)
108
143
plugin_names.sort()
109
144
for name in plugin_names:
111
146
plugin_info = imp.find_module(name, [d])
112
mutter('load plugin %r' % (plugin_info,))
147
mutter('load plugin %r', plugin_info)
114
149
plugin = imp.load_module('bzrlib.plugins.' + name,
116
all_plugins.append(plugin)
117
151
setattr(bzrlib.plugins, name, plugin)
119
153
if plugin_info[0] is not None:
120
154
plugin_info[0].close()
122
156
mutter('loaded succesfully')
124
log_error('Unable to load plugin %r from %r' % (name, d))
157
except KeyboardInterrupt:
160
## import pdb; pdb.set_trace()
161
warning('Unable to load plugin %r from %r' % (name, d))
162
log_exception_quietly()