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
17
"""Breezy plugin support.
19
Which plugins to load can be configured by setting these environment variables:
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.
25
The interfaces this module exports include:
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.
31
- plugin_name: Gives unprefixed name of a plugin module.
18
"""bzr python plugin support.
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.
33
25
See the plugin-api developer documentation for information about writing
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
37
from __future__ import absolute_import
46
from .lazy_import import lazy_import
36
from bzrlib import osutils
38
from bzrlib.lazy_import import lazy_import
47
40
lazy_import(globals(), """
49
from importlib import util as importlib_util
46
_format_version_tuple,
52
from bzrlib import plugins as _mod_plugins
61
_MODULE_PREFIX = "breezy.plugins."
63
if __debug__ or sys.version_info > (3,):
69
def disable_plugins(state=None):
55
from bzrlib.symbol_versioning import (
61
DEFAULT_PLUGIN_PATH = None
63
_plugins_disabled = False
66
def are_plugins_disabled():
67
return _plugins_disabled
70
def disable_plugins():
70
71
"""Disable loading plugins.
72
73
Future calls to load_plugins() will be ignored.
74
:param state: The library state object that records loaded plugins.
77
state = breezy.get_global_state()
81
def load_plugins(path=None, state=None):
82
"""Load breezy plugins.
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,
75
global _plugins_disabled
76
_plugins_disabled = True
80
def _strip_trailing_sep(path):
81
return path.rstrip("\\/")
84
def set_plugins_path(path=None):
85
"""Set the path for plugins to be loaded from.
89
87
:param path: The list of paths to search for plugins. By default,
90
it is populated from the __path__ of the breezy.plugins package.
91
:param state: The library state object that records loaded plugins.
88
path will be determined using get_standard_plugins_path.
89
if path is [], no plugins can be loaded.
94
state = breezy.get_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
100
# Calls back into extend_path() here
101
from breezy.plugins import __path__ as path
103
state.plugin_warnings = {}
104
_load_plugins(state, path)
105
state.plugins = plugins()
108
def plugin_name(module_name):
109
"""Gives unprefixed name from module_name or None."""
110
if module_name.startswith(_MODULE_PREFIX):
111
parts = module_name.split(".")
117
def extend_path(path, name):
118
"""Helper so breezy.plugins can be a sort of namespace package.
120
To be used in similar fashion to pkgutil.extend_path:
122
from breezy.plugins import extend_path
123
__path__ = extend_path(__path__, __name__)
125
Inspects the BRZ_PLUGIN* envvars, sys.path, and the filesystem to find
126
plugins. May mutate sys.modules in order to block plugin loading, and may
127
append a new meta path finder to sys.meta_path for plugins@ loading.
129
Returns a list of paths to import from, as an enhanced object that also
130
contains details of the other configuration used.
132
blocks = _env_disable_plugins()
133
_block_plugins(blocks)
135
extra_details = _env_plugins_at()
136
_install_importer_if_needed(extra_details)
138
paths = _iter_plugin_paths(_env_plugin_path(), path)
140
return _Path(name, blocks, extra_details, paths)
144
"""List type to use as __path__ but containing additional details.
146
Python 3 allows any iterable for __path__ but Python 2 is more fussy.
149
def __init__(self, package_name, blocked, extra, paths):
150
super(_Path, self).__init__(paths)
151
self.package_name = package_name
152
self.blocked_names = blocked
153
self.extra_details = extra
156
return "%s(%r, %r, %r, %s)" % (
157
self.__class__.__name__, self.package_name, self.blocked_names,
158
self.extra_details, list.__repr__(self))
161
def _expect_identifier(name, env_key, env_value):
162
"""Validate given name from envvar is usable as a Python identifier.
164
Returns the name as a native str, or None if it was invalid.
166
Per PEP 3131 this is no longer strictly correct for Python 3, but as MvL
167
didn't include a neat way to check except eval, this enforces ascii.
169
if re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", name) is None:
170
trace.warning("Invalid name '%s' in %s='%s'", name, env_key, env_value)
175
def _env_disable_plugins(key='BRZ_DISABLE_PLUGINS'):
176
"""Gives list of names for plugins to disable from environ key."""
178
env = osutils.path_from_environ(key)
180
for name in env.split(os.pathsep):
181
name = _expect_identifier(name, key, env)
183
disabled_names.append(name)
184
return disabled_names
187
def _env_plugins_at(key='BRZ_PLUGINS_AT'):
188
"""Gives list of names and paths of specific plugins from environ key."""
190
env = osutils.path_from_environ(key)
192
for pair in env.split(os.pathsep):
194
name, path = pair.split('@', 1)
197
name = osutils.basename(path).split('.', 1)[0]
198
name = _expect_identifier(name, key, env)
200
plugin_details.append((name, path))
201
return plugin_details
204
def _env_plugin_path(key='BRZ_PLUGIN_PATH'):
205
"""Gives list of paths and contexts for plugins from environ key.
207
Each entry is either a specific path to load plugins from and the value
208
'path', or None and one of the three values 'user', 'core', 'site'.
211
env = osutils.path_from_environ(key)
212
defaults = {"user": not env, "core": True, "site": True}
214
# Add paths specified by user in order
215
for p in env.split(os.pathsep):
216
flag, name = p[:1], p[1:]
217
if flag in ("+", "-") and name in defaults:
218
if flag == "+" and defaults[name] is not None:
219
path_details.append((None, name))
220
defaults[name] = None
222
path_details.append((p, 'path'))
224
# Add any remaining default paths
225
for name in ('user', 'core', 'site'):
227
path_details.append((None, name))
232
def _iter_plugin_paths(paths_from_env, core_paths):
233
"""Generate paths using paths_from_env and core_paths."""
234
# GZ 2017-06-02: This is kinda horrid, should make better.
235
for path, context in paths_from_env:
236
if context == 'path':
238
elif context == 'user':
239
path = get_user_plugin_path()
240
if os.path.isdir(path):
242
elif context == 'core':
243
for path in _get_core_plugin_paths(core_paths):
245
elif context == 'site':
246
for path in _get_site_plugin_paths(sys.path):
247
if os.path.isdir(path):
251
def _install_importer_if_needed(plugin_details):
252
"""Install a meta path finder to handle plugin_details if any."""
254
finder = _PluginsAtFinder(_MODULE_PREFIX, plugin_details)
255
# For Python 3, must insert before default PathFinder to override.
256
sys.meta_path.insert(2, finder)
259
def _load_plugins(state, paths):
260
"""Do the importing all plugins from paths."""
261
imported_names = set()
262
for name, path in _iter_possible_plugins(paths):
263
if name not in imported_names:
264
msg = _load_plugin_module(name, path)
266
state.plugin_warnings.setdefault(name, []).append(msg)
267
imported_names.add(name)
270
def _block_plugins(names):
271
"""Add names to sys.modules to block future imports."""
273
package_name = _MODULE_PREFIX + name
274
if sys.modules.get(package_name) is not None:
275
trace.mutter("Blocked plugin %s already loaded.", name)
276
sys.modules[package_name] = None
279
def _get_package_init(package_path):
280
"""Get path of __init__ file from package_path or None if not a package."""
281
init_path = osutils.pathjoin(package_path, "__init__.py")
282
if os.path.exists(init_path):
284
init_path = init_path[:-3] + COMPILED_EXT
285
if os.path.exists(init_path):
290
def _iter_possible_plugins(plugin_paths):
291
"""Generate names and paths of possible plugins from plugin_paths."""
292
# Inspect any from BRZ_PLUGINS_AT first.
293
for name, path in getattr(plugin_paths, "extra_details", ()):
295
# Then walk over files and directories in the paths from the package.
296
for path in plugin_paths:
297
if os.path.isfile(path):
298
if path.endswith(".zip"):
299
trace.mutter("Don't yet support loading plugins from zip.")
301
for name, path in _walk_modules(path):
305
def _walk_modules(path):
306
"""Generate name and path of modules and packages on path."""
307
for root, dirs, files in os.walk(path):
311
if f.endswith((".py", COMPILED_EXT)):
312
yield f.rsplit(".", 1)[0], root
316
package_dir = osutils.pathjoin(root, d)
317
fullpath = _get_package_init(package_dir)
318
if fullpath is not None:
320
# Don't descend into subdirectories
324
def describe_plugins(show_paths=False, state=None):
325
"""Generate text description of plugins.
327
Includes both those that have loaded, and those that failed to load.
329
:param show_paths: If true, include the plugin path.
330
:param state: The library state object to inspect.
331
:returns: Iterator of text lines (including newlines.)
334
state = breezy.get_global_state()
335
loaded_plugins = getattr(state, 'plugins', {})
336
plugin_warnings = set(getattr(state, 'plugin_warnings', []))
337
all_names = sorted(set(loaded_plugins.keys()).union(plugin_warnings))
338
for name in all_names:
339
if name in loaded_plugins:
340
plugin = loaded_plugins[name]
341
version = plugin.__version__
342
if version == 'unknown':
344
yield '%s %s\n' % (name, version)
345
d = plugin.module.__doc__
347
doc = d.split('\n')[0]
349
doc = '(no description)'
350
yield (" %s\n" % doc)
352
yield (" %s\n" % plugin.path())
354
yield "%s (failed to load)\n" % name
355
if name in state.plugin_warnings:
356
for line in state.plugin_warnings[name]:
357
yield " ** " + line + '\n'
361
def _get_core_plugin_paths(existing_paths):
362
"""Generate possible locations for plugins based on existing_paths."""
363
if getattr(sys, 'frozen', False):
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
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)
117
def get_core_plugin_path():
119
bzr_exe = bool(getattr(sys, 'frozen', None))
120
if bzr_exe: # expand path for bzr.exe
364
121
# We need to use relative path to system-wide plugin
365
# directory because breezy from standalone brz.exe
122
# directory because bzrlib from standalone bzr.exe
366
123
# could be imported by another standalone program
367
# (e.g. brz-config; or TortoiseBzr/Olive if/when they
124
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
368
125
# will become standalone exe). [bialix 20071123]
369
126
# __file__ typically is
370
# C:\Program Files\Bazaar\lib\library.zip\breezy\plugin.pyc
127
# C:\Program Files\Bazaar\lib\library.zip\bzrlib\plugin.pyc
371
128
# then plugins directory is
372
129
# C:\Program Files\Bazaar\plugins
373
130
# so relative path is ../../../plugins
374
yield osutils.abspath(osutils.pathjoin(
375
osutils.dirname(__file__), '../../../plugins'))
131
core_path = osutils.abspath(osutils.pathjoin(
132
osutils.dirname(__file__), '../../../plugins'))
376
133
else: # don't look inside library.zip
377
for path in existing_paths:
381
def _get_site_plugin_paths(sys_paths):
382
"""Generate possible locations for plugins from given sys_paths."""
383
for path in sys_paths:
384
if os.path.basename(path) in ('dist-packages', 'site-packages'):
385
yield osutils.pathjoin(path, 'breezy', 'plugins')
134
# search the plugin path before the bzrlib installed dir
135
core_path = os.path.dirname(_mod_plugins.__file__)
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
147
from distutils.sysconfig import get_python_lib
149
# If distutuils is not available, we just don't know where they are
152
site_path = osutils.pathjoin(get_python_lib(), 'bzrlib', 'plugins')
388
156
def get_user_plugin_path():
389
157
return osutils.pathjoin(config.config_dir(), 'plugins')
392
def record_plugin_warning(warning_message):
393
trace.mutter(warning_message)
394
return warning_message
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.
174
env_paths = os.environ.get('BZR_PLUGIN_PATH', '+user').split(os.pathsep)
175
defaults = ['+core', '+site']
177
# The predefined references
178
refs = dict(core=get_core_plugin_path(),
179
site=get_site_plugin_path(),
180
user=get_user_plugin_path())
182
# Unset paths that should be removed
183
for k,v in refs.iteritems():
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)
193
for p in env_paths + defaults:
194
if p.startswith('+'):
195
# Resolve references if they are known
199
# Leave them untouched so user can still use paths starting
202
_append_new_path(paths, p)
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)
210
def load_plugins(path=None):
211
"""Load bzrlib plugins.
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,
218
load_from_path() provides the underlying mechanism and is called with
219
the default directory list to provide the normal behaviour.
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.
227
# People can make sure plugins are loaded, they just won't be twice
231
# scan for all plugins in the path.
232
load_from_path(set_plugins_path(path))
235
def load_from_path(dirs):
236
"""Load bzrlib plugins found in each dir in dirs.
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.)
242
Plugins are loaded into bzrlib.plugins.NAME, and can be found there
243
for future reference.
245
The python module path for bzrlib.plugins will be modified to be 'dirs'.
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)
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)
261
trace.mutter('looking for plugins in %s', d)
266
# backwards compatability: load_from_dirs was the old name
267
# This was changed in 0.15
268
load_from_dirs = load_from_path
271
def _find_plugin_module(dir, name):
272
"""Check if there is a valid python module that can be loaded as a plugin.
274
:param dir: The directory where the search is performed.
275
:param path: An existing file path, either a python file or a package
278
:return: (name, path, description) name is the module name, path is the
279
file to load and description is the tuple returned by
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)
290
init_path = osutils.pathjoin(path, '__init__' + suffix)
291
if os.path.isfile(init_path):
292
return name, init_path, (suffix, mode, kind)
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)
397
305
def _load_plugin_module(name, dir):
398
"""Load plugin by name.
306
"""Load plugin name from dir.
400
:param name: The plugin name in the breezy.plugins namespace.
308
:param name: The plugin name in the bzrlib.plugins namespace.
401
309
:param dir: The directory the plugin is loaded from for error messages.
403
if _MODULE_PREFIX + name in sys.modules:
311
if ('bzrlib.plugins.%s' % name) in PluginImporter.blacklist:
406
__import__(_MODULE_PREFIX + name)
407
except errors.IncompatibleVersion as e:
409
"Unable to load plugin %r. It supports %s "
410
"versions %r but the current version is %s" %
411
(name, e.api.__name__, e.wanted, e.current))
412
return record_plugin_warning(warning_message)
413
except Exception as e:
314
exec "import bzrlib.plugins.%s" % name in {}
315
except KeyboardInterrupt:
317
except errors.IncompatibleAPI, e:
318
trace.warning("Unable to load plugin %r. It requested API version "
319
"%s of module %s but the minimum exported version is %s, and "
320
"the maximum is %s" %
321
(name, e.wanted, e.api, e.minimum, e.current))
323
trace.warning("%s" % e)
324
if re.search('\.|-| ', name):
325
sanitised_name = re.sub('[-. ]', '_', name)
326
if sanitised_name.startswith('bzr_'):
327
sanitised_name = sanitised_name[len('bzr_'):]
328
trace.warning("Unable to load %r in %r as a plugin because the "
329
"file path isn't a valid module name; try renaming "
330
"it to %r." % (name, dir, sanitised_name))
332
trace.warning('Unable to load plugin %r from %r' % (name, dir))
414
333
trace.log_exception_quietly()
415
334
if 'error' in debug.debug_flags:
416
335
trace.print_exception(sys.exc_info(), sys.stderr)
417
# GZ 2017-06-02: Move this name checking up a level, no point trying
418
# to import things with bad names.
419
if re.search('\\.|-| ', name):
420
sanitised_name = re.sub('[-. ]', '_', name)
421
if sanitised_name.startswith('brz_'):
422
sanitised_name = sanitised_name[len('brz_'):]
423
trace.warning("Unable to load %r in %r as a plugin because the "
424
"file path isn't a valid module name; try renaming "
425
"it to %r." % (name, dir, sanitised_name))
427
return record_plugin_warning(
428
'Unable to load plugin %r from %r: %s' % (name, dir, e))
338
def load_from_dir(d):
339
"""Load the plugins in directory d.
341
d must be in the plugins module path already.
342
This function is called once for each directory in the module path.
345
for p in os.listdir(d):
346
name, path, desc = _find_plugin_module(d, p)
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
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
358
trace.mutter('Plugin name %s already loaded', name)
360
plugin_names.add(name)
362
for name in plugin_names:
363
_load_plugin_module(name, d)
added
removed
bzrlib/plugin.py
