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.
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.
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.
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')
27
from bzrlib.osutils import config_dir
28
DEFAULT_PLUGIN_PATH = os.path.join(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
34
def load_plugins():
70
"""Load bzrlib 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
72
45
The environment variable BZR_PLUGIN_PATH is considered a delimited
73
46
set of paths to look through. Each entry is searched for *.py
74
47
files (and whatever other extensions are used in the platform,
77
load_from_dirs() provides the underlying mechanism and is called with
78
the default directory list to provide the normal behaviour.
51
global all_plugins, _loaded
82
53
# People can make sure plugins are loaded, they just won't be twice
84
55
#raise BzrError("plugins already initialized")
87
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
88
dirs.insert(0, os.path.dirname(plugins.__file__))
93
def load_from_dirs(dirs):
94
"""Load bzrlib plugins found in each dir in dirs.
96
Loading a plugin means importing it into the python interpreter.
97
The plugin is expected to make calls to register commands when
98
it's loaded (or perhaps access other hooks in future.)
100
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
101
for future reference.
60
from bzrlib.trace import log_error, mutter, log_exception
61
from bzrlib.errors import BzrError
63
bzrpath = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH)
103
65
# The problem with imp.get_suffixes() is that it doesn't include
104
66
# .pyo which is technically valid
105
67
# It also means that "testmodule.so" will show up as both test and testmodule
108
70
suffixes = imp.get_suffixes()
109
71
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
110
72
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
73
for d in bzrpath.split(os.pathsep):
74
# going through them one by one allows different plugins with the same
75
# filename in different directories in the path
76
mutter('looking for plugins in %s' % d)
114
mutter('looking for plugins in %s', d)
115
79
plugin_names = set()
116
80
if not os.path.isdir(d):
118
82
for f in os.listdir(d):
119
path = pathjoin(d, f)
83
path = os.path.join(d, f)
120
84
if os.path.isdir(path):
121
85
for entry in package_entries:
122
86
# This directory should be a package, and thus added to
124
if os.path.isfile(pathjoin(path, entry)):
88
if os.path.isfile(os.path.join(path, entry)):
126
90
else: # This directory is not a package
137
if getattr(bzrlib.plugins, f, None):
138
mutter('Plugin name %s already loaded', f)
140
mutter('add plugin name %s', f)
101
mutter('add plugin name %s' % f)
143
104
plugin_names = list(plugin_names)
144
105
plugin_names.sort()
145
106
for name in plugin_names:
147
108
plugin_info = imp.find_module(name, [d])
148
mutter('load plugin %r', plugin_info)
109
mutter('load plugin %r' % (plugin_info,))
150
plugin = imp.load_module('bzrlib.plugins.' + name,
111
plugin = imp.load_module('bzrlib.plugin.' + name,
152
setattr(bzrlib.plugins, name, plugin)
113
all_plugins.append(plugin)
154
115
if plugin_info[0] is not None:
155
116
plugin_info[0].close()
157
mutter('loaded succesfully')
158
except KeyboardInterrupt:
160
117
except Exception, e:
161
## import pdb; pdb.set_trace()
162
warning('Unable to load plugin %r from %r' % (name, d))
163
log_exception_quietly()
118
log_error('Unable to load plugin %r from %r' % (name, d))
added
removed
bzrlib/plugin.py
