← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugin.py

  • Committer: mbp at sourcefrog
  • Date: 2006-10-31 01:15:34 UTC
  • mto: This revision was merged to the branch mainline in revision 2114.
  • Revision ID: mbp@sourcefrog.net-20061031011534-105c53a11815f47b
Truncate progress bar rather than complaining if it's too long

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugin.py
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
18
18
"""bzr python plugin support
19
19
 
20
20
Any python module in $BZR_PLUGIN_PATH will be imported upon initialization of
21
 
bzrlib (and then forgotten about).  In the plugin's main body, it should
22
 
update any bzrlib registries it wants to extend; for example, to add new
23
 
commands, import bzrlib.commands and add your new command to the plugin_cmds
24
 
variable.
 
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
25
"""
26
26
 
27
27
# TODO: Refactor this to make it more testable.  The main problem at the
39
39
# That could be either a separate Python interpreter or perhaps a new
40
40
# namespace inside this interpreter.
41
41
 
42
 
import imp
43
42
import os
44
43
import sys
45
44
 
46
 
import bzrlib
47
 
from bzrlib.config import config_dir
48
 
from bzrlib.trace import log_error, mutter, log_exception, warning, \
49
 
        log_exception_quietly
50
 
from bzrlib.errors import BzrError
51
 
from bzrlib import plugins
52
 
 
53
 
DEFAULT_PLUGIN_PATH = os.path.join(config_dir(), 'plugins')
54
 
 
55
 
all_plugins = []
 
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
 
56
71
_loaded = False
57
72
 
58
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
 
59
94
def load_plugins():
60
 
    """Find all python plugins and load them.
61
 
 
62
 
    Loading a plugin means importing it into the python interpreter.
63
 
    The plugin is expected to make calls to register commands when
64
 
    it's loaded (or perhaps access other hooks in future.)
65
 
 
66
 
    A list of plugs is stored in bzrlib.plugin.all_plugins for future
67
 
    reference.
 
95
    """Load bzrlib plugins.
68
96
 
69
97
    The environment variable BZR_PLUGIN_PATH is considered a delimited
70
98
    set of paths to look through. Each entry is searched for *.py
71
99
    files (and whatever other extensions are used in the platform,
72
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.
73
104
    """
74
 
 
75
 
    global all_plugins, _loaded
 
105
    global _loaded
76
106
    if _loaded:
77
107
        # People can make sure plugins are loaded, they just won't be twice
78
108
        return
79
 
        #raise BzrError("plugins already initialized")
80
109
    _loaded = True
81
110
 
82
 
    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)
83
113
    dirs.insert(0, os.path.dirname(plugins.__file__))
84
114
 
85
 
    # The problem with imp.get_suffixes() is that it doesn't include
86
 
    # .pyo which is technically valid
87
 
    # It also means that "testmodule.so" will show up as both test and testmodule
88
 
    # though it is only valid as 'test'
89
 
    # but you should be careful, because "testmodule.py" loads as testmodule.
90
 
    suffixes = imp.get_suffixes()
91
 
    suffixes.append(('.pyo', 'rb', imp.PY_COMPILED))
92
 
    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]
93
134
    for d in dirs:
94
 
        # going through them one by one allows different plugins with the same
95
 
        # filename in different directories in the path
96
 
        mutter('looking for plugins in %s' % d)
97
135
        if not d:
98
136
            continue
 
137
        mutter('looking for plugins in %s', d)
99
138
        plugin_names = set()
100
139
        if not os.path.isdir(d):
101
140
            continue
102
141
        for f in os.listdir(d):
103
 
            path = os.path.join(d, f)
 
142
            path = osutils.pathjoin(d, f)
104
143
            if os.path.isdir(path):
105
144
                for entry in package_entries:
106
145
                    # This directory should be a package, and thus added to
107
146
                    # the list
108
 
                    if os.path.isfile(os.path.join(path, entry)):
 
147
                    if os.path.isfile(osutils.pathjoin(path, entry)):
109
148
                        break
110
149
                else: # This directory is not a package
111
150
                    continue
112
151
            else:
113
 
                for suffix_info in suffixes:
 
152
                for suffix_info in imp.get_suffixes():
114
153
                    if f.endswith(suffix_info[0]):
115
154
                        f = f[:-len(suffix_info[0])]
116
155
                        if suffix_info[2] == imp.C_EXTENSION and f.endswith('module'):
118
157
                        break
119
158
                else:
120
159
                    continue
121
 
            mutter('add plugin name %s' % f)
122
 
            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)
123
165
 
124
166
        plugin_names = list(plugin_names)
125
167
        plugin_names.sort()
126
168
        for name in plugin_names:
127
169
            try:
128
170
                plugin_info = imp.find_module(name, [d])
129
 
                mutter('load plugin %r' % (plugin_info,))
 
171
                mutter('load plugin %r', plugin_info)
130
172
                try:
131
173
                    plugin = imp.load_module('bzrlib.plugins.' + name,
132
174
                                             *plugin_info)
133
 
                    all_plugins.append(plugin)
134
 
                    setattr(bzrlib.plugins, name, plugin)
 
175
                    setattr(plugins, name, plugin)
135
176
                finally:
136
177
                    if plugin_info[0] is not None:
137
178
                        plugin_info[0].close()
138
179
 
139
180
                mutter('loaded succesfully')
140
 
            except:
141
 
                ## import pdb
142
 
                ## pdb.set_trace()
 
181
            except KeyboardInterrupt:
 
182
                raise
 
183
            except Exception, e:
 
184
                ## import pdb; pdb.set_trace()
143
185
                warning('Unable to load plugin %r from %r' % (name, d))
144
186
                log_exception_quietly()