1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# SPDX-License-Identifier: MIT
# SPDX-FileCopyrightText: © 2012 Bastian Kleineidam
# SPDX-FileCopyrightText: © 2016 Tobias Gruetzmacher
"""
Functions to load plugin modules.
Example usage:
for module in loader.get_plugin_modules():
plugins.extend(loader.get_module_plugins(module, PluginClass))
"""
import importlib
import logging
import pkgutil
import sys
from .plugins import __name__ as plugin_package
from .plugins import __path__ as plugin_path
logger = logging.getLogger(__name__)
def get_plugin_modules():
"""Find (and import) all valid modules in the "plugins" package.
@return: all loaded valid modules
@rtype: iterator of module
"""
prefix = plugin_package + "."
modules = {m[1] for m in pkgutil.iter_modules(plugin_path, prefix)}
for elm in _get_all_modules_pyinstaller():
if elm.startswith(prefix):
modules.add(elm)
for name in modules:
try:
yield importlib.import_module(name)
except ImportError:
logger.exception("could not load module %s", name)
def _get_all_modules_pyinstaller():
# Special handling for PyInstaller
toc = set()
importers = pkgutil.iter_importers(__package__)
for i in importers:
if hasattr(i, 'toc'):
toc |= i.toc
return toc
def get_plugin_modules_from_dir(path, prefix='user_'):
"""Load and import a directory of python files as if they were part of the
"plugins" package. (Mostly "stolen" from
https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly)
"""
modules = []
for f in path.glob('*.py'):
name = plugin_package + "." + prefix + f.stem
# FIXME: Drop str() when this is Python 3.6+
spec = importlib.util.spec_from_file_location(name, str(f))
module = importlib.util.module_from_spec(spec)
sys.modules[name] = module
spec.loader.exec_module(module)
modules.append(module)
return modules
def get_module_plugins(module, classobj):
"""Return all subclasses of a class in the module.
If the module defines __all__, only those entries will be searched,
otherwise all objects not starting with '_' will be searched.
"""
try:
names = module.__all__
except AttributeError:
names = [x for x in vars(module) if not x.startswith('_')]
for name in names:
try:
obj = getattr(module, name)
except AttributeError:
continue
try:
if issubclass(obj, classobj):
yield obj
except TypeError:
continue
|
