aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Dolbec <dolsen@gentoo.org>2017-08-17 01:50:21 +0000
committerZac Medico <zmedico@gentoo.org>2018-03-29 20:51:20 -0700
commit3bffbc6150be9ee81d47547cbff113a8d45edb6d (patch)
tree780afd5a936a31c2275781c7059681b3cbc19bf6
parentrepoman: Initial adding file/module/API version (diff)
downloadportage-3bffbc6150be9ee81d47547cbff113a8d45edb6d.tar.gz
portage-3bffbc6150be9ee81d47547cbff113a8d45edb6d.tar.bz2
portage-3bffbc6150be9ee81d47547cbff113a8d45edb6d.zip
module.py: Extend the module loader for API version checking
If provided with an iterable of compatibility versions, The controller will check the plugin modules module_spec 'version' variable is compatible with the base application.
-rw-r--r--pym/portage/module.py22
1 files changed, 20 insertions, 2 deletions
diff --git a/pym/portage/module.py b/pym/portage/module.py
index c79e65518..bd7c94d4e 100644
--- a/pym/portage/module.py
+++ b/pym/portage/module.py
@@ -15,6 +15,10 @@ class InvalidModuleName(PortageException):
"""An invalid or unknown module name."""
+class ModuleVersionError(PortageException):
+ '''An incompatible module version'''
+
+
class Module(object):
"""Class to define and hold our plug-in module
@@ -87,16 +91,17 @@ class Modules(object):
@param namepath: Python import path to the "modules" directory
"""
- def __init__(self, path, namepath):
+ def __init__(self, path, namepath, compat_versions=None):
self._module_path = path
self._namepath = namepath
+ self.compat_versions = compat_versions
self.parents = []
self._modules = self._get_all_modules()
self.modules = ProtectedDict(self._modules)
self.module_names = sorted(self._modules)
def _get_all_modules(self):
- """scans the emaint modules dir for loadable modules
+ """scans the _module_path dir for loadable modules
@rtype: dictionary of module_plugins
"""
@@ -117,6 +122,7 @@ class Modules(object):
kids = {}
for entry in importables:
new_module = Module(entry, self._namepath)
+ self._check_compat(new_module)
for module_name in new_module.kids:
kid = new_module.kids[module_name]
kid['parent'] = new_module
@@ -211,6 +217,8 @@ class Modules(object):
@type modname: string
@param modname: the module class name
+ @type var: string
+ @param var: the base level variable to return
@type dictionary
@return: the modules class exported options descriptions
"""
@@ -220,3 +228,13 @@ class Modules(object):
raise InvalidModuleName(
"Module name '%s' is invalid or not found" % modname)
return value
+
+ def _check_compat(self, module):
+ if self.compat_versions:
+ if not module.module_spec['version'] in self.compat_versions:
+ raise ModuleVersionError(
+ "Error loading '%s' plugin module: %s, version: %s\n"
+ "Module is not compatible with the current application version\n"
+ "Compatible module API versions are: %s"
+ % (self._namepath, module.module_spec['name'],
+ module.module_spec['version'], self.compat_versions))