/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/plugin.py

  • Committer: Martin
  • Date: 2017-06-02 23:43:00 UTC
  • mto: This revision was merged to the branch mainline in revision 6655.
  • Revision ID: gzlist@googlemail.com-20170602234300-oqgj53wmd8svckh1
Rewrite of the plugin module for Python 3 compat and general sanity

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd, 2017 Breezy developers
2
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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
18
 
"""bzr python plugin support.
19
 
 
20
 
When load_plugins() is invoked, any python module in any directory in
21
 
$BZR_PLUGIN_PATH will be imported.  The module will be imported as
22
 
'bzrlib.plugins.$BASENAME(PLUGIN)'.  In the plugin's main body, it should
23
 
update any bzrlib registries it wants to extend.
 
17
"""Breezy plugin support.
 
18
 
 
19
Which plugins to load can be configured by setting these environment variables:
 
20
 
 
21
- BRZ_PLUGIN_PATH: Paths to look for plugins in.
 
22
- BRZ_DISABLE_PLUGINS: Plugin names to block from being loaded.
 
23
- BRZ_PLUGINS_AT: Name and paths for plugins to load from specific locations.
 
24
 
 
25
The interfaces this module exports include:
 
26
 
 
27
- disable_plugins: Load no plugins and stop future automatic loading.
 
28
- load_plugins: Load all plugins that can be found in configuration.
 
29
- describe_plugins: Generate text for each loaded (or failed) plugin.
 
30
- extend_path: Mechanism by which the plugins package path is set.
24
31
 
25
32
See the plugin-api developer documentation for information about writing
26
33
plugins.
27
 
 
28
 
BZR_PLUGIN_PATH is also honoured for any plugins imported via
29
 
'import bzrlib.plugins.PLUGINNAME', as long as set_plugins_path has been
30
 
called.
31
34
"""
32
35
 
 
36
from __future__ import absolute_import
 
37
 
33
38
import os
 
39
import re
34
40
import sys
35
41
 
36
 
from bzrlib import osutils
37
 
 
38
 
from bzrlib.lazy_import import lazy_import
39
 
 
 
42
import breezy
 
43
from . import osutils
 
44
 
 
45
from .lazy_import import lazy_import
40
46
lazy_import(globals(), """
41
47
import imp
42
 
import re
43
 
import types
 
48
import importlib
 
49
from importlib import util as importlib_util
44
50
 
45
 
