← 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-12-20 16:16:34 UTC
  • mfrom: (3123.5.18 hardlinks)
  • Revision ID: pqm@pqm.ubuntu.com-20071220161634-2kcjb650o21ydko4
Accelerate build_tree using similar workingtrees (abentley)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
41
41
 
42
42
from bzrlib import (
43
43
    config,
44
 
    debug,
45
44
    osutils,
46
 
    trace,
47
45
    )
48
46
from bzrlib import plugins as _mod_plugins
49
47
""")
50
48
 
51
 
from bzrlib.symbol_versioning import deprecated_function, one_three
 
49
from bzrlib.symbol_versioning import deprecated_function, zero_ninetyone
52
50
from bzrlib.trace import mutter, warning, log_exception_quietly
53
51
 
54
52
 
59
57
    """Get the DEFAULT_PLUGIN_PATH"""
60
58
    global DEFAULT_PLUGIN_PATH
61
59
    if DEFAULT_PLUGIN_PATH is None:
62
 
        DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
 
60
        path = [osutils.pathjoin(config.config_dir(), 'plugins')]
 
61
        if getattr(sys, 'frozen', None):    # bzr.exe
 
62
            # We need to use relative path to system-wide plugin
 
63
            # directory because bzrlib from standalone bzr.exe
 
64
            # could be imported by another standalone program
 
65
            # (e.g. bzr-config; or TortoiseBzr/Olive if/when they
 
66
            # will become standalone exe). [bialix 20071123]
 
67
            # __file__ typically is
 
68
            # C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
 
69
            # then plugins directory is
 
70
            # C:\Program Files\Bazaar\plugins
 
71
            # so relative path is ../../../plugins
 
72
            path.append(osutils.abspath(osutils.pathjoin(
 
73
                osutils.dirname(__file__), '../../../plugins')))
 
74
        DEFAULT_PLUGIN_PATH = os.pathsep.join(path)
63
75
    return DEFAULT_PLUGIN_PATH
64
76
 
65
77
 
 
78
@deprecated_function(zero_ninetyone)
 
79
def all_plugins():
 
80
    """Return a dictionary of the plugins."""
 
81
    return dict((name, plugin.module) for name, plugin in plugins().items())
 
82
 
 
83
 
66
84
def disable_plugins():
67
85
    """Disable loading plugins.
68
86
 
82
100
    """Set the path for plugins to be loaded from."""
83
101
    path = os.environ.get('BZR_PLUGIN_PATH',
84
102
                          get_default_plugin_path()).split(os.pathsep)
85
 
    bzr_exe = bool(getattr(sys, 'frozen', None))
86
 
    if bzr_exe:    # expand path for bzr.exe
87
 
        # We need to use relative path to system-wide plugin
88
 
        # directory because bzrlib from standalone bzr.exe
89
 
        # could be imported by another standalone program
90
 
        # (e.g. bzr-config; or TortoiseBzr/Olive if/when they
91
 
        # will become standalone exe). [bialix 20071123]
92
 
        # __file__ typically is
93
 
        # C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
94
 
        # then plugins directory is
95
 
        # C:\Program Files\Bazaar\plugins
96
 
        # so relative path is ../../../plugins
97
 
        path.append(osutils.abspath(osutils.pathjoin(
98
 
            osutils.dirname(__file__), '../../../plugins')))
99
103
    # Get rid of trailing slashes, since Python can't handle them when
100
104
    # it tries to import modules.
101
105
    path = map(_strip_trailing_sep, path)
102
 
    if not bzr_exe:     # don't look inside library.zip
103
 
        # search the plugin path before the bzrlib installed dir
104
 
        path.append(os.path.dirname(_mod_plugins.__file__))
105
 
    # search the arch independent path if we can determine that and
106
 
    # the plugin is found nowhere else
107
 
    if sys.platform != 'win32':
108
 
        try:
109
 
            from distutils.sysconfig import get_python_lib
110
 
        except ImportError:
111
 
            # If distutuils is not available, we just won't add that path
112
 
            pass
113
 
        else:
