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
# 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.
27
from bzrlib.osutils import config_dir
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), '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
45
The environment variable BZR_PLUGIN_PATH is considered a delimited
46
set of paths to look through. Each entry is searched for *.py
47
files (and whatever other extensions are used in the platform,
51
global all_plugins, _loaded
53
# People can make sure plugins are loaded, they just won't be twice
55
#raise BzrError("plugins already initialized")
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)
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)
80
if not os.path.isdir(d):
82
for f in os.listdir(d):
83
path = os.path.join(d, f)
84
if os.path.isdir(path):
85
for entry in package_entries:
86
# This directory should be a package, and thus added to
88
if os.path.isfile(os.path.join(path, entry)):
90
else: # This directory is not a package
93
for suffix_info in suffixes:
94
if f.endswith(suffix_info[0]):
95
f = f[:-len(suffix_info[0])]
96
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
97
f = f[:-len('module')]
101
mutter('add plugin name %s' % f)
104
plugin_names = list(plugin_names)
106
for name in plugin_names:
108
plugin_info = imp.find_module(name, [d])
109
mutter('load plugin %r' % (plugin_info,))
111
plugin = imp.load_module('bzrlib.plugin.' + name,
113
all_plugins.append(plugin)
115
if plugin_info[0] is not None:
116
plugin_info[0].close()
118
log_error('Unable to load plugin %r from %r' % (name, d))
added
removed
bzrlib/plugin.py
