← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

add a clean target

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.
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
 
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
 
43
26
import os
44
 
import sys
45
 
import types
46
 
 
47
 
import bzrlib
48
 
from bzrlib.config import config_dir
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
 
 
 
27
from bzrlib.osutils import config_dir
 
28
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
 
29
 
 
30
all_plugins = []
57
31
_loaded = False
58
32
 
59
33
 
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
 
 
80
34
def load_plugins():
81
 
    """Load bzrlib 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.
82
44
 
83
45
    The environment variable BZR_PLUGIN_PATH is considered a delimited
84
46
    set of paths to look through. Each entry is searched for *.py
85
47
    files (and whatever other extensions are used in the platform,
86
48
    such as *.pyd).
 
49
    """
87
50
 
88
 
    load_from_dirs() provides the underlying mechanism and is called with
89
 
    the default directory list to provide the normal behaviour.
90
 
    """
91
 
    global _loaded
 
51
    global all_plugins, _loaded
92
52
    if _loaded:
93
53
        # People can make sure plugins are loaded, they just won't be twice
94
54
        return
95
55
        #raise BzrError("plugins already initialized")
96
56
    _loaded = True
97
57
 
98
 
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
 
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(":")
99
65
    dirs.insert(0, os.path.dirname(plugins.__file__))
100
66
 
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
 
    """
114
67
    # The problem with imp.get_suffixes() is that it doesn't include
115
68
    # .pyo which is technically valid
116
69
    # It also means that "testmodule.so" will show up as both test and testmodule
120
73
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
121
74
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
122
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)
123
79
        if not d:
124
80
            continue
125
 
        mutter('looking for plugins in %s', d)
126
81
        plugin_names = set()
127
82
        if not os.path.isdir(d):
128
83
            continue
129
84
        for f in os.listdir(d):
130
 
            path = pathjoin(d, f)
 
85
            path = os.path.join(d, f)
131
86
            if os.path.isdir(path):
132
87
                for entry in package_entries:
133
88
                    # This directory should be a package, and thus added to
134
89
                    # the list
135
 
                    if os.path.isfile(pathjoin(path, entry)):
 
90
                    if os.path.isfile(os.path.join(path, entry)):
136
91
                        break
137
92
                else: # This directory is not a package
138
93
                    continue
145
100
                        break
146
101
                else:
147
102
                    continue
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)
 
103
            mutter('add plugin name %s' % f)
 
104
            plugin_names.add(f)
153
105
 
154
106
        plugin_names = list(plugin_names)
155
107
        plugin_names.sort()
156
108
        for name in plugin_names:
157
109
            try:
158
110
                plugin_info = imp.find_module(name, [d])
159
 
                mutter('load plugin %r', plugin_info)
 
111
                mutter('load plugin %r' % (plugin_info,))
160
112
                try:
161
 
                    plugin = imp.load_module('bzrlib.plugins.' + name,
 
113
                    plugin = imp.load_module('bzrlib.plugin.' + name,
162
114
                                             *plugin_info)
163
 
                    setattr(bzrlib.plugins, name, plugin)
 
115
                    all_plugins.append(plugin)
164
116
                finally:
165
117
                    if plugin_info[0] is not None:
166
118
                        plugin_info[0].close()
167
119
 
168
120
                mutter('loaded succesfully')
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()
 
121
            except:
 
122
                log_error('Unable to load plugin %r from %r' % (name, d))
 
123
                log_exception()
 
124