← 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-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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
27
 
from bzrlib.osutils import config_dir
 
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
 
28
54
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
29
55
 
30
 
all_plugins = []
31
56
_loaded = False
32
57
 
33
58
 
 
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
 
34
68
def load_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.
 
69
    """Load bzrlib plugins.
44
70
 
45
71
    The environment variable BZR_PLUGIN_PATH is considered a delimited
46
72
    set of paths to look through. Each entry is searched for *.py
47
73
    files (and whatever other extensions are used in the platform,
48
74
    such as *.pyd).
 
75
 
 
76
    load_from_dirs() provides the underlying mechanism and is called with
 
77
    the default directory list to provide the normal behaviour.
49
78
    """
50
 
 
51
 
    global all_plugins, _loaded
 
79
    global _loaded
52
80
    if _loaded:
53
81
        # People can make sure plugins are loaded, they just won't be twice
54
82
        return
55
83
        #raise BzrError("plugins already initialized")
56
84
    _loaded = True
57
85
 
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(":")
 
86
    dirs = os.environ.get('BZR_PLUGIN_PATH', DEFAULT_PLUGIN_PATH).split(os.pathsep)
65
87
    dirs.insert(0, os.path.dirname(plugins.__file__))
66
88
 
 
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
    """
67
102
    # The problem with imp.get_suffixes() is that it doesn't include
68
103
    # .pyo which is technically valid
69
104
    # It also means that "testmodule.so" will show up as both test and testmodule
73
108
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
74
109
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
75
110
    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)
79
111
        if not d:
80
112
            continue
 
113
        mutter('looking for plugins in %s', d)
81
114
        plugin_names = set()
82
115
        if not os.path.isdir(d):
83
116
            continue
100
133
                        break
101
134
                else:
102
135
                    continue
103
 
            mutter('add plugin name %s' % f)
104
 
            plugin_names.add(f)
 
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)
105
141
 
106
142
        plugin_names = list(plugin_names)
107
143
        plugin_names.sort()
108
144
        for name in plugin_names:
109
145
            try:
110
146
                plugin_info = imp.find_module(name, [d])
111
 
                mutter('load plugin %r' % (plugin_info,))
 
147
                mutter('load plugin %r', plugin_info)
112
148
                try:
113
 
                    plugin = imp.load_module('bzrlib.plugin.' + name,
 
149
                    plugin = imp.load_module('bzrlib.plugins.' + name,
114
150
                                             *plugin_info)
115
 
                    all_plugins.append(plugin)
 
151
                    setattr(bzrlib.plugins, name, plugin)
116
152
                finally:
117
153
                    if plugin_info[0] is not None:
118
154
                        plugin_info[0].close()
119
155
 
120
156
                mutter('loaded succesfully')
121
 
            except:
122
 
                log_error('Unable to load plugin %r from %r' % (name, d))
123
 
                log_exception()
124
 
 
 
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()