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.
47
from bzrlib.config import config_dir
48
from bzrlib.trace import log_error, mutter, log_exception, warning, \
50
from bzrlib.errors import BzrError
51
from bzrlib import plugins
53
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
60
"""Find all python plugins and load them.
62
Loading a plugin means importing it into the python interpreter.
63
The plugin is expected to make calls to register commands when
64
it's loaded (or perhaps access other hooks in future.)
66
A list of plugs is stored in bzrlib.plugin.all_plugins for future
69
The environment variable BZR_PLUGIN_PATH is considered a delimited
70
set of paths to look through. Each entry is searched for *.py
71
files (and whatever other extensions are used in the platform,
75
global all_plugins, _loaded
77
# People can make sure plugins are loaded, they just won't be twice
79
#raise BzrError("plugins already initialized")
82
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
83
dirs.insert(0, os.path.dirname(plugins.__file__))
85
# The problem with imp.get_suffixes() is that it doesn't include
86
# .pyo which is technically valid
87
# It also means that "testmodule.so" will show up as both test and testmodule
88
# though it is only valid as 'test'
89
# but you should be careful, because "testmodule.py" loads as testmodule.
90
suffixes = imp.get_suffixes()
91
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
92
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
94
# going through them one by one allows different plugins with the same
95
# filename in different directories in the path
96
mutter('looking for plugins in %s', d)
100
if not os.path.isdir(d):
102
for f in os.listdir(d):
103
path = os.path.join(d, f)
104
if os.path.isdir(path):
105
for entry in package_entries:
106
# This directory should be a package, and thus added to
108
if os.path.isfile(os.path.join(path, entry)):
110
else: # This directory is not a package
113
for suffix_info in suffixes:
114
if f.endswith(suffix_info[0]):
115
f = f[:-len(suffix_info[0])]
116
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
117
f = f[:-len('module')]
121
mutter('add plugin name %s', f)
124
plugin_names = list(plugin_names)
126
for name in plugin_names:
128
plugin_info = imp.find_module(name, [d])
129
mutter('load plugin %r', plugin_info)
131
plugin = imp.load_module('bzrlib.plugins.' + name,
133
all_plugins.append(plugin)
134
setattr(bzrlib.plugins, name, plugin)
136
if plugin_info[0] is not None:
137
plugin_info[0].close()
139
mutter('loaded succesfully')
140
except KeyboardInterrupt:
143
## import pdb; pdb.set_trace()
144
warning('Unable to load plugin %r from %r' % (name, d))
145
log_exception_quietly()
added
removed
bzrlib/plugin.py
