← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-11 00:23:23 UTC
  • mfrom: (2070 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061011002323-82ba88c293d7caff
[merge] bzr.dev 2070

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
1
 
# Copyright (C) 2004, 2005 Canonical Ltd
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
2
2
#
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
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
"""bzr python plugin support.
19
 
 
20
 
When load_plugins() is invoked, any python module in any directory in
21
 
$BZR_PLUGIN_PATH will be imported.  The module will be imported as
22
 
'bzrlib.plugins.$BASENAME(PLUGIN)'.  In the plugin's main body, it should
23
 
update any bzrlib registries it wants to extend; for example, to add new
24
 
commands, import bzrlib.commands and add your new command to the plugin_cmds
25
 
variable.
26
 
 
27
 
BZR_PLUGIN_PATH is also honoured for any plugins imported via
28
 
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been 
29
 
called.
 
18
"""bzr python plugin support
 
19
 
 
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.
30
25
"""
31
26
 
 
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.
 
31
# 
 
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
 
36
#
 
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.
 
41
 
32
42
import os
33
43
import sys
34
44
 
35
45
from bzrlib.lazy_import import lazy_import
36
46
lazy_import(globals(), """
37
47
import imp
38
 
import re
39
48
import types
40
 
import zipimport
41
49
 
42
50
from bzrlib import (
43
51
    config,
50
58
 
51
59
 
52
60
DEFAULT_PLUGIN_PATH = None
53
 
_loaded = False
 
61
 
54
62
 
55
63
def get_default_plugin_path():
56
64
    """Get the DEFAULT_PLUGIN_PATH"""
60
68
    return DEFAULT_PLUGIN_PATH
61
69
 
62
70
 
 
71
_loaded = False
 
72
 
 
73
 
63
74
def all_plugins():
64
75
    """Return a dictionary of the plugins."""
65
76
    result = {}
80
91
    _loaded = True
81
92
 
82
93
 
83
 
def set_plugins_path():
84
 
    """Set the path for plugins to be loaded from."""
85
 
    path = os.environ.get('BZR_PLUGIN_PATH',
86
 
                          get_default_plugin_path()).split(os.pathsep)
87
 
    # search the plugin path before the bzrlib installed dir
88
 
    path.append(os.path.dirname(plugins.__file__))
89
 
    plugins.__path__ = path
90
 
    return path
91
 
 
92
 
 
93
94
def load_plugins():
94
95
    """Load bzrlib plugins.
95
96
 
107
108
        return
108
109
    _loaded = True
109
110
 
110
 
    # scan for all plugins in the path.
111
 
    load_from_path(set_plugins_path())
112
 
 
113
 
 
114
 
def load_from_path(dirs):
 
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__))
 
114
 
 
115
    load_from_dirs(dirs)
 
116
 
 
117
 
 
118
def load_from_dirs(dirs):
115
119
    """Load bzrlib plugins found in each dir in dirs.
116
120
 
117
121
    Loading a plugin means importing it into the python interpreter.
120
124
 
121
125
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
122
126
    for future reference.
123
 
 
124
 
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
125
127
    """
126
 
    plugins.__path__ = dirs
127
 
    for d in dirs:
128
 
        if not d:
129
 
            continue
130
 
        mutter('looking for plugins in %s', d)
131
 
        if os.path.isdir(d):
132
 
            load_from_dir(d)
133
 
        else:
134
 
            # it might be a zip: try loading from the zip.
135
 
            load_from_zip(d)
136
 
            continue
137
 
 
138
 
 
139
 
# backwards compatability: load_from_dirs was the old name
140
 
# This was changed in 0.15
141
 
load_from_dirs = load_from_path
142
 
 
143
 
 
144
 
def load_from_dir(d):
145
 
    """Load the plugins in directory d."""
146
128
    # Get the list of valid python suffixes for __init__.py?
147
129
    # this includes .py, .pyc, and .pyo (depending on if we are running -O)
148
130
    # but it doesn't include compiled modules (.so, .dll, etc)
149
131
    valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
150
132
                              if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
151
133
    package_entries = ['__init__'+suffix for suffix in valid_suffixes]
152
 
    plugin_names = set()
153
 
    for f in os.listdir(d):
154
 
        path = osutils.pathjoin(d, f)
155
 
        if os.path.isdir(path):
156
 
            for entry in package_entries:
157
 
                # This directory should be a package, and thus added to
158
 
                # the list
159
 
                if os.path.isfile(osutils.pathjoin(path, entry)):
160
 
                    break
161
 
            else: # This directory is not a package
162
 
                continue
163
 
        else:
164
 
            for suffix_info in imp.get_suffixes():
165
 
                if f.endswith(suffix_info[0]):
166
 
                    f = f[:-len(suffix_info[0])]
167
 
                    if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
168
 
                        f = f[:-len('module')]
169
 
                    break
170
 
            else:
171
 
                continue
172
 
        if getattr(plugins, f, None):
173
 
            mutter('Plugin name %s already loaded', f)
174
 
        else:
175
 
            # mutter('add plugin name %s', f)
176
 
            plugin_names.add(f)
177
 
    
178
 
    for name in plugin_names:
179
 
        try:
180
 
            exec "import bzrlib.plugins.%s" % name in {}
181
 
        except KeyboardInterrupt:
182
 
            raise
183
 
        except Exception, e:
184
 
            ## import pdb; pdb.set_trace()
185
 
            if re.search('\.|-| ', name):
186
 
                warning('Unable to load plugin %r from %r: '
187
 
                    'It is not a valid python module name.' % (name, d))
188
 
            else:
 
134
    for d in dirs:
 
135
        if not d:
 
136
            continue
 
137
        mutter('looking for plugins in %s', d)
 
138
        plugin_names = set()
 
139
        if not os.path.isdir(d):
 
140
            continue
 
141
        for f in os.listdir(d):
 
142
            path = osutils.pathjoin(d, f)
 
143
            if os.path.isdir(path):
 
144
                for entry in package_entries:
 
145
                    # This directory should be a package, and thus added to
 
146
                    # the list
 
147
                    if os.path.isfile(osutils.pathjoin(path, entry)):
 
148
                        break
 
149
                else: # This directory is not a package
 
150
                    continue
 
151
            else:
 
152
                for suffix_info in imp.get_suffixes():
 
153
                    if f.endswith(suffix_info[0]):
 
154
                        f = f[:-len(suffix_info[0])]
 
155
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
 
156
                            f = f[:-len('module')]
 
157
                        break
 
158
                else:
 
159
                    continue
 
160
            if getattr(plugins, f, None):
 
161
                mutter('Plugin name %s already loaded', f)
 
162
            else:
 
163
                mutter('add plugin name %s', f)
 
164
                plugin_names.add(f)
 
165
 
 
166
        plugin_names = list(plugin_names)
 
167
        plugin_names.sort()
 
168
        for name in plugin_names:
 
169
            try:
 
170
                plugin_info = imp.find_module(name, [d])
 
171
                mutter('load plugin %r', plugin_info)
 
172
                try:
 
173
                    plugin = imp.load_module('bzrlib.plugins.' + name,
 
174
                                             *plugin_info)
 
175
                    setattr(plugins, name, plugin)
 
176
                finally:
 
177
                    if plugin_info[0] is not None:
 
178
                        plugin_info[0].close()
 
179
 
 
180
                mutter('loaded succesfully')
 
181
            except KeyboardInterrupt:
 
182
                raise
 
183
            except Exception, e:
 
184
                ## import pdb; pdb.set_trace()
189
185
                warning('Unable to load plugin %r from %r' % (name, d))
190
 
            log_exception_quietly()
191
 
 
192
 
 
193
 
def load_from_zip(zip_name):
194
 
    """Load all the plugins in a zip."""
195
 
    valid_suffixes = ('.py', '.pyc', '.pyo')    # only python modules/packages
196
 
                                                # is allowed
197
 
    if '.zip' not in zip_name:
198
 
        return
199
 
    try:
200
 
        ziobj = zipimport.zipimporter(zip_name)
201
 
    except zipimport.ZipImportError:
202
 
        # not a valid zip
203
 
        return
204
 
    mutter('Looking for plugins in %r', zip_name)
205
 
    
206
 
    import zipfile
207
 
 
208
 
    # use zipfile to get list of files/dirs inside zip
209
 
    z = zipfile.ZipFile(ziobj.archive)
210
 
    namelist = z.namelist()
211
 
    z.close()
212
 
    
213
 
    if ziobj.prefix:
214
 
        prefix = ziobj.prefix.replace('\\','/')
215
 
        ix = len(prefix)
216
 
        namelist = [name[ix:]
217
 
                    for name in namelist
218
 
                    if name.startswith(prefix)]
219
 
    
220
 
    mutter('Names in archive: %r', namelist)
221
 
    
222
 
    for name in namelist:
223
 
        if not name or name.endswith('/'):
224
 
            continue
225
 
    
226
 
        # '/' is used to separate pathname components inside zip archives
227
 
        ix = name.rfind('/')
228
 
        if ix == -1:
229
 
            head, tail = '', name
230
 
        else:
231
 
            head, tail = name.rsplit('/',1)
232
 
        if '/' in head:
233
 
            # we don't need looking in subdirectories
234
 
            continue
235
 
    
236
 
        base, suffix = osutils.splitext(tail)
237
 
        if suffix not in valid_suffixes:
238
 
            continue
239
 
    
240
 
        if base == '__init__':
241
 
            # package
242
 
            plugin_name = head
243
 
        elif head == '':
244
 
            # module
245
 
            plugin_name = base
246
 
        else:
247
 
            continue
248
 
    
249
 
        if not plugin_name:
250
 
            continue
251
 
        if getattr(plugins, plugin_name, None):
252
 
            mutter('Plugin name %s already loaded', plugin_name)
253
 
            continue
254
 
    
255
 
        try:
256
 
            plugin = ziobj.load_module(plugin_name)
257
 
            setattr(plugins, plugin_name, plugin)
258
 
            mutter('Load plugin %s from zip %r', plugin_name, zip_name)
259
 
        except zipimport.ZipImportError, e:
260
 
            mutter('Unable to load plugin %r from %r: %s',
261
 
                   plugin_name, zip_name, str(e))
262
 
            continue
263
 
        except KeyboardInterrupt:
264
 
            raise
265
 
        except Exception, e:
266
 
            ## import pdb; pdb.set_trace()
267
 
            warning('Unable to load plugin %r from %r'
268
 
                    % (name, zip_name))
269
 
            log_exception_quietly()
 
186
                log_exception_quietly()