Changes to class visibility (e.g. _RMApp=>RMApp), to allow loading local extensions which are added as mixins

Author: barny

elmclient/__init__.py

@@ -24,3 +24,48 @@
 __license__ = __meta__.license
 __author__ = __meta__.author
 
+import importlib, os, inspect, glob
+
+# scan for extensions to import and extend the specified class
+# extensions are .py file with a name like <classname>-something.py e.g RMApp-extension.py
+# the classes in the file are added as base classes to the extended class
+# so it's dynamic mixins :-) A mixin may override existing methods
+def load_extensions( *, path=None, folder=None ):
+    path = path or os.getcwd()
+    folder = folder or "extensions"
+    
+    # find public elmclient names+classes - these are extension points
+    extendableclasses = {n:c for n,c in inspect.getmembers(importlib.import_module("elmclient"), inspect.isclass) }
+
+    # look for extension files
+    searchdir = os.path.join( path, folder )
+    if os.access( searchdir, os.F_OK ):
+        # folder doesn't exist - nothing to load
+        pass
+    else:
+        files = glob.glob( os.path.join( searchdir, "**/*.py" ), recursive=True )
+        for file in files:
+            filename = os.path.split( file )[1]
+            # get the extended class
+            extended = filename.split( "-", 1 )[0]
+            if extended not in extendableclasses:
+                print( "No matching class to extend for {filename}" )
+            else:
+                extendedclass=extendableclasses[extended]
+                # Import source file - from https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
+                loader = importlib.machinery.SourceFileLoader( filename, file )
+                spec = importlib.util.spec_from_loader( filename, loader )
+                mymodule = importlib.util.module_from_spec( spec )
+                loader.exec_module( mymodule )
+                # find the classes in the extension
+                extenderclasses = { n:c for n,c in inspect.getmembers( mymodule, inspect.isclass ) }
+                # add them to the extended class so they precede (i.e. may override) the previous base classes
+                for n,c in extenderclasses.items():
+                    # add to bases
+                    extendedclass.__bases__ = (c,)+extendedclass.__bases__
+
+
+# load any local extensions
+load_extensions( extendableclasses )
+
+

elmclient/_ccm.py

@@ -39,7 +39,7 @@ def callers():
 
 #################################################################################################
 
-class _CCMProject(_project._Project):
+class CCMProject(_project._Project):
     def __init__(self, name, project_uri, app, is_optin,singlemode):
         super().__init__(name, project_uri, app, is_optin,singlemode)
         self.default_query_resource = 'oslc_cm1:ChangeRequest'
@@ -295,9 +295,9 @@ def resolve_uri_to_name(self, uri, trytouseasid=False):
 #################################################################################################
 
 @utils.mixinomatic
-class _CCMApp(_app._App, _typesystem.No_Type_System_Mixin):
+class CCMApp(_app._App, _typesystem.No_Type_System_Mixin):
     domain = 'ccm'
-    project_class = _CCMProject
+    project_class = CCMProject
     supports_configs = False
     supports_components = False
     reportablerestbase='rpt/repository'
@@ -453,17 +453,17 @@ def process_represt_arguments( self, args, allapps ):
 
 #################################################################################################
 
-class _AMProject(_CCMProject):
+class AMProject(CCMProject):
     def __init__(self, name, project_uri, app, is_optin,singlemode):
         super().__init__(name, project_uri, app, is_optin,singlemode)
         self.default_query_resource = 'oslc_am:Resource'
 
 #################################################################################################
 
 @utils.mixinomatic
-class _AMApp(_app._App, _typesystem.No_Type_System_Mixin):
+class AMApp(_app._App, _typesystem.No_Type_System_Mixin):
     domain = 'am'
-    project_class = _AMProject
+    project_class = AMProject
     supports_configs = False
     supports_components = False
     supports_reportable_rest = False

elmclient/_gcm.py

@@ -48,7 +48,7 @@ def _hook_beforequery(querydetails):
 
 #################################################################################################
 
-class _GCMProject(_project._Project):
+class GCMProject(_project._Project):
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=True):
         super().__init__(name, project_uri, app, is_optin,singlemode, defaultinit=False)
         self.hooks = [_hook_beforequery]
