~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Robert Collins
  • Date: 2005-10-03 01:15:02 UTC
  • mfrom: (1092.2.28)
  • Revision ID: robertc@robertcollins.net-20051003011502-f579a509a136b774
mergeĀ fromĀ baz2bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2007, 2008 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
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.
24
 
 
25
 
See the plugin-api developer documentation for information about writing
26
 
plugins.
27
 
 
28
 
BZR_PLUGIN_PATH is also honoured for any plugins imported via
29
 
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been 
30
 
called.
31
 
"""
 
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.
 
24
 
32
25
 
33
26
import os
34
 
import sys
35
 
 
36
 
from bzrlib import osutils
37
 
 
38
 
from bzrlib.lazy_import import lazy_import
39
 
 
40
 
lazy_import(globals(), """
41
 
import imp
42
 
import re
43
 
import types
44
 
import zipfile
45
 
 
46
 
from bzrlib import (
47
 
    _format_version_tuple,
48
 
    config,
49
 
    debug,
50
 
    errors,
51
 
    trace,
52
 
    )
53
 
from bzrlib import plugins as _mod_plugins
54
 
""")
55
 
 
56
 
from bzrlib.symbol_versioning import deprecated_function, one_three
57
 
 
58
 
 
59
 
DEFAULT_PLUGIN_PATH = None
 
27
from bzrlib.osutils import config_dir
 
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
 
29
 
 
30
all_plugins = []
60
31
_loaded = False
61
32
 
62
 
def get_default_plugin_path():
63
 
    """Get the DEFAULT_PLUGIN_PATH"""
64
 
    global DEFAULT_PLUGIN_PATH
65
 
    if DEFAULT_PLUGIN_PATH is None:
66
 
        DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
67
 
    return DEFAULT_PLUGIN_PATH
68
 
 
69
 
 
70
 
def disable_plugins():
71
 
    """Disable loading plugins.
72
 
 
73
 
    Future calls to load_plugins() will be ignored.
74
 
    """
75
 
    load_plugins([])
76
 
 
77
 
 
78
 
def _strip_trailing_sep(path):
79
 
    return path.rstrip("\\/")
80
 
 
81
 
 
82
 
def set_plugins_path(path=None):
83
 
    """Set the path for plugins to be loaded from.
84
 
 
85
 
    :param path: The list of paths to search for plugins.  By default,
86
 
        path will be determined using get_standard_plugins_path.
87
 
        if path is [], no plugins can be loaded.
88
 
    """
89
 
    if path is None:
90
 
        path = get_standard_plugins_path()
91
 
    _mod_plugins.__path__ = path
92
 
    return path
93
 
 
94
 
 
95
 
def get_standard_plugins_path():
96
 
    """Determine a plugin path suitable for general use."""
97
 
    path = os.environ.get('BZR_PLUGIN_PATH',
98
 
                          get_default_plugin_path()).split(os.pathsep)
99
 
    # Get rid of trailing slashes, since Python can't handle them when
100
 
    # it tries to import modules.
101
 
    path = map(_strip_trailing_sep, path)
102
 
    bzr_exe = bool(getattr(sys, 'frozen', None))
103
 
    if bzr_exe:    # expand path for bzr.exe
104
 
        # We need to use relative path to system-wide plugin
105
 
        # directory because bzrlib from standalone bzr.exe
106
 
        # could be imported by another standalone program
107
 
        # (e.g. bzr-config; or TortoiseBzr/Olive if/when they
108
 
        # will become standalone exe). [bialix 20071123]
109
 
        # __file__ typically is
110
 
        # C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
111
 
        # then plugins directory is
112
 
        # C:\Program Files\Bazaar\plugins
113
 
        # so relative path is ../../../plugins
114
 
        path.append(osutils.abspath(osutils.pathjoin(
115
 
            osutils.dirname(__file__), '../../../plugins')))
116
 
    if not bzr_exe:     # don't look inside library.zip
117
 
        # search the plugin path before the bzrlib installed dir
118
 
        path.append(os.path.dirname(_mod_plugins.__file__))
119
 
    # search the arch independent path if we can determine that and
120
 
    # the plugin is found nowhere else
121
 
    if sys.platform != 'win32':
122
 
        try:
123
 
            from distutils.sysconfig import get_python_lib
124
 
        except ImportError:
125
 
            # If distutuils is not available, we just won't add that path
126
 
            pass
127
 
        else:
128
 
            archless_path = osutils.pathjoin(get_python_lib(), 'bzrlib',
129
 
                    'plugins')
130
 
            if archless_path not in path:
131
 
                path.append(archless_path)
132
 
    return path
133
 
 
134
 
 
135
 
def load_plugins(path=None):
136
 
    """Load bzrlib plugins.
 
33
 
 
34
def load_plugins():
 
35
    """
 
36
    Find all python plugins and load them.
 
37
 
 
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.)
 
41
 
 
42
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
 
43
    reference.
137
44
 
138
45
    The environment variable BZR_PLUGIN_PATH is considered a delimited
139
46
    set of paths to look through. Each entry is searched for *.py
140
47
    files (and whatever other extensions are used in the platform,
141
48
    such as *.pyd).
142
 
 
143
 
    load_from_dirs() provides the underlying mechanism and is called with
144
 
    the default directory list to provide the normal behaviour.
145
 
 
146
 
    :param path: The list of paths to search for plugins.  By default,
147
 
        path will be determined using get_standard_plugins_path.
148
 
        if path is [], no plugins can be loaded.
149
49
    """
150
 
    global _loaded
 
50
 
 
51
    global all_plugins, _loaded
151
52
    if _loaded:
152
53
        # People can make sure plugins are loaded, they just won't be twice
153
54
        return
 
55
        #raise BzrError("plugins already initialized")
154
56
    _loaded = True
155
57
 
156
 
    # scan for all plugins in the path.
157
 
    load_from_path(set_plugins_path(path))
158
 
 
159
 
 
160
 
def load_from_path(dirs):
161
 
    """Load bzrlib plugins found in each dir in dirs.
162
 
 
163
 
    Loading a plugin means importing it into the python interpreter.
164
 
    The plugin is expected to make calls to register commands when
165
 
    it's loaded (or perhaps access other hooks in future.)
166
 
 
167
 
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
168
 
    for future reference.
169
 
 
170
 
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
171
 
    """
172
 
    # We need to strip the trailing separators here as well as in the
173
 
    # set_plugins_path function because calling code can pass anything in to
174
 
    # this function, and since it sets plugins.__path__, it should set it to
175
 
    # something that will be valid for Python to use (in case people try to
176
 
    # run "import bzrlib.plugins.PLUGINNAME" after calling this function).
177
 
    _mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
 
58
    import sys, os, imp
 
59
    
 
60
    from bzrlib.trace import log_error, mutter, log_exception
 
61
    from bzrlib.errors import BzrError
 
62
    from bzrlib import plugins
 
63
 
 
64
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
 
65
    dirs.insert(0, os.path.dirname(plugins.__file__))
 
66
 
 
67
    # The problem with imp.get_suffixes() is that it doesn't include
 
68
    # .pyo which is technically valid
 
69
    # It also means that "testmodule.so" will show up as both test and testmodule
 
70
    # though it is only valid as 'test'
 
71
    # but you should be careful, because "testmodule.py" loads as testmodule.
 
72
    suffixes = imp.get_suffixes()
 
73
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
 
74
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
178
75
    for d in dirs:
 
76
        # going through them one by one allows different plugins with the same
 
77
        # filename in different directories in the path
 
78
        mutter('looking for plugins in %s' % d)
179
79
        if not d:
180
80
            continue
181
 
        trace.mutter('looking for plugins in %s', d)
182
 
        if os.path.isdir(d):
183
 
            load_from_dir(d)
184
 
 
185
 
 
186
 
# backwards compatability: load_from_dirs was the old name
187
 
# This was changed in 0.15
188
 
load_from_dirs = load_from_path
189
 
 
190
 
 
191
 
def load_from_dir(d):
192
 
    """Load the plugins in directory d.
193
 
    
194
 
    d must be in the plugins module path already.
195
 
    """
196
 
    # Get the list of valid python suffixes for __init__.py?
197
 
    # this includes .py, .pyc, and .pyo (depending on if we are running -O)
198
 
    # but it doesn't include compiled modules (.so, .dll, etc)
199
 
    valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
200
 
                              if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
201
 
    package_entries = ['__init__'+suffix for suffix in valid_suffixes]
202
 
    plugin_names = set()
203
 
    for f in os.listdir(d):
204
 
        path = osutils.pathjoin(d, f)
205
 
        if os.path.isdir(path):
206
 
            for entry in package_entries:
