← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

Late bind to PatienceSequenceMatcher to allow plugin to override.

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
 
# 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
 
 
25
 
 
 
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.
 
25
"""
 
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
 
 
42
import imp
26
43
import os
 
44
import sys
 
45
import types
 
46
 
27
47
import bzrlib
28
48
from bzrlib.config import config_dir
29
 
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
30
 
 
31
 
all_plugins = []
 
49
from bzrlib.trace import log_error, mutter, log_exception, warning, \
 
50
        log_exception_quietly
 
51
from bzrlib.errors import BzrError
 
52
from bzrlib import plugins
 
53
from bzrlib.osutils import pathjoin
 
54
 
 
55
DEFAULT_PLUGIN_PATH = pathjoin(config_dir(), 'plugins')
 
56
 
32
57
_loaded = False
33
58
 
34
59
 
 
60
def all_plugins():
 
61
    """Return a dictionary of the plugins."""
 
62
    result = {}
 
63
    for name, plugin in bzrlib.plugins.__dict__.items():
 
64
        if isinstance(plugin, types.ModuleType):
 
65
            result[name] = plugin
 
66
    return result
 
67
 
 
68
 
 
69
def disable_plugins():
 
70
    """Disable loading plugins.
 
71
 
 
72
    Future calls to load_plugins() will be ignored.
 
73
    """
 
74
    # TODO: jam 20060131 This should probably also disable
 
75
    #       load_from_dirs()
 
76
    global _loaded
 
77
    _loaded = True
 
78
 
 
79
 
35
80
def load_plugins():
36
 
    """
37
 
    Find all python plugins and load them.
38
 
 
39
 
    Loading a plugin means importing it into the python interpreter.
40
 
    The plugin is expected to make calls to register commands when
41
 
    it's loaded (or perhaps access other hooks in future.)
42
 
 
43
 
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
44
 
    reference.
 
81
    """Load bzrlib plugins.
45
82
 
46
83
    The environment variable BZR_PLUGIN_PATH is considered a delimited
47
84
    set of paths to look through. Each entry is searched for *.py
48
85
    files (and whatever other extensions are used in the platform,
49
86
    such as *.pyd).
 
87
 
 
88
    load_from_dirs() provides the underlying mechanism and is called with
 
89
    the default directory list to provide the normal behaviour.
50
90
    """
51
 
 
52
 
    global all_plugins, _loaded
 
91
    global _loaded
53
92
    if _loaded:
54
93
        # People can make sure plugins are loaded, they just won't be twice
55
94
        return
56
95
        #raise BzrError("plugins already initialized")
57
96
    _loaded = True
58
97
 
59
 
    import sys, os, imp
60
 
    
61
 
    from bzrlib.trace import log_error, mutter, log_exception
62
 
    from bzrlib.errors import BzrError
63
 
    from bzrlib import plugins
64
 
 
65
 
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(":")
 
98
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
66
99
    dirs.insert(0, os.path.dirname(plugins.__file__))
67
100
 
 
101
    load_from_dirs(dirs)
 
102
 
 
103
 
 
104
def load_from_dirs(dirs):
 
105
    """Load bzrlib plugins found in each dir in dirs.
 
106
 
 
107
    Loading a plugin means importing it into the python interpreter.
 
108
    The plugin is expected to make calls to register commands when
 
109
    it's loaded (or perhaps access other hooks in future.)
 
110
 
 
111
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
 
112
    for future reference.
 
113
    """
68
114
    # The problem with imp.get_suffixes() is that it doesn't include
69
115
    # .pyo which is technically valid
70
116
    # It also means that "testmodule.so" will show up as both test and testmodule
74
120
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
75
121
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
76
122
    for d in dirs:
77
 
        # going through them one by one allows different plugins with the same
78
 
        # filename in different directories in the path
79
 
        mutter('looking for plugins in %s' % d)
80
123
        if not d:
81
124
            continue
 
125
        mutter('looking for plugins in %s', d)
82
126
        plugin_names = set()
83
127
        if not os.path.isdir(d):
84
128
            continue
85
129
        for f in os.listdir(d):
86
 
            path = os.path.join(d, f)
 
130
            path = pathjoin(d, f)
87
131
            if os.path.isdir(path):
88
132
                for entry in package_entries:
89
133
                    # This directory should be a package, and thus added to
90
134
                    # the list
91
 
                    if os.path.isfile(os.path.join(path, entry)):
 
135
                    if os.path.isfile(pathjoin(path, entry)):
92
136
                        break
93
137
                else: # This directory is not a package
94
138
                    continue
101
145
                        break
102
146
                else:
103
147
                    continue
104
 
            mutter('add plugin name %s' % f)
105
 
            plugin_names.add(f)
 
148
            if getattr(bzrlib.plugins, f, None):
 
149
                mutter('Plugin name %s already loaded', f)
 
150
            else:
 
151
                mutter('add plugin name %s', f)
 
152
                plugin_names.add(f)
106
153
 
107
154
        plugin_names = list(plugin_names)
108
155
        plugin_names.sort()
109
156
        for name in plugin_names:
110
157
            try:
111
158
                plugin_info = imp.find_module(name, [d])
112
 
                mutter('load plugin %r' % (plugin_info,))
 
159
                mutter('load plugin %r', plugin_info)
113
160
                try:
114
161
                    plugin = imp.load_module('bzrlib.plugins.' + name,
115
162
                                             *plugin_info)
116
 
                    all_plugins.append(plugin)
117
163
                    setattr(bzrlib.plugins, name, plugin)
118
164
                finally:
119
165
                    if plugin_info[0] is not None:
120
166
                        plugin_info[0].close()
121
167
 
122
168
                mutter('loaded succesfully')
123
 
            except:
124
 
                log_error('Unable to load plugin %r from %r' % (name, d))
125
 
                log_exception()
126
 
 
 
169
            except KeyboardInterrupt:
 
170
                raise
 
171
            except Exception, e:
 
172
                ## import pdb; pdb.set_trace()
 
173
                warning('Unable to load plugin %r from %r' % (name, d))
 
174
                log_exception_quietly()