adding onOpen to make getting hold of gIndex simpler (no adHoc)

common/python/nomadcore/caching_backend.py

@@ -132,12 +132,13 @@ class CachingSection(object):
 
 class CachingSectionManager(object):
 
-    def __init__(self, metaInfo, parentSectionNames, lastSectionGIndex = -1, openSections = {}, onClose = [], storeInSuper = False, forwardOpenClose = True):
+    def __init__(self, metaInfo, parentSectionNames, lastSectionGIndex = -1, openSections = {}, onClose = [], onOpen = [], storeInSuper = False, forwardOpenClose = True):
         self.metaInfo = metaInfo
         self.parentSectionNames = parentSectionNames
         self.lastSectionGIndex = lastSectionGIndex
         self.openSections = dict(openSections)
         self.onClose = list(onClose)
+        self.onOpen = list(onOpen)
         self.storeInSuper = storeInSuper
         self.forwardOpenClose = forwardOpenClose
 
@@ -158,7 +159,10 @@ class CachingSectionManager(object):
                 references.append(pSect.lastSectionGIndex)
             else:
                 references.append(-1)
-        self.openSections[gIndex] = CachingSection(gIndex, references, storeInSuper = self.storeInSuper, activeBackend=backend)
+        opened = CachingSection(gIndex, references, storeInSuper = self.storeInSuper, activeBackend=backend)
+        self.openSections[gIndex] = opened
+        for onOpenF in self.onOpen:
+            onOpenF(backend, gIndex, opened)
 
     def closeSection(self, backend, gIndex):
         toClose = self.openSections[gIndex]
@@ -236,13 +240,19 @@ class ActiveBackend(object):
 
     @classmethod
     def activeBackend(cls, metaInfoEnv, cachingLevelForMetaName = {}, defaultDataCachingLevel = CachingLevel.ForwardAndCache, defaultSectionCachingLevel = CachingLevel.Forward, superBackend = None,
-                      onClose = {}, propagateStartFinishParsing = True, default_units=None, metainfo_units=None):
+                      onClose = {}, onOpen = {}, propagateStartFinishParsing = True, default_units=None, metainfo_units=None):
         for sectionName in onClose.keys():
             if not sectionName in metaInfoEnv:
                 raise Exception("Found trigger for non existing section %s" % sectionName)
             elif metaInfoEnv.infoKinds[sectionName].kindStr != "type_section":
                 raise Exception("Found trigger for %s which is not a section but %s" %
                                 (sectionName, json.dumps(metaInfoEnv.infoKinds[sectionName].toDict(), indent=2)))
+        for sectionName in onOpen.keys():
+            if not sectionName in metaInfoEnv:
+                raise Exception("Found trigger for non existing section %s" % sectionName)
+            elif metaInfoEnv.infoKinds[sectionName].kindStr != "type_section":
+                raise Exception("Found trigger for %s which is not a section but %s" %
+                                (sectionName, json.dumps(metaInfoEnv.infoKinds[sectionName].toDict(), indent=2)))
         sectionManagers = {}
         for ikNames, ik in metaInfoEnv.infoKinds.items():
             if ik.kindStr == "type_section":
@@ -254,7 +264,8 @@ class ActiveBackend(object):
                     parentSectionNames = parentS,
                     storeInSuper       = (cachingLevel == CachingLevel.ForwardAndCache or cachingLevel == CachingLevel.Cache),
                     forwardOpenClose   = (cachingLevel == CachingLevel.Forward or cachingLevel == CachingLevel.ForwardAndCache),
-                    onClose = onClose.get(ik.name, []))
+                    onClose = onClose.get(ik.name, []),
+                    onOpen = onOpen.get(ik.name, []))
         dataManagers = {}
         for ikNames, ik in metaInfoEnv.infoKinds.items():
             if ik.kindStr == "type_document_content" or ik.kindStr == "type_dimension":
@@ -271,6 +282,9 @@ class ActiveBackend(object):
     def appendOnClose(self, sectionName, onClose):
         self.sectionManagers.onClose.append(onClose)
 
+    def appendOnOpen(self, sectionName, onOpen):
+        self.sectionManagers.onOpen.append(onOpen)
+
     def storeToClosedSuper(self, superName, superGIndex, metaInfo, toClose):
         logging.getLogger("nomadcore.caching_backend").warn(
             "Dropping section {name} gIndex {gIndex}, as it cannot be added to closed super section {superName} gIndex: {superGIndex}".format(

common/python/nomadcore/simple_parser.py

@@ -672,6 +672,19 @@ def extractOnCloseTriggers(obj):
             triggers[name] = getattr(obj, attr)
     return triggers
 
+def extractOnOpenTriggers(obj):
+    """extracts all triggers from the object obj
+
+    triggers should start with onOpen_ and then have a valid section name.
+    They will be called with backend, gIndex and the section that is being closed
+    (of type CachingSection)"""
+    triggers = {}
+    for attr in dir(obj):
+        if attr.startswith("onOpen_"):
+            name = attr[7:]
+            triggers[name] = getattr(obj, attr)
+    return triggers
+
 class SimpleParserBuilder(object):
     def __init__(self, rootMatcher, metaInfoEnv, metaInfoToKeep=None, default_units=None, metainfo_units=None):
         """
@@ -1068,6 +1081,7 @@ def mainFunction(mainFileDescription,
                  defaultSectionCachingLevel = CachingLevel.Forward,
                  superContext = None,
                  onClose = {},
+                 onOpen = {},
                  default_units=None,
                  metainfo_units=None,
                  superBackend=None,
@@ -1177,12 +1191,20 @@ def mainFunction(mainFileDescription,
                 oldCallbacks.append(callback)
             else:
                 onClose[attr] = [callback]
+        onOpen = dict(onOpen)
+        for attr, callback in extractOnOpenTriggers(superContext).items():
+            oldCallbacks = onOpen.get(attr, None)
+            if oldCallbacks:
+                oldCallbacks.append(callback)
+            else:
+                onOpen[attr] = [callback]
     backend = ActiveBackend.activeBackend(
         metaInfoEnv = metaInfoEnv,
         cachingLevelForMetaName = cachingLevelForMetaName,
         defaultDataCachingLevel = defaultDataCachingLevel,
         defaultSectionCachingLevel = defaultSectionCachingLevel,
         onClose = onClose,
+        onOpen = onOpen,
         superBackend = jsonBackend,
         default_units=default_units,
         metainfo_units=metainfo_units)
@@ -1240,11 +1262,15 @@ class AncillaryParser(object):
         onClose = {}
         for attr, callback in extractOnCloseTriggers(superContext).items():
             onClose[attr] = [callback]
+        onOpen = {}
+        for attr, callback in extractOnOpenTriggers(superContext).items():
+            onOpen[attr] = [callback]
         # create backend for parser
         self.backend = ActiveBackend.activeBackend(
             metaInfoEnv = parser.parserBuilder.metaInfoEnv,
             cachingLevelForMetaName = cachingLevelForMetaName,
             onClose = onClose,
+            onOpen = onOpen,
             superBackend = parser.backend.superBackend,
             propagateStartFinishParsing = False,  # write no parser info upon start and end of parsing
             default_units=default_units,