114
 
            archless_path = osutils.pathjoin(get_python_lib(), 'bzrlib',
115
 
                    'plugins')
116
 
            if archless_path not in path:
117
 
                path.append(archless_path)
 
106
    # search the plugin path before the bzrlib installed dir
 
107
    path.append(os.path.dirname(_mod_plugins.__file__))
118
108
    _mod_plugins.__path__ = path
119
109
    return path
120
110
 
164
154
        mutter('looking for plugins in %s', d)
165
155
        if os.path.isdir(d):
166
156
            load_from_dir(d)
 
157
        else:
 
158
            # it might be a zip: try loading from the zip.
 
159
            load_from_zip(d)
167
160
 
168
161
 
169
162
# backwards compatability: load_from_dirs was the old name
214
207
            ## import pdb; pdb.set_trace()
215
208
            if re.search('\.|-| ', name):
216
209
                sanitised_name = re.sub('[-. ]', '_', name)
217
 
                if sanitised_name.startswith('bzr_'):
218
 
                    sanitised_name = sanitised_name[len('bzr_'):]
219
 
                warning("Unable to load %r in %r as a plugin because the "
220
 
                        "file path isn't a valid module name; try renaming "
221
 
                        "it to %r." % (name, d, sanitised_name))
 
210
                warning("Unable to load %r in %r as a plugin because file path"
 
211
                        " isn't a valid module name; try renaming it to %r."
 
212
                        % (name, d, sanitised_name))
222
213
            else:
223
214
                warning('Unable to load plugin %r from %r' % (name, d))
224
215
            log_exception_quietly()
225
 
            if 'error' in debug.debug_flags:
226
 
                trace.print_exception(sys.exc_info(), sys.stderr)
227
 
 
228
 
 
229
 
@deprecated_function(one_three)
 
216
 
 
217
 
230
218
def load_from_zip(zip_name):
231
219
    """Load all the plugins in a zip."""
232
220
    valid_suffixes = ('.py', '.pyc', '.pyo')    # only python modules/packages
233
221
                                                # is allowed
 
222
 
234
223
    try:
235
224
        index = zip_name.rindex('.zip')
236
225
    except ValueError:
303
292
            warning('Unable to load plugin %r from %r'
304
293
                    % (name, zip_name))
305
294
            log_exception_quietly()
306
 
            if 'error' in debug.debug_flags:
307
 
                trace.print_exception(sys.exc_info(), sys.stderr)
308
295
 
309
296
 
310
297
def plugins():
403
390
        if getattr(self.module, '__path__', None) is not None:
404
391
            return os.path.abspath(self.module.__path__[0])
405
392
        elif getattr(self.module, '__file__', None) is not None:
406
 
            path = os.path.abspath(self.module.__file__)
407
 
            if path[-4:] in ('.pyc', '.pyo'):
408
 
                pypath = path[:-4] + '.py'
409
 
                if os.path.isfile(pypath):
410
 
                    path = pypath
411
 
            return path
 
393
            return os.path.abspath(self.module.__file__)
412
394
        else:
413
395
            return repr(self.module)
414
396
 
426
408
        else:
427
409
            return None
428
410
 
429
 
    def load_plugin_tests(self, loader):
430
 
        """Return the adapted plugin's test suite.
431
 
 
432
 
        :param loader: The custom loader that should be used to load additional
433
 
            tests.
434
 
 
435
 
        """
436
 
        if getattr(self.module, 'load_tests', None) is not None:
437
 
            return loader.loadTestsFromModule(self.module)
438
 
        else:
439
 
            return None
440
 
 
441
411
    def version_info(self):
442
412
        """Return the plugin's version_tuple or None if unknown."""
443
413
        version_info = getattr(self.module, 'version_info', None)
444
414
        if version_info is not None and len(version_info) == 3:
445
415
            version_info = tuple(version_info) + ('final', 0)
446
416
        return version_info
447
 
 
 
417
    
448
418
    def _get__version__(self):
449
419
        version_info = self.version_info()
450
420
        if version_info is None: