← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-02-02 20:49:50 UTC
  • mfrom: (2257.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070202204950-910381483d737306
(robertc) Merge support for import bzrlib.plugins.NAME.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
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
 
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.
 
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.
25
30
"""
26
31
 
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
 
 
42
32
import os
43
33
import sys
44
34
 
45
35
from bzrlib.lazy_import import lazy_import
46
36
lazy_import(globals(), """
47
37
import imp
 
38
import re
48
39
import types
 
40
import zipimport
49
41
 
50
42
from bzrlib import (
51
43
    config,
58
50
 
59
51
 
60
52
DEFAULT_PLUGIN_PATH = None
61
 
 
 
53
_loaded = False
62
54
 
63
55
def get_default_plugin_path():
64
56
    """Get the DEFAULT_PLUGIN_PATH"""
68
60
    return DEFAULT_PLUGIN_PATH
69
61
 
70
62
 
71
 
_loaded = False
72
 
 
73
 
 
74
63
def all_plugins():
75
64
    """Return a dictionary of the plugins."""
76
65
    result = {}
91
80
    _loaded = True
92
81
 
93
82
 
 
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 bzrlib installed dir before anything else.
 
88
    path.insert(0, os.path.dirname(plugins.__file__))
 
89
    plugins.__path__ = path
 
90
    return path
 
91
 
 
92
 
94
93
def load_plugins():
95
94
    """Load bzrlib plugins.
96
95
 
108
107
        return
109
108
    _loaded = True
110
109
 
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
 
    load_from_zips(dirs)
117
 
 
118
 
 
119
 
def load_from_dirs(dirs):
 
110
    # scan for all plugins in the path.
 
111
    load_from_path(set_plugins_path())
 
112
 
 
113
 
 
114
def load_from_path(dirs):
120
115
    """Load bzrlib plugins found in each dir in dirs.
121
116
 
122
117
    Loading a plugin means importing it into the python interpreter.
125
120
 
126
121
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
127
122
    for future reference.
 
123
 
 
124
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
128
125
    """
 
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."""
129
146
    # Get the list of valid python suffixes for __init__.py?
130
147
    # this includes .py, .pyc, and .pyo (depending on if we are running -O)
131
148
    # but it doesn't include compiled modules (.so, .dll, etc)
132
149
    valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
133
150
                              if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
134
151
    package_entries = ['__init__'+suffix for suffix in valid_suffixes]
135
 
    for d in dirs:
136
 
        if not d:
137
 
            continue
138
 
        mutter('looking for plugins in %s', d)
139
 
        plugin_names = set()
140
 
        if not os.path.isdir(d):
141
 
            continue
142
 
        for f in os.listdir(d):
143
 
            path = osutils.pathjoin(d, f)
144
 
            if os.path.isdir(path):
145
 
                for entry in package_entries:
146
 
                    # This directory should be a package, and thus added to
147
 
                    # the list
148
 
                    if os.path.isfile(osutils.pathjoin(path, entry)):
149
 
                        break
150
 
                else: # This directory is not a package
151
 
                    continue
152
 
            else:
153
 
                for suffix_info in imp.get_suffixes():
154
 
                    if f.endswith(suffix_info[0]):
155
 
                        f = f[:-len(suffix_info[0])]
156
 
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
157
 
                            f = f[:-len('module')]
158
 
                        break
159
 
                else:
160
 
                    continue
161
 
            if getattr(plugins, f, None):
162
 
                mutter('Plugin name %s already loaded', f)
163
 
            else:
164
 
                # mutter('add plugin name %s', f)
165
 
                plugin_names.add(f)
166
 
 
167
 
        plugin_names = list(plugin_names)
168
 
        plugin_names.sort()
169
 
        for name in plugin_names:
170
 
            try:
171
 
                plugin_info = imp.find_module(name, [d])
172
 
                # mutter('load plugin %r', plugin_info)
173
 
                try:
174
 
                    plugin = imp.load_module('bzrlib.plugins.' + name,
175
 
                                             *plugin_info)
176
 
                    setattr(plugins, name, plugin)
177
 
                finally:
178
 
                    if plugin_info[0] is not None:
179
 
                        plugin_info[0].close()
180
 
                # mutter('loaded succesfully')
181
 
            except KeyboardInterrupt:
182
 
                raise
183
 
            except Exception, e:
184
 
                ## import pdb; pdb.set_trace()
 
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:
185
189
                warning('Unable to load plugin %r from %r' % (name, d))
186
 
                log_exception_quietly()
187
 
 
188
 
 
189
 
def load_from_zips(zips):
190
 
    """Load bzr plugins from zip archives with zipimport.
191
 
    It's similar to load_from_dirs but plugins searched inside archives.
192
 
    """
193
 
    import zipfile
194
 
    import zipimport
195
 
 
 
190
            log_exception_quietly()
 
191
 
 
192
 
 
193
def load_from_zip(zip_name):
 
194
    """Load all the plugins in a zip."""
196
195
    valid_suffixes = ('.py', '.pyc', '.pyo')    # only python modules/packages
197
196
                                                # is allowed
198
 
    for zip_name in zips:
199
 
        if '.zip' not in zip_name:
200
 
            continue
 
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
    
201
255
        try:
202
 
            ziobj = zipimport.zipimporter(zip_name)
203
 
        except zipimport.ZipImportError:
204
 
            # not a valid zip
 
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))
205
262
            continue
206
 
        mutter('Looking for plugins in %r', zip_name)
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()
 
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()