/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: John Arbash Meinel
  • Date: 2008-11-25 17:15:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3851.
  • Revision ID: john@arbash-meinel.com-20081125171526-pi2g4m1w70pkie1f
Add a bit of help text when supplying --help.

Show diffs side-by-side

added added

removed removed

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