207
 
                # This directory should be a package, and thus added to
208
 
                # the list
209
 
                if os.path.isfile(osutils.pathjoin(path, entry)):
210
 
                    break
211
 
            else: # This directory is not a package
212
 
                continue
213
 
        else:
214
 
            for suffix_info in imp.get_suffixes():
215
 
                if f.endswith(suffix_info[0]):
216
 
                    f = f[:-len(suffix_info[0])]
217
 
                    if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
218
 
                        f = f[:-len('module')]
219
 
                    break
 
81
        plugin_names = set()
 
82
        if not os.path.isdir(d):
 
83
            continue
 
84
        for f in os.listdir(d):
 
85
            path = os.path.join(d, f)
 
86
            if os.path.isdir(path):
 
87
                for entry in package_entries:
 
88
                    # This directory should be a package, and thus added to
 
89
                    # the list
 
90
                    if os.path.isfile(os.path.join(path, entry)):
 
91
                        break
 
92
                else: # This directory is not a package
 
93
                    continue
220
94
            else:
221
 
                continue
222
 
        if f == '__init__':
223
 
            continue # We don't load __init__.py again in the plugin dir
224
 
        elif getattr(_mod_plugins, f, None):
225
 
            trace.mutter('Plugin name %s already loaded', f)
226
 
        else:
227
 
            # trace.mutter('add plugin name %s', f)
 
95
                for suffix_info in suffixes:
 
96
                    if f.endswith(suffix_info[0]):
 
97
                        f = f[:-len(suffix_info[0])]
 
98
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
 
99
                            f = f[:-len('module')]
 
100
                        break
 
101
                else:
 
102
                    continue
 
103
            mutter('add plugin name %s' % f)
228
104
            plugin_names.add(f)
229
 
    
230
 
    for name in plugin_names:
231
 
        try:
232
 
            exec "import bzrlib.plugins.%s" % name in {}
233
 
        except KeyboardInterrupt:
234
 
            raise
235
 
        except errors.IncompatibleAPI, e:
236
 
            trace.warning("Unable to load plugin %r. It requested API version "
237
 
                "%s of module %s but the minimum exported version is %s, and "
238
 
                "the maximum is %s" %
239
 
                (name, e.wanted, e.api, e.minimum, e.current))
240
 
        except Exception, e:
241
 
            trace.warning("%s" % e)
242
 
            ## import pdb; pdb.set_trace()
243
 
            if re.search('\.|-| ', name):
244
 
                sanitised_name = re.sub('[-. ]', '_', name)
245
 
                if sanitised_name.startswith('bzr_'):
246
 
                    sanitised_name = sanitised_name[len('bzr_'):]
247
 
                trace.warning("Unable to load %r in %r as a plugin because the "
248
 
                        "file path isn't a valid module name; try renaming "
249
 
                        "it to %r." % (name, d, sanitised_name))
250
 
            else:
251
 
                trace.warning('Unable to load plugin %r from %r' % (name, d))
252
 
            trace.log_exception_quietly()
253
 
            if 'error' in debug.debug_flags:
254
 
                trace.print_exception(sys.exc_info(), sys.stderr)
255
 
 
256
 
 
257
 
@deprecated_function(one_three)
258
 
def load_from_zip(zip_name):
259
 
    """Load all the plugins in a zip."""
260
 
    valid_suffixes = ('.py', '.pyc', '.pyo')    # only python modules/packages
261
 
                                                # is allowed
262
 
    try:
263
 
        index = zip_name.rindex('.zip')
264
 
    except ValueError:
265
 
        return
266
 
    archive = zip_name[:index+4]
267
 
    prefix = zip_name[index+5:]
268
 
 
269
 
    trace.mutter('Looking for plugins in %r', zip_name)
270
 
 
271
 
    # use zipfile to get list of files/dirs inside zip
272
 
    try:
273
 
        z = zipfile.ZipFile(archive)
274
 
        namelist = z.namelist()
275
 
        z.close()
276
 
    except zipfile.error:
277
 
        # not a valid zip
278
 
        return
279
 
 
280
 
    if prefix:
281
 
        prefix = prefix.replace('\\','/')
282
 
        if prefix[-1] != '/':
283
 
            prefix += '/'
284
 
        ix = len(prefix)
285
 
        namelist = [name[ix:]
286
 
                    for name in namelist
287
 
                    if name.startswith(prefix)]
