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.
29
from sets import Set as set # python2.3
30
from bzrlib.trace import log_error
33
DEFAULT_PLUGIN_PATH = '~/.bzr.conf/plugins'
37
"""Find all python files which are plugins, and load them
39
The environment variable BZR_PLUGIN_PATH is considered a delimited set of
40
paths to look through. Each entry is searched for *.py files (and whatever
41
other extensions are used in the platform, such as *.pyd).
43
bzrpath = os.environ.get('BZR_PLUGIN_PATH')
45
bzrpath = os.path.expanduser(DEFAULT_PLUGIN_PATH)
47
# The problem with imp.get_suffixes() is that it doesn't include
48
# .pyo which is technically valid
49
# It also means that "testmodule.so" will show up as both test and testmodule
50
# though it is only valid as 'test'
51
# but you should be careful, because "testmodule.py" loads as testmodule.
52
suffixes = imp.get_suffixes()
53
suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
54
package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
55
for d in bzrpath.split(os.pathsep):
56
# going trough them one by one allows different plugins with the same
57
# filename in different directories in the path
61
if not os.path.isdir(d):
63
for f in os.listdir(d):
64
path = os.path.join(d, f)
65
if os.path.isdir(path):
66
for entry in package_entries:
67
# This directory should be a package, and thus added to
69
if os.path.isfile(os.path.join(path, entry)):
71
else: # This directory is not a package
74
for suffix_info in suffixes:
75
if f.endswith(suffix_info[0]):
76
f = f[:-len(suffix_info[0])]
77
if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
78
f = f[:-len('module')]
84
plugin_names = list(plugin_names)
86
for name in plugin_names:
88
plugin_info = imp.find_module(name, [d])
90
plugin = imp.load_module('bzrlib.plugin.' + name,
93
if plugin_info[0] is not None:
94
plugin_info[0].close()
96
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
added
removed
bzrlib/plugin.py
