1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2004, 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
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.
26
DEFAULT_PLUGIN_PATH = '~/.bzr.conf/plugins'
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.
45
from bzrlib.lazy_import import lazy_import
46
lazy_import(globals(), """
57
from bzrlib.trace import mutter, warning, log_exception_quietly
60
DEFAULT_PLUGIN_PATH = None
63
def get_default_plugin_path():
64
"""Get the DEFAULT_PLUGIN_PATH"""
65
global DEFAULT_PLUGIN_PATH
66
if DEFAULT_PLUGIN_PATH is None:
67
DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
68
return DEFAULT_PLUGIN_PATH
75
"""Return a dictionary of the plugins."""
77
for name, plugin in plugins.__dict__.items():
78
if isinstance(plugin, types.ModuleType):
83
def disable_plugins():
84
"""Disable loading plugins.
86
Future calls to load_plugins() will be ignored.
88
# TODO: jam 20060131 This should probably also disable
31
94
def load_plugins():
33
Find all python plugins and load them.
35
Loading a plugin means importing it into the python interpreter.
36
The plugin is expected to make calls to register commands when
37
it's loaded (or perhaps access other hooks in future.)
39
A list of plugs is stored in bzrlib.plugin.all_plugins for future
95
"""Load bzrlib plugins.
42
97
The environment variable BZR_PLUGIN_PATH is considered a delimited
43
98
set of paths to look through. Each entry is searched for *.py
44
99
files (and whatever other extensions are used in the platform,
52
from sets import Set as set # python2.3
54
from bzrlib.trace import log_error, mutter, log_exception
55
from bzrlib.errors import BzrError
57
bzrpath = os.environ.get('BZR_PLUGIN_PATH')
59
bzrpath = os.path.expanduser(DEFAULT_PLUGIN_PATH)
63
raise BzrError("plugins already initialized")
65
# The problem with imp.get_suffixes() is that it doesn't include
66
# .pyo which is technically valid
67
# It also means that "testmodule.so" will show up as both test and testmodule
68
# though it is only valid as 'test'
69
# but you should be careful, because "testmodule.py" loads as testmodule.
70
suffixes = imp.get_suffixes()
71
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
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)
102
load_from_dirs() provides the underlying mechanism and is called with
103
the default directory list to provide the normal behaviour.
107
# People can make sure plugins are loaded, they just won't be twice
111
dirs = os.environ.get('BZR_PLUGIN_PATH',
112
get_default_plugin_path()).split(os.pathsep)
113
dirs.insert(0, os.path.dirname(plugins.__file__))
118
def load_from_dirs(dirs):
119
"""Load bzrlib plugins found in each dir in dirs.
121
Loading a plugin means importing it into the python interpreter.
122
The plugin is expected to make calls to register commands when
123
it's loaded (or perhaps access other hooks in future.)
125
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
126
for future reference.
128
# Get the list of valid python suffixes for __init__.py?
129
# this includes .py, .pyc, and .pyo (depending on if we are running -O)
130
# but it doesn't include compiled modules (.so, .dll, etc)
131
valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
132
if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
133
package_entries = ['__init__'+suffix for suffix in valid_suffixes]
137
mutter('looking for plugins in %s', d)
79
138
plugin_names = set()
80
139
if not os.path.isdir(d):
82
141
for f in os.listdir(d):
83
path = os.path.join(d, f)
142
path = osutils.pathjoin(d, f)
84
143
if os.path.isdir(path):
85
144
for entry in package_entries:
86
145
# This directory should be a package, and thus added to
88
if os.path.isfile(os.path.join(path, entry)):
147
if os.path.isfile(osutils.pathjoin(path, entry)):
90
149
else: # This directory is not a package
93
for suffix_info in suffixes:
152
for suffix_info in imp.get_suffixes():
94
153
if f.endswith(suffix_info[0]):
95
154
f = f[:-len(suffix_info[0])]
96
155
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
101
mutter('add plugin name %s' % f)
160
if getattr(plugins, f, None):
161
mutter('Plugin name %s already loaded', f)
163
mutter('add plugin name %s', f)
104
166
plugin_names = list(plugin_names)
105
167
plugin_names.sort()
106
168
for name in plugin_names:
108
170
plugin_info = imp.find_module(name, [d])
109
mutter('load plugin %r' % (plugin_info,))
171
mutter('load plugin %r', plugin_info)
111
plugin = imp.load_module('bzrlib.plugin.' + name,
173
plugin = imp.load_module('bzrlib.plugins.' + name,
113
all_plugins.append(plugin_info)
175
setattr(plugins, name, plugin)
115
177
if plugin_info[0] is not None:
116
178
plugin_info[0].close()
180
mutter('loaded succesfully')
181
except KeyboardInterrupt:
117
183
except Exception, e:
118
log_error('Unable to load plugin %r from %r' % (name, d))
184
## import pdb; pdb.set_trace()
185
warning('Unable to load plugin %r from %r' % (name, d))
186
log_exception_quietly()
added
removed
bzrlib/plugin.py