288
 
 
289
 
    trace.mutter('Names in archive: %r', namelist)
290
 
    
291
 
    for name in namelist:
292
 
        if not name or name.endswith('/'):
293
 
            continue
294
 
    
295
 
        # '/' is used to separate pathname components inside zip archives
296
 
        ix = name.rfind('/')
297
 
        if ix == -1:
298
 
            head, tail = '', name
299
 
        else:
300
 
            head, tail = name.rsplit('/',1)
301
 
        if '/' in head:
302
 
            # we don't need looking in subdirectories
303
 
            continue
304
 
    
305
 
        base, suffix = osutils.splitext(tail)
306
 
        if suffix not in valid_suffixes:
307
 
            continue
308
 
    
309
 
        if base == '__init__':
310
 
            # package
311
 
            plugin_name = head
312
 
        elif head == '':
313
 
            # module
314
 
            plugin_name = base
315
 
        else:
316
 
            continue
317
 
    
318
 
        if not plugin_name:
319
 
            continue
320
 
        if getattr(_mod_plugins, plugin_name, None):
321
 
            trace.mutter('Plugin name %s already loaded', plugin_name)
322
 
            continue
323
 
    
324
 
        try:
325
 
            exec "import bzrlib.plugins.%s" % plugin_name in {}
326
 
            trace.mutter('Load plugin %s from zip %r', plugin_name, zip_name)
327
 
        except KeyboardInterrupt:
328
 
            raise
329
 
        except Exception, e:
330
 
            ## import pdb; pdb.set_trace()
331
 
            trace.warning('Unable to load plugin %r from %r'
332
 
                    % (name, zip_name))
333
 
            trace.log_exception_quietly()
334
 
            if 'error' in debug.debug_flags:
335
 
                trace.print_exception(sys.exc_info(), sys.stderr)
336
 
 
337
 
 
338
 
def plugins():
339
 
    """Return a dictionary of the plugins.
340
 
    
341
 
    Each item in the dictionary is a PlugIn object.
342
 
    """
343
 
    result = {}
344
 
    for name, plugin in _mod_plugins.__dict__.items():
345
 
        if isinstance(plugin, types.ModuleType):
346
 
            result[name] = PlugIn(name, plugin)
347
 
    return result
348
 
 
349
 
 
350
 
class PluginsHelpIndex(object):
351
 
    """A help index that returns help topics for plugins."""
352
 
 
353
 
    def __init__(self):
354
 
        self.prefix = 'plugins/'
355
 
 
356
 
    def get_topics(self, topic):
357
 
        """Search for topic in the loaded plugins.
358
 
 
359
 
        This will not trigger loading of new plugins.
360
 
 
361
 
        :param topic: A topic to search for.
362
 
        :return: A list which is either empty or contains a single
363
 
            RegisteredTopic entry.
364
 
        """
365
 
        if not topic:
366
 
            return []
367
 
        if topic.startswith(self.prefix):
368
 
            topic = topic[len(self.prefix):]
369
 
        plugin_module_name = 'bzrlib.plugins.%s' % topic
370
 
        try:
371
 
            module = sys.modules[plugin_module_name]
372
 
        except KeyError:
373
 
            return []
374
 
        else:
375
 
            return [ModuleHelpTopic(module)]
376
 
 
377
 
 
378
 
class ModuleHelpTopic(object):
379
 
    """A help topic which returns the docstring for a module."""
380
 
 
381
 
    def __init__(self, module):
382
 
        """Constructor.
383
 
 
384
 
        :param module: The module for which help should be generated.
385
 
        """
386
 
        self.module = module
387
 
 
388
 
    def get_help_text(self, additional_see_also=None):
389
 
        """Return a string with the help for this topic.
390
 
 
391
 
        :param additional_see_also: Additional help topics to be
392
 
            cross-referenced.
393
 
        """
394
 
        if not self.module.__doc__:
395
 
            result = "Plugin '%s' has no docstring.\n" % self.module.__name__
396
 
        else:
397
 
            result = self.module.__doc__
398
 
        if result[-1] != '\n':
399
 
            result += '\n'
400
 
        # there is code duplicated here and in bzrlib/help_topic.py's 
401
 
        # matching Topic code. This should probably be factored in
402
 
        # to a helper function and a common base class.
403
 
        if additional_see_also is not None:
404
 
            see_also = sorted(set(additional_see_also))
405
 
        else:
