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(), """
50
from importlib import util as importlib_util
62
_MODULE_PREFIX = "breezy.plugins."
64
if __debug__ or sys.version_info > (3,):
70
def disable_plugins(state=None):
71
"""Disable loading plugins.
73
Future calls to load_plugins() will be ignored.
75
:param state: The library state object that records loaded plugins.
78
state = breezy.global_state
82
def load_plugins(path=None, state=None):
83
"""Load breezy plugins.
85
The environment variable BRZ_PLUGIN_PATH is considered a delimited
86
set of paths to look through. Each entry is searched for `*.py`
87
files (and whatever other extensions are used in the platform,
90
:param path: The list of paths to search for plugins. By default,
91
it is populated from the __path__ of the breezy.plugins package.
92
:param state: The library state object that records loaded plugins.
95
state = breezy.global_state
96
if getattr(state, 'plugins', None) is not None:
97
# People can make sure plugins are loaded, they just won't be twice
101
# Calls back into extend_path() here
102
from breezy.plugins import __path__ as path
104
state.plugin_warnings = {}
105
_load_plugins(state, path)
106
state.plugins = plugins()
109
def plugin_name(module_name):
110
"""Gives unprefixed name from module_name or None."""
111
if module_name.startswith(_MODULE_PREFIX):
112
parts = module_name.split(".")
118
def extend_path(path, name):
119
"""Helper so breezy.plugins can be a sort of namespace package.
121
To be used in similar fashion to pkgutil.extend_path:
123
from breezy.plugins import extend_path
124
__path__ = extend_path(__path__, __name__)
126
Inspects the BRZ_PLUGIN* envvars, sys.path, and the filesystem to find
127
plugins. May mutate sys.modules in order to block plugin loading, and may
128
append a new meta path finder to sys.meta_path for plugins@ loading.
130
Returns a list of paths to import from, as an enhanced object that also
131
contains details of the other configuration used.
133
blocks = _env_disable_plugins()
134
_block_plugins(blocks)
136
extra_details = _env_plugins_at()
137
_install_importer_if_needed(extra_details)
139
paths = _iter_plugin_paths(_env_plugin_path(), path)
141
return _Path(name, blocks, extra_details, paths)
145
"""List type to use as __path__ but containing additional details.
147
Python 3 allows any iterable for __path__ but Python 2 is more fussy.
150
def __init__(self, package_name, blocked, extra, paths):
151
super(_Path, self).__init__(paths)
152
self.package_name = package_name
153
self.blocked_names = blocked
154
self.extra_details = extra
157
return "%s(%r, %r, %r, %s)" % (
158
self.__class__.__name__, self.package_name, self.blocked_names,
159
self.extra_details, list.__repr__(self))
162
def _expect_identifier(name, env_key, env_value):
163
"""Validate given name from envvar is usable as a Python identifier.
165
Returns the name as a native str, or None if it was invalid.
167
Per PEP 3131 this is no longer strictly correct for Python 3, but as MvL
168
didn't include a neat way to check except eval, this enforces ascii.
170
if re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", name) is None:
171
trace.warning("Invalid name '%s' in %s='%s'", name, env_key, env_value)
176
def _env_disable_plugins(key='BRZ_DISABLE_PLUGINS'):
177
"""Gives list of names for plugins to disable from environ key."""
179
env = osutils.path_from_environ(key)
181
for name in env.split(os.pathsep):
182
name = _expect_identifier(name, key, env)
184
disabled_names.append(name)
185
return disabled_names
188
def _env_plugins_at(key='BRZ_PLUGINS_AT'):
189
"""Gives list of names and paths of specific plugins from environ key."""
191
env = osutils.path_from_environ(key)
193
for pair in env.split(os.pathsep):
195
name, path = pair.split('@', 1)
198
name = osutils.basename(path).split('.', 1)[0]
199
name = _expect_identifier(name, key, env)
201
plugin_details.append((name, path))
202
return plugin_details
205
def _env_plugin_path(key='BRZ_PLUGIN_PATH'):
206
"""Gives list of paths and contexts for plugins from environ key.
208
Each entry is either a specific path to load plugins from and the value
209
'path', or None and one of the three values 'user', 'core', 'site'.
212
env = osutils.path_from_environ(key)
213
defaults = {"user": not env, "core": True, "site": True}
215
# Add paths specified by user in order
216
for p in env.split(os.pathsep):
217
flag, name = p[:1], p[1:]
218
if flag in ("+", "-") and name in defaults:
219
if flag == "+" and defaults[name] is not None:
220
path_details.append((None, name))
221
defaults[name] = None
223
path_details.append((p, 'path'))
225
# Add any remaining default paths
226
for name in ('user', 'core', 'site'):
228
path_details.append((None, name))
233
def _iter_plugin_paths(paths_from_env, core_paths):
234
"""Generate paths using paths_from_env and core_paths."""
235
# GZ 2017-06-02: This is kinda horrid, should make better.
236
for path, context in paths_from_env:
237
if context == 'path':
239
elif context == 'user':
240
path = get_user_plugin_path()
241
if os.path.isdir(path):
243
elif context == 'core':
244
for path in _get_core_plugin_paths(core_paths):
246
elif context == 'site':
247
for path in _get_site_plugin_paths(sys.path):
248
if os.path.isdir(path):
252
def _install_importer_if_needed(plugin_details):
253
"""Install a meta path finder to handle plugin_details if any."""
255
finder = _PluginsAtFinder(_MODULE_PREFIX, plugin_details)
256
# For Python 3, must insert before default PathFinder to override.
257
sys.meta_path.insert(2, finder)
260
def _load_plugins(state, paths):
261
"""Do the importing all plugins from paths."""
262
imported_names = set()
263
for name, path in _iter_possible_plugins(paths):
264
if name not in imported_names:
265
msg = _load_plugin_module(name, path)
267
state.plugin_warnings.setdefault(name, []).append(msg)
268
imported_names.add(name)
271
def _block_plugins(names):
272
"""Add names to sys.modules to block future imports."""
274
package_name = _MODULE_PREFIX + name
275
if sys.modules.get(package_name) is not None:
276
trace.mutter("Blocked plugin %s already loaded.", name)
277
sys.modules[package_name] = None
280
def _get_package_init(package_path):
281
"""Get path of __init__ file from package_path or None if not a package."""
282
init_path = osutils.pathjoin(package_path, "__init__.py")
283
if os.path.exists(init_path):
285
init_path = init_path[:-3] + COMPILED_EXT
286
if os.path.exists(init_path):
291
def _iter_possible_plugins(plugin_paths):
292
"""Generate names and paths of possible plugins from plugin_paths."""
293
# Inspect any from BRZ_PLUGINS_AT first.
294
for name, path in getattr(plugin_paths, "extra_details", ()):
296
# Then walk over files and directories in the paths from the package.
297
for path in plugin_paths:
298
if os.path.isfile(path):
299
if path.endswith(".zip"):
300
trace.mutter("Don't yet support loading plugins from zip.")
302
for name, path in _walk_modules(path):
306
def _walk_modules(path):
307
"""Generate name and path of modules and packages on path."""
308
for root, dirs, files in os.walk(path):
312
if f.endswith((".py", COMPILED_EXT)):
313
yield f.rsplit(".", 1)[0], root
317
package_dir = osutils.pathjoin(root, d)
318
fullpath = _get_package_init(package_dir)
319
if fullpath is not None:
321
# Don't descend into subdirectories
325
def describe_plugins(show_paths=False, state=None):
326
"""Generate text description of plugins.
328
Includes both those that have loaded, and those that failed to load.
330
:param show_paths: If true, include the plugin path.
331
:param state: The library state object to inspect.
332
:returns: Iterator of text lines (including newlines.)
335
state = breezy.global_state
336
all_names = sorted(set(state.plugins).union(state.plugin_warnings))
337
for name in all_names:
338
if name in state.plugins:
339
plugin = state.plugins[name]
340
version = plugin.__version__
341
if version == 'unknown':
343
yield '%s %s\n' % (name, version)
344
d = plugin.module.__doc__
346
doc = d.split('\n')[0]
348
doc = '(no description)'
349
yield (" %s\n" % doc)
351
yield (" %s\n" % plugin.path())
353
yield "%s (failed to load)\n" % name
354
if name in state.plugin_warnings:
355
for line in state.plugin_warnings[name]:
356
yield " ** " + line + '\n'
360
def _get_core_plugin_paths(existing_paths):
361
"""Generate possible locations for plugins based on existing_paths."""
362
if getattr(sys, 'frozen', False):
363
# We need to use relative path to system-wide plugin
364
# directory because breezy from standalone brz.exe
365
# could be imported by another standalone program
366
# (e.g. bzr-config; or TortoiseBzr/Olive if/when they
367
# will become standalone exe). [bialix 20071123]
368
# __file__ typically is
369
# C:\Program Files\Bazaar\lib\library.zip\breezy\plugin.pyc
370
# then plugins directory is
371
# C:\Program Files\Bazaar\plugins
372
# so relative path is ../../../plugins
373
yield osutils.abspath(osutils.pathjoin(
374
osutils.dirname(__file__), '../../../plugins'))
375
else: # don't look inside library.zip
376
for path in existing_paths:
380
def _get_site_plugin_paths(sys_paths):
381
"""Generate possible locations for plugins from given sys_paths."""
382
for path in sys_paths:
383
if os.path.basename(path) in ('dist-packages', 'site-packages'):
384
yield osutils.pathjoin(path, 'breezy', 'plugins')
387
def get_user_plugin_path():
388
return osutils.pathjoin(config.config_dir(), 'plugins')
391
def record_plugin_warning(warning_message):
392
trace.mutter(warning_message)
393
return warning_message
396
def _load_plugin_module(name, dir):
397
"""Load plugin by name.
399
:param name: The plugin name in the breezy.plugins namespace.
400
:param dir: The directory the plugin is loaded from for error messages.
402
if _MODULE_PREFIX + name in sys.modules:
405
__import__(_MODULE_PREFIX + name)
406
except errors.IncompatibleAPI as e:
408
"Unable to load plugin %r. It requested API version "
409
"%s of module %s but the minimum exported version is %s, and "
410
"the maximum is %s" %
411
(name, e.wanted, e.api, e.minimum, e.current))
412
return record_plugin_warning(warning_message)
413
except Exception as e:
414
trace.log_exception_quietly()
415
if 'error' in debug.debug_flags:
416
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))
432
"""Return a dictionary of the plugins.
434
Each item in the dictionary is a PlugIn object.
437
for fullname in sys.modules:
438
if fullname.startswith(_MODULE_PREFIX):
439
name = fullname[len(_MODULE_PREFIX):]
440
if not "." in name and sys.modules[fullname] is not None:
441
result[name] = PlugIn(name, sys.modules[fullname])
445
def format_concise_plugin_list():
446
"""Return a string holding a concise list of plugins and their version.
449
for name, a_plugin in sorted(plugins().items()):
450
items.append("%s[%s]" %
451
(name, a_plugin.__version__))
452
return ', '.join(items)
455
class PluginsHelpIndex(object):
456
"""A help index that returns help topics for plugins."""
459
self.prefix = 'plugins/'
461
def get_topics(self, topic):
462
"""Search for topic in the loaded plugins.
464
This will not trigger loading of new plugins.
466
:param topic: A topic to search for.
467
:return: A list which is either empty or contains a single
468
RegisteredTopic entry.
472
if topic.startswith(self.prefix):
473
topic = topic[len(self.prefix):]
474
plugin_module_name = _MODULE_PREFIX + topic
476
module = sys.modules[plugin_module_name]
480
return [ModuleHelpTopic(module)]
483
class ModuleHelpTopic(object):
484
"""A help topic which returns the docstring for a module."""
486
def __init__(self, module):
489
:param module: The module for which help should be generated.
493
def get_help_text(self, additional_see_also=None, verbose=True):
494
"""Return a string with the help for this topic.
496
:param additional_see_also: Additional help topics to be
499
if not self.module.__doc__:
500
result = "Plugin '%s' has no docstring.\n" % self.module.__name__
502
result = self.module.__doc__
503
if result[-1] != '\n':
505
result += help_topics._format_see_also(additional_see_also)
508
def get_help_topic(self):
509
"""Return the module help topic: its basename."""
510
return self.module.__name__[len(_MODULE_PREFIX):]
513
class PlugIn(object):
514
"""The breezy representation of a plugin.
516
The PlugIn object provides a way to manipulate a given plugin module.
519
def __init__(self, name, module):
520
"""Construct a plugin for module."""
525
"""Get the path that this plugin was loaded from."""
526
if getattr(self.module, '__path__', None) is not None:
527
return os.path.abspath(self.module.__path__[0])
528
elif getattr(self.module, '__file__', None) is not None:
529
path = os.path.abspath(self.module.__file__)
530
if path[-4:] == COMPILED_EXT:
531
pypath = path[:-4] + '.py'
532
if os.path.isfile(pypath):
536
return repr(self.module)
539
return "<%s.%s name=%s, module=%s>" % (
540
self.__class__.__module__, self.__class__.__name__,
541
self.name, self.module)
543
def test_suite(self):
544
"""Return the plugin's test suite."""
545
if getattr(self.module, 'test_suite', None) is not None:
546
return self.module.test_suite()
550
def load_plugin_tests(self, loader):
551
"""Return the adapted plugin's test suite.
553
:param loader: The custom loader that should be used to load additional
556
if getattr(self.module, 'load_tests', None) is not None:
557
return loader.loadTestsFromModule(self.module)
561
def version_info(self):
562
"""Return the plugin's version_tuple or None if unknown."""
563
version_info = getattr(self.module, 'version_info', None)
564
if version_info is not None:
566
if isinstance(version_info, str):
567
version_info = version_info.split('.')
568
elif len(version_info) == 3:
569
version_info = tuple(version_info) + ('final', 0)
571
# The given version_info isn't even iteratible
572
trace.log_exception_quietly()
573
version_info = (version_info,)
577
def __version__(self):
578
version_info = self.version_info()
579
if version_info is None or len(version_info) == 0:
582
version_string = breezy._format_version_tuple(version_info)
583
except (ValueError, TypeError, IndexError):
584
trace.log_exception_quietly()
585
# Try to show something for the version anyway
586
version_string = '.'.join(map(str, version_info))
587
return version_string
590
class _PluginsAtFinder(object):
591
"""Meta path finder to support BRZ_PLUGINS_AT configuration."""
593
def __init__(self, prefix, names_and_paths):
595
self.names_to_path = dict((prefix + n, p) for n, p in names_and_paths)
598
return "<%s %r>" % (self.__class__.__name__, self.prefix)
600
def find_spec(self, fullname, paths, target=None):
601
"""New module spec returning find method."""
602
if fullname not in self.names_to_path:
604
path = self.names_to_path[fullname]
605
if os.path.isdir(path):
606
path = _get_package_init(path)
608
# GZ 2017-06-02: Any reason to block loading of the name from
609
# further down the path like this?
610
raise ImportError("Not loading namespace package %s as %s" % (
612
return importlib_util.spec_from_file_location(fullname, path)
614
def find_module(self, fullname, path):
615
"""Old PEP 302 import hook find_module method."""
616
if fullname not in self.names_to_path:
618
return _LegacyLoader(self.names_to_path[fullname])
621
class _LegacyLoader(object):
622
"""Source loader implementation for Python versions without importlib."""
624
def __init__(self, filepath):
625
self.filepath = filepath
628
return "<%s %r>" % (self.__class__.__name__, self.filepath)
630
def load_module(self, fullname):
631
"""Load a plugin from a specific directory (or file)."""
632
plugin_path = self.filepath
634
if os.path.isdir(plugin_path):
635
init_path = _get_package_init(plugin_path)
636
if init_path is not None:
637
loading_path = plugin_path
640
kind = imp.PKG_DIRECTORY
642
for suffix, mode, kind in imp.get_suffixes():
643
if plugin_path.endswith(suffix):
644
loading_path = plugin_path
646
if loading_path is None:
647
raise ImportError('%s cannot be loaded from %s'
648
% (fullname, plugin_path))
649
if kind is imp.PKG_DIRECTORY:
652
f = open(loading_path, mode)
654
mod = imp.load_module(fullname, f, loading_path,
655
(suffix, mode, kind))
656
mod.__package__ = fullname
added
removed
breezy/plugin.py
