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.
27
from bzrlib.osutils import config_dir
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
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')
61
"""Return a dictionary of the plugins."""
63
for name, plugin in bzrlib.plugins.__dict__.items():
64
if isinstance(plugin, types.ModuleType):
69
def disable_plugins():
70
"""Disable loading plugins.
72
Future calls to load_plugins() will be ignored.
74
# TODO: jam 20060131 This should probably also disable
34
80
def load_plugins():
36
Find all python plugins and load them.
38
Loading a plugin means importing it into the python interpreter.
39
The plugin is expected to make calls to register commands when
40
it's loaded (or perhaps access other hooks in future.)
42
A list of plugs is stored in bzrlib.plugin.all_plugins for future
81
"""Load bzrlib plugins.
45
83
The environment variable BZR_PLUGIN_PATH is considered a delimited
46
84
set of paths to look through. Each entry is searched for *.py
47
85
files (and whatever other extensions are used in the platform,
88
load_from_dirs() provides the underlying mechanism and is called with
89
the default directory list to provide the normal behaviour.
51
global all_plugins, _loaded
53
93
# People can make sure plugins are loaded, they just won't be twice
55
95
#raise BzrError("plugins already initialized")
60
from bzrlib.trace import log_error, mutter, log_exception
61
from bzrlib.errors import BzrError
62
from bzrlib import plugins
64
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
98
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
65
99
dirs.insert(0, os.path.dirname(plugins.__file__))
104
def load_from_dirs(dirs):
105
"""Load bzrlib plugins found in each dir in dirs.
107
Loading a plugin means importing it into the python interpreter.
108
The plugin is expected to make calls to register commands when
109
it's loaded (or perhaps access other hooks in future.)
111
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
112
for future reference.
67
114
# The problem with imp.get_suffixes() is that it doesn't include
68
115
# .pyo which is technically valid
69
116
# It also means that "testmodule.so" will show up as both test and testmodule
73
120
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
74
121
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
76
# going through them one by one allows different plugins with the same
77
# filename in different directories in the path
78
mutter('looking for plugins in %s' % d)
125
mutter('looking for plugins in %s', d)
81
126
plugin_names = set()
82
127
if not os.path.isdir(d):
84
129
for f in os.listdir(d):
85
path = os.path.join(d, f)
130
path = pathjoin(d, f)
86
131
if os.path.isdir(path):
87
132
for entry in package_entries:
88
133
# This directory should be a package, and thus added to
90
if os.path.isfile(os.path.join(path, entry)):
135
if os.path.isfile(pathjoin(path, entry)):
92
137
else: # This directory is not a package
103
mutter('add plugin name %s' % f)
148
if getattr(bzrlib.plugins, f, None):
149
mutter('Plugin name %s already loaded', f)
151
mutter('add plugin name %s', f)
106
154
plugin_names = list(plugin_names)
107
155
plugin_names.sort()
108
156
for name in plugin_names:
110
158
plugin_info = imp.find_module(name, [d])
111
mutter('load plugin %r' % (plugin_info,))
159
mutter('load plugin %r', plugin_info)
113
plugin = imp.load_module('bzrlib.plugin.' + name,
161
plugin = imp.load_module('bzrlib.plugins.' + name,
115
all_plugins.append(plugin)
163
setattr(bzrlib.plugins, name, plugin)
117
165
if plugin_info[0] is not None:
118
166
plugin_info[0].close()
168
mutter('loaded succesfully')
169
except KeyboardInterrupt:
119
171
except Exception, e:
120
log_error('Unable to load plugin %r from %r' % (name, d))
172
## import pdb; pdb.set_trace()
173
warning('Unable to load plugin %r from %r' % (name, d))
174
log_exception_quietly()
added
removed
bzrlib/plugin.py
