← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: Robert Collins
  • Date: 2005-10-17 11:56:54 UTC
  • mfrom: (1185.16.59)
  • Revision ID: robertc@robertcollins.net-20051017115654-662239e1587524a8
merge from martin.

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