76 lines
2.2 KiB
Python
76 lines
2.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (C) 2012-2014 Bastian Kleineidam
|
|
# Copyright (C) 2016-2019 Tobias Gruetzmacher
|
|
"""
|
|
Functions to load plugin modules.
|
|
|
|
Example usage:
|
|
modules = loader.get_modules('plugins')
|
|
plugins = loader.get_plugins(modules, PluginClass)
|
|
"""
|
|
import importlib
|
|
import pkgutil
|
|
from .output import out
|
|
|
|
|
|
def get_modules(folder):
|
|
"""Find (and import) all valid modules in the given submodule of this file.
|
|
@return: all loaded valid modules
|
|
@rtype: iterator of module
|
|
"""
|
|
mod = importlib.import_module(".." + folder, __name__)
|
|
prefix = mod.__name__ + "."
|
|
modules = [m[1] for m in pkgutil.iter_modules(mod.__path__, prefix)]
|
|
|
|
for elm in _get_all_modules_pyinstaller():
|
|
if elm.startswith(prefix):
|
|
modules.append(elm)
|
|
|
|
for name in modules:
|
|
try:
|
|
yield importlib.import_module(name)
|
|
except ImportError as msg:
|
|
out.error("could not load module %s: %s" % (name, msg))
|
|
|
|
|
|
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_plugins(modules, classobj):
|
|
"""Find all class objects in all modules.
|
|
@param modules: the modules to search
|
|
@ptype modules: iterator of modules
|
|
@return: found classes
|
|
@rytpe: iterator of class objects
|
|
"""
|
|
for module in modules:
|
|
for plugin in get_module_plugins(module, classobj):
|
|
yield plugin
|
|
|
|
|
|
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
|