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.
31
from bzrlib.config import config_dir
32
from bzrlib.trace import log_error, mutter, log_exception, warning, \
34
from bzrlib.errors import BzrError
35
from bzrlib import plugins
37
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
45
Find all python plugins and load them.
47
Loading a plugin means importing it into the python interpreter.
48
The plugin is expected to make calls to register commands when
49
it's loaded (or perhaps access other hooks in future.)
51
A list of plugs is stored in bzrlib.plugin.all_plugins for future
54
The environment variable BZR_PLUGIN_PATH is considered a delimited
55
set of paths to look through. Each entry is searched for *.py
56
files (and whatever other extensions are used in the platform,
60
global all_plugins, _loaded
62
# People can make sure plugins are loaded, they just won't be twice
64
#raise BzrError("plugins already initialized")
67
dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
68
dirs.insert(0, os.path.dirname(plugins.__file__))
70
# The problem with imp.get_suffixes() is that it doesn't include
71
# .pyo which is technically valid
72
# It also means that "testmodule.so" will show up as both test and testmodule
73
# though it is only valid as 'test'
74
# but you should be careful, because "testmodule.py" loads as testmodule.
75
suffixes = imp.get_suffixes()
76
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
77
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
79
# going through them one by one allows different plugins with the same
80
# filename in different directories in the path
81
mutter('looking for plugins in %s' % d)
85
if not os.path.isdir(d):
87
for f in os.listdir(d):
88
path = os.path.join(d, f)
89
if os.path.isdir(path):
90
for entry in package_entries:
91
# This directory should be a package, and thus added to
93
if os.path.isfile(os.path.join(path, entry)):
95
else: # This directory is not a package
98
for suffix_info in suffixes:
99
if f.endswith(suffix_info[0]):
100
f = f[:-len(suffix_info[0])]
101
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
102
f = f[:-len('module')]
106
mutter('add plugin name %s' % f)
109
plugin_names = list(plugin_names)
111
for name in plugin_names:
113
plugin_info = imp.find_module(name, [d])
114
mutter('load plugin %r' % (plugin_info,))
116
plugin = imp.load_module('bzrlib.plugins.' + name,
118
all_plugins.append(plugin)
119
setattr(bzrlib.plugins, name, plugin)
121
if plugin_info[0] is not None:
122
plugin_info[0].close()
124
mutter('loaded succesfully')
128
warning('Unable to load plugin %r from %r' % (name, d))
129
log_exception_quietly()
added
removed
bzrlib/plugin.py
