~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: 2006-11-21 12:34:18 UTC
  • mfrom: (1551.9.3 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20061121123418-3d0b2fb05cbe6b43
Revert buggy apport changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
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
 
 
 
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.
25
41
 
26
42
import os
27
 
from bzrlib.osutils import config_dir
28
 
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
29
 
 
30
 
all_plugins = []
 
43
import sys
 
44
 
 
45
from bzrlib.lazy_import import lazy_import
 
46
lazy_import(globals(), """
 
47
import imp
 
48
import types
 
49
 
 
50
from bzrlib import (
 
51
    config,
 
52
    osutils,
 
53
    plugins,
 
54
    )
 
55
""")
 
56
 
 
57
from bzrlib.trace import mutter, warning, log_exception_quietly
 
58
 
 
59
 
 
60
DEFAULT_PLUGIN_PATH = None
 
61
 
 
62
 
 
63
def get_default_plugin_path():
 
64
    """Get the DEFAULT_PLUGIN_PATH"""
 
65
    global DEFAULT_PLUGIN_PATH
 
66
    if DEFAULT_PLUGIN_PATH is None:
 
67
        DEFAULT_PLUGIN_PATH = osutils.pathjoin(config.config_dir(), 'plugins')
 
68
    return DEFAULT_PLUGIN_PATH
 
69
 
 
70
 
31
71
_loaded = False
32
72
 
33
73
 
 
74
def all_plugins():
 
75
    """Return a dictionary of the plugins."""
 
76
    result = {}
 
77
    for name, plugin in plugins.__dict__.items():
 
78
        if isinstance(plugin, types.ModuleType):
 
79
            result[name] = plugin
 
80
    return result
 
81
 
 
82
 
 
83
def disable_plugins():
 
84
    """Disable loading plugins.
 
85
 
 
86
    Future calls to load_plugins() will be ignored.
 
87
    """
 
88
    # TODO: jam 20060131 This should probably also disable
 
89
    #       load_from_dirs()
 
90
    global _loaded
 
91
    _loaded = True
 
92
 
 
93
 
34
94
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.
 
95
    """Load bzrlib plugins.
44
96
 
45
97
    The environment variable BZR_PLUGIN_PATH is considered a delimited
46
98
    set of paths to look through. Each entry is searched for *.py
47
99
    files (and whatever other extensions are used in the platform,
48
100
    such as *.pyd).
 
101
 
 
102
    load_from_dirs() provides the underlying mechanism and is called with
 
103
    the default directory list to provide the normal behaviour.
49
104
    """
50
 
 
51
 
    global all_plugins, _loaded
 
105
    global _loaded
52
106
    if _loaded:
53
107
        # People can make sure plugins are loaded, they just won't be twice
54
108
        return
55
 
        #raise BzrError("plugins already initialized")
56
109
    _loaded = True
57
110
 
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(":")
 
111
    dirs = os.environ.get('BZR_PLUGIN_PATH',
 
112
                          get_default_plugin_path()).split(os.pathsep)
65
113
    dirs.insert(0, os.path.dirname(plugins.__file__))
66
114
 
67
 
    # The problem with imp.get_suffixes() is that it doesn't include
68
 
    # .pyo which is technically valid
69
 
    # It also means that "testmodule.so" will show up as both test and testmodule
70
 
    # though it is only valid as 'test'
71
 
    # but you should be careful, because "testmodule.py" loads as testmodule.
72
 
    suffixes = imp.get_suffixes()
73
 
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
74
 
    package_entries = ['__init__.py', '__init__.pyc', '__init__.pyo']
 
115
    load_from_dirs(dirs)
 
116
 
 
117
 
 
118
def load_from_dirs(dirs):
 
119
    """Load bzrlib plugins found in each dir in dirs.
 
120
 
 
121
    Loading a plugin means importing it into the python interpreter.
 
122
    The plugin is expected to make calls to register commands when
 
123
    it's loaded (or perhaps access other hooks in future.)
 
124
 
 
125
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
 
126
    for future reference.
 
127
    """
 
128
    # Get the list of valid python suffixes for __init__.py?
 
129
    # this includes .py, .pyc, and .pyo (depending on if we are running -O)
 
130
    # but it doesn't include compiled modules (.so, .dll, etc)
 
131
    valid_suffixes = [suffix for suffix, mod_type, flags in imp.get_suffixes()
 
132
                              if flags in (imp.PY_SOURCE, imp.PY_COMPILED)]
 
133
    package_entries = ['__init__'+suffix for suffix in valid_suffixes]
75
134
    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
135
        if not d:
80
136
            continue
 
137
        mutter('looking for plugins in %s', d)
81
138
        plugin_names = set()
82
139
        if not os.path.isdir(d):
83
140
            continue
84
141
        for f in os.listdir(d):
85
 
            path = os.path.join(d, f)
 
142
            path = osutils.pathjoin(d, f)
86
143
            if os.path.isdir(path):
87
144
                for entry in package_entries:
88
145
                    # This directory should be a package, and thus added to
89
146
                    # the list
90
 
                    if os.path.isfile(os.path.join(path, entry)):
 
147
                    if os.path.isfile(osutils.pathjoin(path, entry)):
91
148
                        break
92
149
                else: # This directory is not a package
93
150
                    continue
94
151
            else:
95
 
                for suffix_info in suffixes:
 
152
                for suffix_info in imp.get_suffixes():
96
153
                    if f.endswith(suffix_info[0]):
97
154
                        f = f[:-len(suffix_info[0])]
98
155
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
100
157
                        break
101
158
                else:
102
159
                    continue
103
 
            mutter('add plugin name %s' % f)
104
 
            plugin_names.add(f)
 
160
            if getattr(plugins, f, None):
 
161
                mutter('Plugin name %s already loaded', f)
 
162
            else:
 
163
                mutter('add plugin name %s', f)
 
164
                plugin_names.add(f)
105
165
 
106
166
        plugin_names = list(plugin_names)
107
167
        plugin_names.sort()
108
168
        for name in plugin_names:
109
169
            try:
110
170
                plugin_info = imp.find_module(name, [d])
111
 
                mutter('load plugin %r' % (plugin_info,))
 
171
                mutter('load plugin %r', plugin_info)
112
172
                try:
113
 
                    plugin = imp.load_module('bzrlib.plugin.' + name,
 
173
                    plugin = imp.load_module('bzrlib.plugins.' + name,
114
174
                                             *plugin_info)
115
 
                    all_plugins.append(plugin)
 
175
                    setattr(plugins, name, plugin)
116
176
                finally:
117
177
                    if plugin_info[0] is not None:
118
178
                        plugin_info[0].close()
119
179
 
120
180
                mutter('loaded succesfully')
121
 
            except:
122
 
                log_error('Unable to load plugin %r from %r' % (name, d))
123
 
                log_exception()
124
 
 
 
181
            except KeyboardInterrupt:
 
182
                raise
 
183
            except Exception, e:
 
184
                ## import pdb; pdb.set_trace()
 
185
                warning('Unable to load plugin %r from %r' % (name, d))
 
186
                log_exception_quietly()