from bzrlib import (
46
 
    _format_version_tuple,
 
51
from breezy import (
47
52
    config,
48
53
    debug,
49
54
    errors,
 
55
    help_topics,
50
56
    trace,
51
57
    )
52
 
from bzrlib import plugins as _mod_plugins
53
58
""")
54
59
 
55
 
from bzrlib.symbol_versioning import (
56
 
    deprecated_function,
57
 
    deprecated_in,
58
 
    )
59
 
 
60
 
 
61
 
DEFAULT_PLUGIN_PATH = None
62
 
_loaded = False
63
 
_plugins_disabled = False
64
 
 
65
 
 
66
 
def are_plugins_disabled():
67
 
    return _plugins_disabled
68
 
 
69
 
 
70
 
def disable_plugins():
 
60
 
 
61
_MODULE_PREFIX = "breezy.plugins."
 
62
 
 
63
if __debug__ or sys.version_info > (3,):
 
64
    COMPILED_EXT = ".pyc"
 
65
else:
 
66
    COMPILED_EXT = ".pyo"
 
67
 
 
68
 
 
69
def disable_plugins(state=None):
71
70
    """Disable loading plugins.
72
71
 
73
72
    Future calls to load_plugins() will be ignored.
 
73
 
 
74
    :param state: The library state object that records loaded plugins.
74
75
    """
75
 
    global _plugins_disabled
76
 
    _plugins_disabled = True
77
 
    load_plugins([])
78
 
 
79
 
 
80
 
def _strip_trailing_sep(path):
81
 
    return path.rstrip("\\/")
82
 
 
83
 
 
84
 
def set_plugins_path(path=None):
85
 
    """Set the path for plugins to be loaded from.
 
76
    if state is None:
 
77
        state = breezy.global_state
 
78
    state.plugins = {}
 
79
 
 
80
 
 
81
def load_plugins(path=None, state=None):
 
82
    """Load breezy plugins.
 
83
 
 
84
    The environment variable BRZ_PLUGIN_PATH is considered a delimited
 
85
    set of paths to look through. Each entry is searched for `*.py`
 
86
    files (and whatever other extensions are used in the platform,
 
87
    such as `*.pyd`).
86
88
 
87
89
    :param path: The list of paths to search for plugins.  By default,
88
 
        path will be determined using get_standard_plugins_path.
89
 
        if path is [], no plugins can be loaded.
 
90
        it is populated from the __path__ of the breezy.plugins package.
 
91
    :param state: The library state object that records loaded plugins.
90
92
    """
 
93
    if state is None:
 
94
        state = breezy.global_state
 
95
    if getattr(state, 'plugins', None) is not None:
 
96
        # People can make sure plugins are loaded, they just won't be twice
 
97
        return
 
98
 
91
99
    if path is None:
92
 
        path = get_standard_plugins_path()
93
 
    _mod_plugins.__path__ = path
94
 
    PluginImporter.reset()
95
 
    # Set up a blacklist for disabled plugins
96
 
    disabled_plugins = os.environ.get('BZR_DISABLE_PLUGINS', None)
97
 
    if disabled_plugins is not None:
98
 
        for name in disabled_plugins.split(os.pathsep):
99
 
            PluginImporter.blacklist.add('bzrlib.plugins.' + name)
100
 
    # Set up a the specific paths for plugins
101
 
    specific_plugins = os.environ.get('BZR_PLUGINS_AT', None)
102
 
    if specific_plugins is not None:
103
 
        for spec in specific_plugins.split(os.pathsep):
104
 
            plugin_name, plugin_path = spec.split('@')
105
 
            PluginImporter.specific_paths[
106
 
                'bzrlib.plugins.%s' % plugin_name] = plugin_path
107
 
    return path
108
 
 
109
 
 
110
 
def _append_new_path(paths, new_path):
111
 
    """Append a new path if it set and not already known."""
112
 
    if new_path is not None and new_path not in paths:
113
 
        paths.append(new_path)
114
 
    return paths
115
 
 
116
 
 
117
 
def get_core_plugin_path():
118
 
    core_path = None
119
 
    bzr_exe = bool(getattr(sys, 'frozen', None))
120
 
    if bzr_exe:    # expand path for bzr.exe
 
100
        # Calls back into extend_path() here
 
101
        from breezy.plugins import __path__ as path
 
102
 
 
103
    state.plugin_warnings = {}
 
104
    _load_plugins(state, path)
 
105
    state.plugins = plugins()
 
106
 
 
107
 
 
108
def extend_path(path, name):
 
109
    """Helper so breezy.plugins can be a sort of namespace package.
 
110
 
 
111
    To be used in similar fashion to pkgutil.extend_path:
 
112
 
 
113
        from breezy.plugins import extend_path
 
114
        __path__ = extend_path(__path__, __name__)
 
115
 
 
116
    Inspects the BRZ_PLUGIN* envvars, sys.path, and the filesystem to find
 
117
    plugins. May mutate sys.modules in order to block plugin loading, and may
 
118
    append a new meta path finder to sys.meta_path for plugins@ loading.
 
119
 
 
120
    Returns a list of paths to import from, as an enhanced object that also
 
121
    contains details of the other configuration used.
 
122
    """
 
123
    blocks = _env_disable_plugins()
 
124
    _block_plugins(blocks)
 
125
 
 
126
    extra_details = _env_plugins_at()
 
127
    _install_importer_if_needed(extra_details)
 
128
 
 
129
    paths = _iter_plugin_paths(_env_plugin_path(), path)
 
130
 
 
131
    return _Path(name, blocks, extra_details, paths)
 
132
 
 
133
 
 
134
class _Path(list):
 
135
    """List type to use as __path__ but containing additional details.
 
136
 
 
137
    Python 3 allows any iterable for __path__ but Python 2 is more fussy.
 
138
    """
 
139
 
 
140
    def __init__(self, package_name, blocked, extra, paths):
 
141
        super(_Path, self).__init__(paths)
 
142
        self.package_name = package_name
 
143
        self.blocked_names = blocked
 
144
        self.extra_details = extra
 
145
 
 
146
    def __repr__(self):
 
147
        return "%s(%r, %r, %r, %s)" % (
 
148
            self.__class__.__name__, self.package_name, self.blocked_names,
 
149
            self.extra_details, list.__repr__(self))
 
150
 
 
151
 
 
152
def _expect_identifier(name, env_key, env_value):
 
153
    """Validate given name from envvar is usable as a Python identifier.
 
154
 
 
155
    Returns the name as a native str, or None if it was invalid.
 
156
 
 
157
    Per PEP 3131 this is no longer strictly correct for Python 3, but as MvL
 
158
    didn't include a neat way to check except eval, this enforces ascii.
 
159
    """
 
160
    if re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", name) is None:
 
161
        trace.warning("Invalid name '%s' in %s='%s'", name, env_key, env_value)
 
162
        return None
 
163
    return str(name)
 
164
 
 
165
 
 
166
def _env_disable_plugins(key='BRZ_DISABLE_PLUGINS'):
 
167
    """Gives list of names for plugins to disable from environ key."""
 
168
    disabled_names = []
 
169
    env = osutils.path_from_environ(key)
 
170
    if env:
 
171
        for name in env.split(os.pathsep):
 
172
            name = _expect_identifier(name, key, env)
 
173
            if name is not None:
 
174
                disabled_names.append(name)
 
175
    return disabled_names
 
176
 
 
177
 
 
178
def _env_plugins_at(key='BRZ_PLUGINS_AT'):
 
179
    """Gives list of names and paths of specific plugins from environ key."""
 
180
    plugin_details = []
 
181
    env = osutils.path_from_environ(key)
 
182
    if env:
 
183
        for pair in env.split(os.pathsep):
 
184
            if '@' in pair:
 
185
                name, path = pair.split('@', 1)
 
186
            else:
 
187
                path = pair
 
188
                name = osutils.basename(path).split('.', 1)[0]
 
189
            name = _expect_identifier(name, key, env)
 
190
            if name is not None:
 
191
                plugin_details.append((name, path))
 
192
    return plugin_details
 
193
 
 
194
 
 
195
def _env_plugin_path(key='BRZ_PLUGIN_PATH'):
 
196
    """Gives list of paths and contexts for plugins from environ key.
 
197
 
 
198
    Each entry is either a specific path to load plugins from and the value
 
199
    'path', or None and one of the three values 'user', 'core', 'site'.
 
200
    """
 
201
    path_details = []
 
202
    env = osutils.path_from_environ(key)
 
203
    defaults = {"user": not env, "core": True, "site": True}
 
204
    if env:
 
205
        # Add paths specified by user in order
 
206
        for p in env.split(os.pathsep):
 
207
            flag, name = p[:1], p[1:]
 
208
            if flag in ("+", "-") and name in defaults:
 
209
                if flag == "+" and defaults[name] is not None:
 
210
                    path_details.append((None, name))
 
211
                defaults[name] = None
 
212
            else:
 
213
                path_details.append((p, 'path'))
 
214
 
 
215
    # Add any remaining default paths
 
216
    for name in ('user', 'core', 'site'):
 
217
        if defaults[name]:
 
218
            path_details.append((None, name))
 
219
 
 
220
    return path_details
 
221
 
 
222
 
 
223
def _iter_plugin_paths(paths_from_env, core_paths):
 
224
    """Generate paths using paths_from_env and core_paths."""
 
225
    # GZ 2017-06-02: This is kinda horrid, should make better.
 
226
    for path, context in paths_from_env:
 
227
        if context == 'path':
 
228
            yield path
 
229
        elif context == 'user':
 
230
            path = get_user_plugin_path()
 
231
            if os.path.isdir(path):
 
232
                yield path
 
233
        elif context == 'core':
 
234
            for path in _get_core_plugin_paths(core_paths):
 
235
                yield path
 
236
        elif context == 'site':
 
237
            for path in _get_site_plugin_paths(sys.path):
 
238
                if os.path.isdir(path):
 
239
                    yield path
 
240
 
 
241
 
 
242
def _install_importer_if_needed(plugin_details):
 
243
    """Install a meta path finder to handle plugin_details if any."""
 
244
    if plugin_details:
 
245
        finder = _PluginsAtFinder(_MODULE_PREFIX, plugin_details)
 
246
        # For Python 3, must insert before default PathFinder to override.
 
247
        sys.meta_path.insert(2, finder)
 
248
 
 
249
 
 
250
def _load_plugins(state, paths):
 
251
    """Do the importing all plugins from paths."""
 
252
    imported_names = set()
 
253
    for name, path in _iter_possible_plugins(paths):
 
254
        if name not in imported_names:
 
255
            msg = _load_plugin_module(name, path)
 
256
            if msg is not None:
 
257
                state.plugin_warnings.setdefault(name, []).append(msg)
 
258
            imported_names.add(name)
 
259
 
 
260
 
 
261
def _block_plugins(names):
 
262
    """Add names to sys.modules to block future imports."""
 
263
    for name in names:
 
264
        package_name = _MODULE_PREFIX + name
 
265
        if sys.modules.get(package_name) is not None:
 
266
            trace.mutter("Blocked plugin %s already loaded.", name)
 
267
        sys.modules[package_name] = None
 
268
 
 
269
 
 
270
def _get_package_init(package_path):
 
271
    """Get path of __init__ file from package_path or None if not a package."""
 
272
    init_path = osutils.pathjoin(package_path, "__init__.py")
 
273
    if os.path.exists(init_path):
 
274
        return init_path
 
275
    init_path = init_path[:-3] + COMPILED_EXT
 
276
    if os.path.exists(init_path):
 
277
        return init_path
 
278
    return None
 
279
 
 
280
 
 
281
def _iter_possible_plugins(plugin_paths):
 
282
    """Generate names and paths of possible plugins from plugin_paths."""
 
283
    # Inspect any from BRZ_PLUGINS_AT first.
 
284
    for name, path in getattr(plugin_paths, "extra_details", ()):
 
285
        yield name, path
 
286
    # Then walk over files and directories in the paths from the package.
 
287
    for path in plugin_paths:
 
288
        if os.path.isfile(path):
 
289
            if path.endswith(".zip"):
 
290
                trace.mutter("Don't yet support loading plugins from zip.")
 
291
        else:
 
292
            for name, path in _walk_modules(path):
 
293
                yield name, path
 
294
 
 
295
 
 
296
def _walk_modules(path):
 
297
    """Generate name and path of modules and packages on path."""
 
298
    for root, dirs, files in os.walk(path):
 
299
        files.sort()
 
300
        for f in files:
 
301
            if f[:2] != "__":
 
302
                if f.endswith((".py", COMPILED_EXT)):
 
303
                    yield f.rsplit(".", 1)[0], root
 
304
        dirs.sort()
 
305
        for d in dirs:
 
306
            if d[:2] != "__":
 
307
                package_dir = osutils.pathjoin(root, d)
 
308
                fullpath = _get_package_init(package_dir)
 
309
                if fullpath is not None:
 
310
                    yield d, package_dir
 
311
        # Don't descend into subdirectories
 
312
        del dirs[:]
 
313
 
 
314
 
 
315
def describe_plugins(show_paths=False, state=None):
 
316
    """Generate text description of plugins.
 
317
 
 
318
    Includes both those that have loaded, and those that failed to load.
 
319
 
 
320
    :param show_paths: If true, include the plugin path.
 
321
    :param state: The library state object to inspect.
 
322
    :returns: Iterator of text lines (including newlines.)
 
323
    """
 
324
    if state is None:
 
325
        state = breezy.global_state
 
326
    all_names = sorted(set(state.plugins).union(state.plugin_warnings))
 
327
    for name in all_names:
 
328
        if name in state.plugins:
 
329
            plugin = state.plugins[name]
 
330
            version = plugin.__version__
 
331
            if version == 'unknown':
 
332
                version = ''
 
333
            yield '%s %s\n' % (name, version)
 
334
            d = plugin.module.__doc__
 
335
            if d:
 
336
                doc = d.split('\n')[0]
 
337
            else:
 
338
                doc = '(no description)'
 
339
            yield ("  %s\n" % doc)
 
340
            if show_paths:
 
341
                yield ("   %s\n" % plugin.path())
 
342
        else:
 
343
            yield "%s (failed to load)\n" % name
 
344
        if name in state.plugin_warnings:
 
345
            for line in state.plugin_warnings[name]:
 
346
                yield "  ** " + line + '\n'
 
347
        yield '\n'
 
348
 
 
349
 
 
350
def _get_core_plugin_paths(existing_paths):
 
351
    """Generate possible locations for plugins based on existing_paths."""
 
352
    if getattr(sys, 'frozen', False):
121
353
        # We need to use relative path to system-wide plugin
122
 
        # directory because bzrlib from standalone bzr.exe
 
354
        # directory because breezy from standalone brz.exe
123
355
        # could be imported by another standalone program
124
356
        # (e.g. bzr-config; or TortoiseBzr/Olive if/when they
125
357
        # will become standalone exe). [bialix 20071123]
126
358
        # __file__ typically is
127
 
        # C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
 
359
        # C:\Program Files\Bazaar\lib\library.zip\breezy\plugin.pyc
128
360
        # then plugins directory is
129
361
        # C:\Program Files\Bazaar\plugins
130
362
        # so relative path is ../../../plugins
131
 
        core_path = osutils.abspath(osutils.pathjoin(
132
 
                osutils.dirname(__file__), '../../../plugins'))
 
363
        yield osutils.abspath(osutils.pathjoin(
 
364
            osutils.dirname(__file__), '../../../plugins'))
133
365
    else:     # don't look inside library.zip
134
 
        # search the plugin path before the bzrlib installed dir
135
 
        core_path = os.path.dirname(_mod_plugins.__file__)
136
 
    return core_path
137
 
 
138
 
 
139
 
def get_site_plugin_path():
140
 
    """Returns the path for the site installed plugins."""
141
 
    if sys.platform == 'win32':
142
 
        # We don't have (yet) a good answer for windows since that is certainly
143
 
        # related to the way we build the installers. -- vila20090821
144
 
        return None
145
 
    site_path = None
146
 
    try:
147
 
        from distutils.sysconfig import get_python_lib
148
 
    except ImportError:
149
 
        # If distutuils is not available, we just don't know where they are
150
 
        pass
151
 
    else:
152
 
        site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
153
 
    return site_path
 
366
        for path in existing_paths:
 
367
            yield path
 
368
 
 
369
 
 
370
def _get_site_plugin_paths(sys_paths):
 
371
    """Generate possible locations for plugins from given sys_paths."""
 
372
    for path in sys_paths:
 
373
        if os.path.basename(path) in ('dist-packages', 'site-packages'):
 
374
            yield osutils.pathjoin(path, 'breezy', 'plugins')
154
375
 
155
376
 
156
377
def get_user_plugin_path():
157
378
    return osutils.pathjoin(config.config_dir(), 'plugins')
158
379
 
159
380
 
160
 
def get_standard_plugins_path():
161
 
    """Determine a plugin path suitable for general use."""
162
 
    # Ad-Hoc default: core is not overriden by site but user can overrides both
163
 
    # The rationale is that:
164
 
    # - 'site' comes last, because these plugins should always be available and
165
 
    #   are supposed to be in sync with the bzr installed on site.
166
 
    # - 'core' comes before 'site' so that running bzr from sources or a user
167
 
    #   installed version overrides the site version.
168
 
    # - 'user' comes first, because... user is always right.
169
 
    # - the above rules clearly defines which plugin version will be loaded if
170
 
    #   several exist. Yet, it is sometimes desirable to disable some directory
171
 
    #   so that a set of plugins is disabled as once. This can be done via
172
 
    #   -site, -core, -user.
173
 
 
174
 
    env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
175
 
    defaults = ['+core', '+site']
176
 
 
177
 
    # The predefined references
178
 
    refs = dict(core=get_core_plugin_path(),
179
 
                site=get_site_plugin_path(),
180
 
                user=get_user_plugin_path())
181
 
 
182
 
    # Unset paths that should be removed
183
 
    for k,v in refs.iteritems():
184
 
        removed = '-%s' % k
185
 
        # defaults can never mention removing paths as that will make it
186
 
        # impossible for the user to revoke these removals.
187
 
        if removed in env_paths:
188
 
            env_paths.remove(removed)
189
 
            refs[k] = None
190
 
 
191
 
    # Expand references
192
 
    paths = []
193
 
    for p in env_paths + defaults:
194
 
        if p.startswith('+'):
195
 
            # Resolve references if they are known
196
 
            try:
197
 
                p = refs[p[1:]]
198
 
            except KeyError:
199
 
                # Leave them untouched so user can still use paths starting
200
 
                # with '+'
201
 
                pass
202
 
        _append_new_path(paths, p)
203
 
 
204
 
    # Get rid of trailing slashes, since Python can't handle them when
205
 
    # it tries to import modules.
206
 
    paths = map(_strip_trailing_sep, paths)
207
 
    return paths
208
 
 
209
 
 
210
 
def load_plugins(path=None):
211
 
    """Load bzrlib plugins.
212
 
 
213
 
    The environment variable BZR_PLUGIN_PATH is considered a delimited
214
 
    set of paths to look through. Each entry is searched for *.py
215
 
    files (and whatever other extensions are used in the platform,
216
 
    such as *.pyd).
217
 
 
218
 
    load_from_path() provides the underlying mechanism and is called with
219
 
    the default directory list to provide the normal behaviour.
220
 
 
221
 
    :param path: The list of paths to search for plugins.  By default,
222
 
        path will be determined using get_standard_plugins_path.
223
 
        if path is [], no plugins can be loaded.
224
 
    """
225
 
    global _loaded
226
 
    if _loaded:
227
 
        # People can make sure plugins are loaded, they just won't be twice
228
 
        return
229
 
    _loaded = True
230
 
 
231
 
    # scan for all plugins in the path.
232
 
    load_from_path(set_plugins_path(path))
233
 
 
234
 
 
235
 
def load_from_path(dirs):
236
 
    """Load bzrlib plugins found in each dir in dirs.
237
 
 
238
 
    Loading a plugin means importing it into the python interpreter.
239
 
    The plugin is expected to make calls to register commands when
240
 
    it's loaded (or perhaps access other hooks in future.)
241
 
 
242
 
    Plugins are loaded into bzrlib.plugins.NAME, and can be found there
243
 
    for future reference.
244
 
 
245
 
    The python module path for bzrlib.plugins will be modified to be 'dirs'.
246
 
    """
247
 
    # Explicitly load the plugins with a specific path
248
 
    for fullname, path in PluginImporter.specific_paths.iteritems():
249
 
        name = fullname[len('bzrlib.plugins.'):]
250
 
        _load_plugin_module(name, path)
251
 
 
252
 
    # We need to strip the trailing separators here as well as in the
253
 
    # set_plugins_path function because calling code can pass anything in to
254
 
    # this function, and since it sets plugins.__path__, it should set it to
255
 
    # something that will be valid for Python to use (in case people try to
256
 
    # run "import bzrlib.plugins.PLUGINNAME" after calling this function).
257
 
    _mod_plugins.__path__ = map(_strip_trailing_sep, dirs)
258
 
    for d in dirs:
259
 
        if not d:
260
 
            continue
261
 
        trace.mutter('looking for plugins in %s', d)
262
 
        if os.path.isdir(d):
263
 
            load_from_dir(d)
264
 
 
265
 
 
266
 
# backwards compatability: load_from_dirs was the old name
267
 
# This was changed in 0.15
268
 
load_from_dirs = load_from_path
269
 
 
270
 
 
271
 
def _find_plugin_module(dir, name):
272
 
    """Check if there is a valid python module that can be loaded as a plugin.
273
 
 
274
 
    :param dir: The directory where the search is performed.
275
 
    :param path: An existing file path, either a python file or a package
276
 
        directory.
277
 
 
278
 
    :return: (name, path, description) name is the module name, path is the
279
 
        file to load and description is the tuple returned by
280
 
        imp.get_suffixes().
281
 
    """
282
 
    path = osutils.pathjoin(dir, name)
283
 
    if os.path.isdir(path):
284
 
        # Check for a valid __init__.py file, valid suffixes depends on -O and
285
 
        # can be .py, .pyc and .pyo
286
 
        for suffix, mode, kind in imp.get_suffixes():
287
 
            if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
288
 
                # We don't recognize compiled modules (.so, .dll, etc)
289
 
                continue
290
 
            init_path = osutils.pathjoin(path, '__init__' + suffix)
291
 
            if os.path.isfile(init_path):
292
 
                return name, init_path, (suffix, mode, kind)
293
 
    else:
294
 
        for suffix, mode, kind in imp.get_suffixes():
295
 
            if name.endswith(suffix):
296
 
                # Clean up the module name
297
 
                name = name[:-len(suffix)]
298
 
                if kind == imp.C_EXTENSION and name.endswith('module'):
299
 
                    name = name[:-len('module')]
300
 
                return name, path, (suffix, mode, kind)
301
 
    # There is no python module here
302
 
    return None, None, (None, None, None)
 
381
def record_plugin_warning(warning_message):
 
382
    trace.mutter(warning_message)
 
383
    return warning_message
303
384
 
304
385
 
305
386
def _load_plugin_module(name, dir):
306
 
    """Load plugin name from dir.
 
387
    """Load plugin by name.
307
388
 
308
 
    :param name: The plugin name in the bzrlib.plugins namespace.
 
389
    :param name: The plugin name in the breezy.plugins namespace.
309
390
    :param dir: The directory the plugin is loaded from for error messages.
310
391
    """
311
 
    if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
 
392
    if _MODULE_PREFIX + name in sys.modules:
312
393
        return
313
394
    try:
314
 
        exec "import bzrlib.plugins.%s" % name in {}
315
 
    except KeyboardInterrupt:
316
 
        raise
317
 
    except errors.IncompatibleAPI, e:
318
 
        trace.warning("Unable to load plugin %r. It requested API version "
 
395
        __import__(_MODULE_PREFIX + name)
 
396
    except errors.IncompatibleAPI as e:
 
397
        warning_message = (
 
398
            "Unable to load plugin %r. It requested API version "
319
399
            "%s of module %s but the minimum exported version is %s, and "
320
400
            "the maximum is %s" %
321
401
            (name, e.wanted, e.api, e.minimum, e.current))
322
 
    except Exception, e:
323
 
        trace.warning("%s" % e)
 
402
        return record_plugin_warning(warning_message)
 
403
    except Exception as e:
 
404
        trace.log_exception_quietly()
 
405
        if 'error' in debug.debug_flags:
 
406
            trace.print_exception(sys.exc_info(), sys.stderr)
 
407
        # GZ 2017-06-02: Move this name checking up a level, no point trying
 
408
        # to import things with bad names.
324
409
        if re.search('\.|-| ', name):
325
410
            sanitised_name = re.sub('[-. ]', '_', name)
326
 
            if sanitised_name.startswith('bzr_'):
327
 
                sanitised_name = sanitised_name[len('bzr_'):]
 
411
            if sanitised_name.startswith('brz_'):
 
412
                sanitised_name = sanitised_name[len('brz_'):]
328
413
            trace.warning("Unable to load %r in %r as a plugin because the "
329
414
                    "file path isn't a valid module name; try renaming "
330
415
                    "it to %r." % (name, dir, sanitised_name))
331
416
        else:
332
 
            trace.warning('Unable to load plugin %r from %r' % (name, dir))
333
 
        trace.log_exception_quietly()
334
 
        if 'error' in debug.debug_flags:
335
 
            trace.print_exception(sys.exc_info(), sys.stderr)
336
 
 
337
 
 
338
 
def load_from_dir(d):
339
 
    """Load the plugins in directory d.
340
 
 
341
 
    d must be in the plugins module path already.
342
 
    This function is called once for each directory in the module path.
343
 
    """
344
 
    plugin_names = set()
345
 
    for p in os.listdir(d):
346
 
        name, path, desc = _find_plugin_module(d, p)
347
 
        if name is not None:
348
 
            if name == '__init__':
349
 
                # We do nothing with the __init__.py file in directories from
350
 
                # the bzrlib.plugins module path, we may want to, one day
351
 
                # -- vila 20100316.
352
 
                continue # We don't load __init__.py in the plugins dirs
353
 
            elif getattr(_mod_plugins, name, None) is not None:
354
 
                # The module has already been loaded from another directory
355
 
                # during a previous call.
356
 
                # FIXME: There should be a better way to report masked plugins
357
 
                # -- vila 20100316
358
 
                trace.mutter('Plugin name %s already loaded', name)
359
 
            else:
360
 
                plugin_names.add(name)
361
 
 
362
 
    for name in plugin_names:
363
 
        _load_plugin_module(name, d)
 
417
            return record_plugin_warning(
 
418
                'Unable to load plugin %r from %r: %s' % (name, dir, e))
364
419
 
365
420
 
366
421
def plugins():
369
424
    Each item in the dictionary is a PlugIn object.
370
425
    """
371
426
    result = {}
372
 
    for name, plugin in _mod_plugins.__dict__.items():
373
 
        if isinstance(plugin, types.ModuleType):
374
 
            result[name] = PlugIn(name, plugin)
 
427
    for fullname in sys.modules:
 
428
        if fullname.startswith(_MODULE_PREFIX):
 
429
            name = fullname[len(_MODULE_PREFIX):]
 
430
            if not "." in name and sys.modules[fullname] is not None:
 
431
                result[name] = PlugIn(name, sys.modules[fullname])
375
432
    return result
376
433
 
377
434
 
 
435
def format_concise_plugin_list():
 
436
    """Return a string holding a concise list of plugins and their version.
 
437
    """
 
438
    items = []
 
439
    for name, a_plugin in sorted(plugins().items()):
 
440
        items.append("%s[%s]" %
 
441
            (name, a_plugin.__version__))
 
442
    return ', '.join(items)
 
443
 
 
444
 
378
445
class PluginsHelpIndex(object):
379
446
    """A help index that returns help topics for plugins."""
380
447
 
394
461
            return []
395
462
        if topic.startswith(self.prefix):
396
463
            topic = topic[len(self.prefix):]
397
 
        plugin_module_name = 'bzrlib.plugins.%s' % topic
 
464
        plugin_module_name = _MODULE_PREFIX + topic
398
465
        try:
399
466
            module = sys.modules[plugin_module_name]
400
467
        except KeyError:
425
492
            result = self.module.__doc__
426
493
        if result[-1] != '\n':
427
494
            result += '\n'
428
 
        # there is code duplicated here and in bzrlib/help_topic.py's
429
 
        # matching Topic code. This should probably be factored in
430
 
        # to a helper function and a common base class.
431
 
        if additional_see_also is not None:
432
 
            see_also = sorted(set(additional_see_also))
433
 
        else:
434
 
            see_also = None
435
 
        if see_also:
436
 
            result += 'See also: '
437
 
            result += ', '.join(see_also)
438
 
            result += '\n'
 
495
        result += help_topics._format_see_also(additional_see_also)
439
496
        return result
440
497
 
441
498
    def get_help_topic(self):
442
 
        """Return the modules help topic - its __name__ after bzrlib.plugins.."""
443
 
        return self.module.__name__[len('bzrlib.plugins.'):]
 
499
        """Return the module help topic: its basename."""
 
500
        return self.module.__name__[len(_MODULE_PREFIX):]
444
501
 
445
502
 
446
503
class PlugIn(object):
447
 
    """The bzrlib representation of a plugin.
 
504
    """The breezy representation of a plugin.
448
505
 
449
506
    The PlugIn object provides a way to manipulate a given plugin module.
450
507
    """
460
517
            return os.path.abspath(self.module.__path__[0])
461
518
        elif getattr(self.module, '__file__', None) is not None:
462
519
            path = os.path.abspath(self.module.__file__)
463
 
            if path[-4:] in ('.pyc', '.pyo'):
 
520
            if path[-4:] == COMPILED_EXT:
464
521
                pypath = path[:-4] + '.py'
465
522
                if os.path.isfile(pypath):
466
523
                    path = pypath
468
525
        else:
469
526
            return repr(self.module)
470
527
 
471
 
    def __str__(self):
472
 
        return "<%s.%s object at %s, name=%s, module=%s>" % (
473
 
            self.__class__.__module__, self.__class__.__name__, id(self),
 
528
    def __repr__(self):
 
529
        return "<%s.%s name=%s, module=%s>" % (
 
530
            self.__class__.__module__, self.__class__.__name__,
474
531
            self.name, self.module)
475
532
 
476
 
    __repr__ = __str__
477
 
 
478
533
    def test_suite(self):
479
534
        """Return the plugin's test suite."""
480
535
        if getattr(self.module, 'test_suite', None) is not None:
487
542
 
488
543
        :param loader: The custom loader that should be used to load additional
489
544
            tests.
490
 
 
491
545
        """
492
546
        if getattr(self.module, 'load_tests', None) is not None:
493
547
            return loader.loadTestsFromModule(self.module)
499
553
        version_info = getattr(self.module, 'version_info', None)
500
554
        if version_info is not None:
501
555
            try:
502
 
                if isinstance(version_info, types.StringType):
 
556
                if isinstance(version_info, str):
503
557
                    version_info = version_info.split('.')
504
558
                elif len(version_info) == 3:
505
559
                    version_info = tuple(version_info) + ('final', 0)
506
 
            except TypeError, e:
 
560
            except TypeError:
507
561
                # The given version_info isn't even iteratible
508
562
                trace.log_exception_quietly()
509
563
                version_info = (version_info,)
510
564
        return version_info
511
565
 
512
 
    def _get__version__(self):
 
566
    @property
 
567
    def __version__(self):
513
568
        version_info = self.version_info()
514
569
        if version_info is None or len(version_info) == 0:
515
570
            return "unknown"
516
571
        try:
517
 
            version_string = _format_version_tuple(version_info)
518
 
        except (ValueError, TypeError, IndexError), e:
 
572
            version_string = breezy._format_version_tuple(version_info)
 
573
        except (ValueError, TypeError, IndexError):
519
574
            trace.log_exception_quietly()
520
 
            # try to return something usefull for bad plugins, in stead of
521
 
            # stack tracing.
 
575
            # Try to show something for the version anyway
522
576
            version_string = '.'.join(map(str, version_info))
523
577
        return version_string
524
578
 
525
 
    __version__ = property(_get__version__)
526
 
 
527
 
 
528
 
class _PluginImporter(object):
529
 
    """An importer tailored to bzr specific needs.
530
 
 
531
 
    This is a singleton that takes care of:
532
 
    - disabled plugins specified in 'blacklist',
533
 
    - plugins that needs to be loaded from specific directories.
534
 
    """
535
 
 
536
 
    def __init__(self):
537
 
        self.reset()
538
 
 
539
 
    def reset(self):
540
 
        self.blacklist = set()
541
 
        self.specific_paths = {}
542
 
 
543
 
    def find_module(self, fullname, parent_path=None):
544
 
        """Search a plugin module.
545
 
 
546
 
        Disabled plugins raise an import error, plugins with specific paths
547
 
        returns a specific loader.
548
 
 
549
 
        :return: None if the plugin doesn't need special handling, self
550
 
            otherwise.
551
 
        """
552
 
        if not fullname.startswith('bzrlib.plugins.'):
553
 
            return None
554
 
        if fullname in self.blacklist:
555
 
            raise ImportError('%s is disabled' % fullname)
556
 
        if fullname in self.specific_paths:
557
 
            return self
558
 
        return None
 
579
 
 
580
class _PluginsAtFinder(object):
 
581
    """Meta path finder to support BRZ_PLUGINS_AT configuration."""
 
582
 
 
583
    def __init__(self, prefix, names_and_paths):
 
584
        self.prefix = prefix
 
585
        self.names_to_path = dict((prefix + n, p) for n, p in names_and_paths)
 
586
 
 
587
    def __repr__(self):
 
588
        return "<%s %r>" % (self.__class__.__name__, self.prefix)
 
589
 
 
590
    def find_spec(self, fullname, paths, target=None):
 
591
        """New module spec returning find method."""
 
592
        if fullname not in self.names_to_path:
 
593
            return None
 
594
        path = self.names_to_path[fullname]
 
595
        if os.path.isdir(path):
 
596
            path = _get_package_init(path)
 
597
            if path is None:
 
598
                # GZ 2017-06-02: Any reason to block loading of the name from
 
599
                # further down the path like this?
 
600
                raise ImportError("Not loading namespace package %s as %s" % (
 
601
                    path, fullname))
 
602
        return importlib_util.spec_from_file_location(fullname, path)
 
603
 
 
604
    def find_module(self, fullname, path):
 
605
        """Old PEP 302 import hook find_module method."""
 
606
        if fullname not in self.names_to_path:
 
607
            return None
 
608
        return _LegacyLoader(self.names_to_path[fullname])
 
609
 
 
610
 
 
611
class _LegacyLoader(object):
 
612
    """Source loader implementation for Python versions without importlib."""
 
613
 
 
614
    def __init__(self, filepath):
 
615
        self.filepath = filepath
 
616
 
 
617
    def __repr__(self):
 
618
        return "<%s %r>" % (self.__class__.__name__, self.filepath)
559
619
 
560
620
    def load_module(self, fullname):
561
 
        """Load a plugin from a specific directory."""
562
 
        # We are called only for specific paths
563
 
        plugin_path = self.specific_paths[fullname]
 
621
        """Load a plugin from a specific directory (or file)."""
 
622
        plugin_path = self.filepath
564
623
        loading_path = None
565
 
        package = False
566
624
        if os.path.isdir(plugin_path):
567
 
            for suffix, mode, kind in imp.get_suffixes():
568
 
                if kind not in (imp.PY_SOURCE, imp.PY_COMPILED):
569
 
                    # We don't recognize compiled modules (.so, .dll, etc)
570
 
                    continue
571
 
                init_path = osutils.pathjoin(plugin_path, '__init__' + suffix)
572
 
                if os.path.isfile(init_path):
573
 
                    loading_path = init_path
574
 
                    package = True
575
 
                    break
 
625
            init_path = _get_package_init(plugin_path)
 
626
            if init_path is not None:
 
627
                loading_path = plugin_path
 
628
                suffix = ''
 
629
                mode = ''
 
630
                kind = imp.PKG_DIRECTORY
576
631
        else:
577
632
            for suffix, mode, kind in imp.get_suffixes():
578
633
                if plugin_path.endswith(suffix):
581
636
        if loading_path is None:
582
637
            raise ImportError('%s cannot be loaded from %s'
583
638
                              % (fullname, plugin_path))
584
 
        f = open(loading_path, mode)
 
639
        if kind is imp.PKG_DIRECTORY:
 
640
            f = None
 
641
        else:
 
642
            f = open(loading_path, mode)
585
643
        try:
586
644
            mod = imp.load_module(fullname, f, loading_path,
587
645
                                  (suffix, mode, kind))
588
 
            if package:
589
 
                # The plugin can contain modules, so be ready
590
 
                mod.__path__ = [plugin_path]
591
646
            mod.__package__ = fullname
592
647
            return mod
593
648
        finally:
594
 
            f.close()
595
 
 
596
 
 
597
 
# Install a dedicated importer for plugins requiring special handling
598
 
PluginImporter = _PluginImporter()
599
 
sys.meta_path.append(PluginImporter)
 
649
            if f is not None:
 
650
                f.close()