406
 
            see_also = None
407
 
        if see_also:
408
 
            result += 'See also: '
409
 
            result += ', '.join(see_also)
410
 
            result += '\n'
411
 
        return result
412
 
 
413
 
    def get_help_topic(self):
414
 
        """Return the modules help topic - its __name__ after bzrlib.plugins.."""
415
 
        return self.module.__name__[len('bzrlib.plugins.'):]
416
 
 
417
 
 
418
 
class PlugIn(object):
419
 
    """The bzrlib representation of a plugin.
420
 
 
421
 
    The PlugIn object provides a way to manipulate a given plugin module.
422
 
    """
423
 
 
424
 
    def __init__(self, name, module):
425
 
        """Construct a plugin for module."""
426
 
        self.name = name
427
 
        self.module = module
428
 
 
429
 
    def path(self):
430
 
        """Get the path that this plugin was loaded from."""
431
 
        if getattr(self.module, '__path__', None) is not None:
432
 
            return os.path.abspath(self.module.__path__[0])
433
 
        elif getattr(self.module, '__file__', None) is not None:
434
 
            path = os.path.abspath(self.module.__file__)
435
 
            if path[-4:] in ('.pyc', '.pyo'):
436
 
                pypath = path[:-4] + '.py'
437
 
                if os.path.isfile(pypath):
438
 
                    path = pypath
439
 
            return path
440
 
        else:
441
 
            return repr(self.module)
442
 
 
443
 
    def __str__(self):
444
 
        return "<%s.%s object at %s, name=%s, module=%s>" % (
445
 
            self.__class__.__module__, self.__class__.__name__, id(self),
446
 
            self.name, self.module)
447
 
 
448
 
    __repr__ = __str__
449
 
 
450
 
    def test_suite(self):
451
 
        """Return the plugin's test suite."""
452
 
        if getattr(self.module, 'test_suite', None) is not None:
453
 
            return self.module.test_suite()
454
 
        else:
455
 
            return None
456
 
 
457
 
    def load_plugin_tests(self, loader):
458
 
        """Return the adapted plugin's test suite.
459
 
 
460
 
        :param loader: The custom loader that should be used to load additional
461
 
            tests.
462
 
 
463
 
        """
464
 
        if getattr(self.module, 'load_tests', None) is not None:
465
 
            return loader.loadTestsFromModule(self.module)
466
 
        else:
467
 
            return None
468
 
 
469
 
    def version_info(self):
470
 
        """Return the plugin's version_tuple or None if unknown."""
471
 
        version_info = getattr(self.module, 'version_info', None)
472
 
        if version_info is not None:
 
105
 
 
106
        plugin_names = list(plugin_names)
 
107
        plugin_names.sort()
 
108
        for name in plugin_names:
473
109
            try:
474
 
                if isinstance(version_info, types.StringType):
475
 
                    version_info = version_info.split('.')
476
 
                elif len(version_info) == 3:
477
 
                    version_info = tuple(version_info) + ('final', 0)
478
 
            except TypeError, e:
479
 
                # The given version_info isn't even iteratible
480
 
                trace.log_exception_quietly()
481
 
                version_info = (version_info,)
482
 
        return version_info
483
 
 
484
 
    def _get__version__(self):
485
 
        version_info = self.version_info()
486
 
        if version_info is None or len(version_info) == 0:
487
 
            return "unknown"
488
 
        try:
489
 
            version_string = _format_version_tuple(version_info)
490
 
        except (ValueError, TypeError, IndexError), e:
491
 
            trace.log_exception_quietly()
492
 
            # try to return something usefull for bad plugins, in stead of
493
 
            # stack tracing.
494
 
            version_string = '.'.join(map(str, version_info))
495
 
        return version_string
496
 
 
497
 
    __version__ = property(_get__version__)
 
110
                plugin_info = imp.find_module(name, [d])
 
111
                mutter('load plugin %r' % (plugin_info,))
 
112
                try:
 
113
                    plugin = imp.load_module('bzrlib.plugin.' + name,
 
114
                                             *plugin_info)
 
115
                    all_plugins.append(plugin)
 
116
                finally:
 
117
                    if plugin_info[0] is not None:
 
118
                        plugin_info[0].close()
 
119
 
 
120
                mutter('loaded succesfully')
 
121
            except:
 
122
                log_error('Unable to load plugin %r from %r' % (name, d))
 
123
                log_exception()
 
124