1
# Copyright (C) 2005-2011 Canonical Ltd, 2017 Breezy developers
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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.
33
See the plugin-api developer documentation for information about writing
37
from __future__ import absolute_import
46
from .lazy_import import lazy_import
47
lazy_import(globals(), """
49
from importlib import util as importlib_util
64
_MODULE_PREFIX = "breezy.plugins."
69
def disable_plugins(state=None):
70
"""Disable loading plugins.
72
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,
89
: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.
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_from_path(state, path)
105
if (None, 'entrypoints') in _env_plugin_path():
106
_load_plugins_from_entrypoints(state)
107
state.plugins = plugins()
110
def _load_plugins_from_entrypoints(state):
114
# No pkg_resources, no entrypoints.
117
for ep in pkg_resources.iter_entry_points('breezy.plugin'):
118
fullname = _MODULE_PREFIX + ep.name
119
if fullname in sys.modules:
121
sys.modules[fullname] = ep.load()
124
def plugin_name(module_name):
125
"""Gives unprefixed name from module_name or None."""
126
if module_name.startswith(_MODULE_PREFIX):
127
parts = module_name.split(".")
133
def extend_path(path, name):
134
"""Helper so breezy.plugins can be a sort of namespace package.
136
To be used in similar fashion to pkgutil.extend_path:
138
from breezy.plugins import extend_path
139
__path__ = extend_path(__path__, __name__)
141
Inspects the BRZ_PLUGIN* envvars, sys.path, and the filesystem to find
142
plugins. May mutate sys.modules in order to block plugin loading, and may
143
append a new meta path finder to sys.meta_path for plugins@ loading.
145
Returns a list of paths to import from, as an enhanced object that also
146
contains details of the other configuration used.
148
blocks = _env_disable_plugins()
149
_block_plugins(blocks)
151
extra_details = _env_plugins_at()
152
_install_importer_if_needed(extra_details)
154
paths = _iter_plugin_paths(_env_plugin_path(), path)
156
return _Path(name, blocks, extra_details, paths)
160
"""List type to use as __path__ but containing additional details.
162
Python 3 allows any iterable for __path__ but Python 2 is more fussy.
165
def __init__(self, package_name, blocked, extra, paths):
166
super(_Path, self).__init__(paths)
167
self.package_name = package_name
168
self.blocked_names = blocked
169
self.extra_details = extra
172
return "%s(%r, %r, %r, %s)" % (
173
self.__class__.__name__, self.package_name, self.blocked_names,
174
self.extra_details, list.__repr__(self))
177
def _expect_identifier(name, env_key, env_value):
178
"""Validate given name from envvar is usable as a Python identifier.
180
Returns the name as a native str, or None if it was invalid.
182
Per PEP 3131 this is no longer strictly correct for Python 3, but as MvL
183
didn't include a neat way to check except eval, this enforces ascii.
185
if re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", name) is None:
186
trace.warning("Invalid name '%s' in %s='%s'", name, env_key, env_value)
191
def _env_disable_plugins(key='BRZ_DISABLE_PLUGINS'):
192
"""Gives list of names for plugins to disable from environ key."""
194
env = osutils.path_from_environ(key)
196
for name in env.split(os.pathsep):
197
name = _expect_identifier(name, key, env)
199
disabled_names.append(name)
200
return disabled_names
203
def _env_plugins_at(key='BRZ_PLUGINS_AT'):
204
"""Gives list of names and paths of specific plugins from environ key."""
206
env = osutils.path_from_environ(key)
208
for pair in env.split(os.pathsep):
210
name, path = pair.split('@', 1)
213
name = osutils.basename(path).split('.', 1)[0]
214
name = _expect_identifier(name, key, env)
216
plugin_details.append((name, path))
217
return plugin_details
220
def _env_plugin_path(key='BRZ_PLUGIN_PATH'):
221
"""Gives list of paths and contexts for plugins from environ key.
223
Each entry is either a specific path to load plugins from and the value
224
'path', or None and one of the values 'user', 'core', 'entrypoints', 'site'.
227
env = osutils.path_from_environ(key)
232
'entrypoints': False,
235
# Add paths specified by user in order
236
for p in env.split(os.pathsep):
237
flag, name = p[:1], p[1:]
238
if flag in ("+", "-") and name in defaults:
239
if flag == "+" and defaults[name] is not None:
240
path_details.append((None, name))
241
defaults[name] = None
243
path_details.append((p, 'path'))
245
# Add any remaining default paths
246
for name in ('user', 'core', 'entrypoints', 'site'):
248
path_details.append((None, name))
253
def _iter_plugin_paths(paths_from_env, core_paths):
254
"""Generate paths using paths_from_env and core_paths."""
255
# GZ 2017-06-02: This is kinda horrid, should make better.
256
for path, context in paths_from_env:
257
if context == 'path':
259
elif context == 'user':
260
path = get_user_plugin_path()
261
if os.path.isdir(path):
263
elif context == 'core':
264
for path in _get_core_plugin_paths(core_paths):
266
elif context == 'site':
267
for path in _get_site_plugin_paths(sys.path):
268
if os.path.isdir(path):
272
def _install_importer_if_needed(plugin_details):
273
"""Install a meta path finder to handle plugin_details if any."""
275
finder = _PluginsAtFinder(_MODULE_PREFIX, plugin_details)
276
# For Python 3, must insert before default PathFinder to override.
277
sys.meta_path.insert(2, finder)
280
def _load_plugins_from_path(state, paths):
281
"""Do the importing all plugins from paths."""
282
imported_names = set()
283
for name, path in _iter_possible_plugins(paths):
284
if name not in imported_names:
285
msg = _load_plugin_module(name, path)
287
state.plugin_warnings.setdefault(name, []).append(msg)
288
imported_names.add(name)
291
def _block_plugins(names):
292
"""Add names to sys.modules to block future imports."""
294
package_name = _MODULE_PREFIX + name
295
if sys.modules.get(package_name) is not None:
296
trace.mutter("Blocked plugin %s already loaded.", name)
297
sys.modules[package_name] = None
300
def _get_package_init(package_path):
301
"""Get path of __init__ file from package_path or None if not a package."""
302
init_path = osutils.pathjoin(package_path, "__init__.py")
303
if os.path.exists(init_path):
305
init_path = init_path[:-3] + COMPILED_EXT
306
if os.path.exists(init_path):
311
def _iter_possible_plugins(plugin_paths):
312
"""Generate names and paths of possible plugins from plugin_paths."""
313
# Inspect any from BRZ_PLUGINS_AT first.
314
for name, path in getattr(plugin_paths, "extra_details", ()):
316
# Then walk over files and directories in the paths from the package.
317
for path in plugin_paths:
318
if os.path.isfile(path):
319
if path.endswith(".zip"):
320
trace.mutter("Don't yet support loading plugins from zip.")
322
for name, path in _walk_modules(path):
326
def _walk_modules(path):
327
"""Generate name and path of modules and packages on path."""
328
for root, dirs, files in os.walk(path):
332
if f.endswith((".py", COMPILED_EXT)):
333
yield f.rsplit(".", 1)[0], root
337
package_dir = osutils.pathjoin(root, d)
338
fullpath = _get_package_init(package_dir)
339
if fullpath is not None:
341
# Don't descend into subdirectories
345
def describe_plugins(show_paths=False, state=None):
346
"""Generate text description of plugins.
348
Includes both those that have loaded, and those that failed to load.
350
:param show_paths: If true, include the plugin path.
351
:param state: The library state object to inspect.
352
:returns: Iterator of text lines (including newlines.)
355
state = breezy.get_global_state()
356
loaded_plugins = getattr(state, 'plugins', {})
357
plugin_warnings = set(getattr(state, 'plugin_warnings', []))
358
all_names = sorted(set(loaded_plugins.keys()).union(plugin_warnings))
359
for name in all_names:
360
if name in loaded_plugins:
361
plugin = loaded_plugins[name]
362
version = plugin.__version__
363
if version == 'unknown':
365
yield '%s %s\n' % (name, version)
366
d = plugin.module.__doc__
368
doc = d.split('\n')[0]
370
doc = '(no description)'
371
yield (" %s\n" % doc)
373
yield (" %s\n" % plugin.path())
375
yield "%s (failed to load)\n" % name
376
if name in state.plugin_warnings:
377
for line in state.plugin_warnings[name]:
378
yield " ** " + line + '\n'
382
def _get_core_plugin_paths(existing_paths):
383
"""Generate possible locations for plugins based on existing_paths."""
384
if getattr(sys, 'frozen', False):
385
# We need to use relative path to system-wide plugin
386
# directory because breezy from standalone brz.exe
387
# could be imported by another standalone program
388
# (e.g. brz-config; or TortoiseBzr/Olive if/when they
389
# will become standalone exe). [bialix 20071123]
390
# __file__ typically is
391
# C:\Program Files\Bazaar\lib\library.zip\breezy\plugin.pyc
392
# then plugins directory is
393
# C:\Program Files\Bazaar\plugins
394
# so relative path is ../../../plugins
395
yield osutils.abspath(osutils.pathjoin(
396
osutils.dirname(__file__), '../../../plugins'))
397
else: # don't look inside library.zip
398
for path in existing_paths:
402
def _get_site_plugin_paths(sys_paths):
403
"""Generate possible locations for plugins from given sys_paths."""
404
for path in sys_paths:
405
if os.path.basename(path) in ('dist-packages', 'site-packages'):
406
yield osutils.pathjoin(path, 'breezy', 'plugins')
409
def get_user_plugin_path():
410
return osutils.pathjoin(bedding.config_dir(), 'plugins')
413
def record_plugin_warning(warning_message):
414
trace.mutter(warning_message)
415
return warning_message
418
def _load_plugin_module(name, dir):
419
"""Load plugin by name.
421
:param name: The plugin name in the breezy.plugins namespace.
422
:param dir: The directory the plugin is loaded from for error messages.
424
if _MODULE_PREFIX + name in sys.modules:
427
__import__(_MODULE_PREFIX + name)
428
except errors.IncompatibleVersion as e:
430
"Unable to load plugin %r. It supports %s "
431
"versions %r but the current version is %s" %
432
(name, e.api.__name__, e.wanted, e.current))
433
return record_plugin_warning(warning_message)
434
except Exception as e:
435
trace.log_exception_quietly()
436
if 'error' in debug.debug_flags:
437
trace.print_exception(sys.exc_info(), sys.stderr)
438
# GZ 2017-06-02: Move this name checking up a level, no point trying
439
# to import things with bad names.
440
if re.search('\\.|-| ', name):
441
sanitised_name = re.sub('[-. ]', '_', name)
442
if sanitised_name.startswith('brz_'):
443
sanitised_name = sanitised_name[len('brz_'):]
444
trace.warning("Unable to load %r in %r as a plugin because the "
445
"file path isn't a valid module name; try renaming "
446
"it to %r." % (name, dir, sanitised_name))
448
return record_plugin_warning(
449
'Unable to load plugin %r from %r: %s' % (name, dir, e))
453
"""Return a dictionary of the plugins.
455
Each item in the dictionary is a PlugIn object.
458
for fullname in sys.modules:
459
if fullname.startswith(_MODULE_PREFIX):
460
name = fullname[len(_MODULE_PREFIX):]
461
if "." not in name and sys.modules[fullname] is not None:
462
result[name] = PlugIn(name, sys.modules[fullname])
466
def get_loaded_plugin(name):
467
"""Retrieve an already loaded plugin.
469
Returns None if there is no such plugin loaded
472
module = sys.modules[_MODULE_PREFIX + name]
477
return PlugIn(name, module)
480
def format_concise_plugin_list(state=None):
481
"""Return a string holding a concise list of plugins and their version.
484
state = breezy.get_global_state()
486
for name, a_plugin in sorted(getattr(state, 'plugins', {}).items()):
487
items.append("%s[%s]" %
488
(name, a_plugin.__version__))
489
return ', '.join(items)
492
class PluginsHelpIndex(object):
493
"""A help index that returns help topics for plugins."""
496
self.prefix = 'plugins/'
498
def get_topics(self, topic):
499
"""Search for topic in the loaded plugins.
501
This will not trigger loading of new plugins.
503
:param topic: A topic to search for.
504
:return: A list which is either empty or contains a single
505
RegisteredTopic entry.
509
if topic.startswith(self.prefix):
510
topic = topic[len(self.prefix):]
511
plugin_module_name = _MODULE_PREFIX + topic
513
module = sys.modules[plugin_module_name]
517
return [ModuleHelpTopic(module)]
520
class ModuleHelpTopic(object):
521
"""A help topic which returns the docstring for a module."""
523
def __init__(self, module):
526
:param module: The module for which help should be generated.
530
def get_help_text(self, additional_see_also=None, verbose=True):
531
"""Return a string with the help for this topic.
533
:param additional_see_also: Additional help topics to be
536
if not self.module.__doc__:
537
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
539
result = self.module.__doc__
540
if result[-1] != '\n':
542
result += help_topics._format_see_also(additional_see_also)
545
def get_help_topic(self):
546
"""Return the module help topic: its basename."""
547
return self.module.__name__[len(_MODULE_PREFIX):]
550
class PlugIn(object):
551
"""The breezy representation of a plugin.
553
The PlugIn object provides a way to manipulate a given plugin module.
556
def __init__(self, name, module):
557
"""Construct a plugin for module."""
562
"""Get the path that this plugin was loaded from."""
563
if getattr(self.module, '__path__', None) is not None:
564
return os.path.abspath(self.module.__path__[0])
565
elif getattr(self.module, '__file__', None) is not None:
566
path = os.path.abspath(self.module.__file__)
567
if path[-4:] == COMPILED_EXT:
568
pypath = path[:-4] + '.py'
569
if os.path.isfile(pypath):
573
return repr(self.module)
576
return "<%s.%s name=%s, module=%s>" % (
577
self.__class__.__module__, self.__class__.__name__,
578
self.name, self.module)
580
def test_suite(self):
581
"""Return the plugin's test suite."""
582
if getattr(self.module, 'test_suite', None) is not None:
583
return self.module.test_suite()
587
def load_plugin_tests(self, loader):
588
"""Return the adapted plugin's test suite.
590
:param loader: The custom loader that should be used to load additional
593
if getattr(self.module, 'load_tests', None) is not None:
594
return loader.loadTestsFromModule(self.module)
598
def version_info(self):
599
"""Return the plugin's version_tuple or None if unknown."""
600
version_info = getattr(self.module, 'version_info', None)
601
if version_info is not None:
603
if isinstance(version_info, str):
604
version_info = version_info.split('.')
605
elif len(version_info) == 3:
606
version_info = tuple(version_info) + ('final', 0)
608
# The given version_info isn't even iteratible
609
trace.log_exception_quietly()
610
version_info = (version_info,)
614
def __version__(self):
615
version_info = self.version_info()
616
if version_info is None or len(version_info) == 0:
619
version_string = breezy._format_version_tuple(version_info)
620
except (ValueError, TypeError, IndexError):
621
trace.log_exception_quietly()
622
# Try to show something for the version anyway
623
version_string = '.'.join(map(str, version_info))
624
return version_string
627
class _PluginsAtFinder(object):
628
"""Meta path finder to support BRZ_PLUGINS_AT configuration."""
630
def __init__(self, prefix, names_and_paths):
632
self.names_to_path = dict((prefix + n, p) for n, p in names_and_paths)
635
return "<%s %r>" % (self.__class__.__name__, self.prefix)
637
def find_spec(self, fullname, paths, target=None):
638
"""New module spec returning find method."""
639
if fullname not in self.names_to_path:
641
path = self.names_to_path[fullname]
642
if os.path.isdir(path):
643
path = _get_package_init(path)
645
# GZ 2017-06-02: Any reason to block loading of the name from
646
# further down the path like this?
647
raise ImportError("Not loading namespace package %s as %s" % (
649
return importlib_util.spec_from_file_location(fullname, path)
651
def find_module(self, fullname, path):
652
"""Old PEP 302 import hook find_module method."""
653
if fullname not in self.names_to_path:
655
return _LegacyLoader(self.names_to_path[fullname])
658
class _LegacyLoader(object):
659
"""Source loader implementation for Python versions without importlib."""
661
def __init__(self, filepath):
662
self.filepath = filepath
665
return "<%s %r>" % (self.__class__.__name__, self.filepath)
667
def load_module(self, fullname):
668
"""Load a plugin from a specific directory (or file)."""
669
plugin_path = self.filepath
671
if os.path.isdir(plugin_path):
672
init_path = _get_package_init(plugin_path)
673
if init_path is not None:
674
loading_path = plugin_path
677
kind = imp.PKG_DIRECTORY
679
for suffix, mode, kind in imp.get_suffixes():
680
if plugin_path.endswith(suffix):
681
loading_path = plugin_path
683
if loading_path is None:
684
raise ImportError('%s cannot be loaded from %s'
685
% (fullname, plugin_path))
686
if kind is imp.PKG_DIRECTORY:
689
f = open(loading_path, mode)
691
mod = imp.load_module(fullname, f, loading_path,
692
(suffix, mode, kind))
693
mod.__package__ = fullname
added
removed
breezy/plugin.py