@@ -369,15 +369,15 @@ def resolve_uri_to_name(self, uri, prefer_same_as=True, dontpreferhttprdfrui=Tru
 
 #################################################################################################
 
-class _GCMComponent(_GCMProject):
+class GCMComponent(GCMProject):
     pass
 
 #################################################################################################
 
 @utils.mixinomatic
 class GCMApp(_app._App, oslcqueryapi._OSLCOperations_Mixin, _typesystem.Type_System_Mixin):
     domain = 'gc'
-    project_class = _GCMProject
+    project_class = GCMProject
     supports_configs = False
     supports_components = True
     supports_reportable_rest = False

elmclient/_qm.py

@@ -30,7 +30,7 @@
 #################################################################################################
 
 
-class _QMProject(_project._Project, _qmrestapi.QM_REST_API_Mixin):
+class QMProject(_project._Project, _qmrestapi.QM_REST_API_Mixin):
     # A QM project
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=True):
         super().__init__(name, project_uri, app, is_optin,singlemode,defaultinit=defaultinit)
@@ -313,7 +313,7 @@ def list_components( self ):
 
     def _create_component_api(self, component_prj_url, component_name):
         logger.info( f"CREATE QM COMPONENT {self=} {component_prj_url=} {component_name=} {self.app=} {self.is_optin=} {self.singlemode=}" )
-        result = _QMComponent(component_name, component_prj_url, self.app, self.is_optin, self.singlemode, defaultinit=False, project=self)
+        result = QMComponent(component_name, component_prj_url, self.app, self.is_optin, self.singlemode, defaultinit=False, project=self)
         return result
 
 
@@ -415,7 +415,7 @@ def get_default_stream_name( self ):
 
 #################################################################################################
 
-class _QMComponent(_QMProject):
+class QMComponent(QMProject):
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=True, project=None):
         if not project:
             raise Exception( "You mist provide a project instance when creating a component" )
@@ -426,9 +426,9 @@ def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defa
 #################################################################################################
 
 @utils.mixinomatic
-class _QMApp(_app._App, oslcqueryapi._OSLCOperations_Mixin, _typesystem.Type_System_Mixin):
+class QMApp(_app._App, oslcqueryapi._OSLCOperations_Mixin, _typesystem.Type_System_Mixin):
     domain = 'qm'
-    project_class = _QMProject
+    project_class = QMProject
     supports_configs = True
     supports_components = True
     supports_reportable_rest = True

elmclient/_relm.py

@@ -32,7 +32,7 @@
 
 #################################################################################################
 
-class _RELMProject(_project._Project):
+class RELMProject(_project._Project):
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=False):
         super().__init__(name, project_uri, app, is_optin,singlemode, defaultinit=defaultinit)
         self.hooks = []
@@ -46,7 +46,7 @@ def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defa
 #@utils.mixinomatic
 class RELMApp(_app._App):
     domain = 'relm'
-    project_class = _RELMProject
+    project_class = RELMProject
     supports_configs = False
     supports_components = False
     supports_reportable_rest = False

elmclient/_rm.py

@@ -65,7 +65,7 @@ class _RM_PA_changeset( _config._Changeset,_RMProject):
         pass
 
 @utils.mixinomatic
-class _RMProject(_project._Project):
+class RMProject(_project._Project):
     # A project
     # NOTE there is a derived class RMComponent used for RM components - it doesn't offer any
     #   functionality, and is a separate class only so it's easier to see whether an instance is a component or the overall project
@@ -947,7 +947,7 @@ def list_components( self ):
 
     def _create_component_api(self, component_prj_url, component_name, confs_to_load):
         logger.info( f"CREATE RM COMPONENT {self=} {component_prj_url=} {component_name=} {self.app=} {self.is_optin=} {self.singlemode=}" )
-        result = _RMComponent(component_name, component_prj_url, self.app, self.is_optin, self.singlemode, defaultinit=False, project=self)
+        result = RMComponent(component_name, component_prj_url, self.app, self.is_optin, self.singlemode, defaultinit=False, project=self)
         result.confs_to_load = confs_to_load
         return result
 
@@ -1125,7 +1125,7 @@ def get_default_stream_name( self ):
 
 #################################################################################################
 
-class _RMComponent(_RMProject):
+class RMComponent(RMProject):
     def __init__(self, name, project_uri, app, is_optin=False, singlemode=False,defaultinit=True, project=None):
         if not project:
             raise Exception( "You must provide a project instance when creating a component" )
@@ -1275,9 +1275,9 @@ def deliver_changeset( self ):
 #################################################################################################
 
 @utils.mixinomatic
-class _RMApp(_app._App, oslcqueryapi._OSLCOperations_Mixin, _typesystem.Type_System_Mixin):
+class RMApp(_app._App, oslcqueryapi._OSLCOperations_Mixin, _typesystem.Type_System_Mixin):
     domain = 'rm'
-    project_class = _RMProject
+    project_class = RMProject
     supports_configs = True
     supports_components = True
     supports_reportable_rest = True