Config: added inheritance via .extends or by group name for namelist groups

CHANGES.txt

@@ -9,6 +9,11 @@ Release Changes
 Release 1.1.4
 =============
 
+Config
+------
+
+* Added inheritance via .extends or by group name for namelist groups
+
 Release 1.1.3
 =============
 

expconfig.py

@@ -27,6 +27,35 @@ def is_set(s):
         return False
     return s.strip('.').lower().startswith('t')
 
+# - Provide merging of comments
+def is_not_empty(arg):
+    if arg is None:
+        return None
+    elif not isinstance(arg, (list, tuple)):
+        return arg.rstrip()
+    else:
+        return [_f for _f in [x.rstrip() for x in arg] if _f]
+
+def merge_comments(this, indict):
+    '''Merge comments from indict into current configuration. 
+
+    Requires indict to be merged before being called.
+    '''
+    if isinstance(indict, configobj.ConfigObj):
+        if is_not_empty(indict.initial_comment):
+            this.initial_comment = indict.initial_comment
+        if is_not_empty(indict.final_comment):
+            this.final_comment = indict.final_comment
+
+    for key in indict.scalars:
+        if is_not_empty(indict.comments[key]):
+            this.comments[key] = indict.comments[key]
+        if is_not_empty(indict.inline_comments[key]):
+            this.inline_comments[key] = indict.inline_comments[key]
+    
+    for key in indict.sections:
+        merge_comments(this[key], indict[key])
+
 class ConfigObj(configobj.ConfigObj):
 
     def __init__(self, *args, **kwargs):
@@ -40,35 +69,6 @@ class ConfigObj(configobj.ConfigObj):
         configobj.ConfigObj.__init__(self, *args, **kwargs)
 
     def merge(self, indict):
-
-        def is_not_empty(arg):
-            if arg is None:
-                return None
-            elif not isinstance(arg, (list, tuple)):
-                return arg.rstrip()
-            else:
-                return [_f for _f in [x.rstrip() for x in arg] if _f]
-
-        def merge_comments(this, indict):
-            '''Merge comments from indict into current configuration. 
-
-            Requires indict to be merged before being called.
-            '''
-            if isinstance(indict, configobj.ConfigObj):
-                if is_not_empty(indict.initial_comment):
-                    this.initial_comment = indict.initial_comment
-                if is_not_empty(indict.final_comment):
-                    this.final_comment = indict.final_comment
-
-            for key in indict.scalars:
-                if is_not_empty(indict.comments[key]):
-                    this.comments[key] = indict.comments[key]
-                if is_not_empty(indict.inline_comments[key]):
-                    this.inline_comments[key] = indict.inline_comments[key]
-            
-            for key in indict.sections:
-                merge_comments(this[key], indict[key])
-
         configobj.ConfigObj.merge(self, indict)
         if isinstance(indict, configobj.Section):
             merge_comments(self, indict)

mkexp

@@ -469,25 +469,29 @@ for key, value in config['jobs'].items():
         del config['jobs'][key]
 
 # Extend the given subjob config recursively
-def extend(subjob, jobs_config, extended_jobs):
+def extend(subjob, jobs_config, extended_jobs, job_dict=None):
     if subjob not in extended_jobs:
         subconfig = jobs_config[subjob]
 
         # Allow simple inheritance
         # Support deprecated keyword 'extends' but warn user
         extended_job = None
+        subjob_base = subjob.split(' ', 1)[0]
         if '.extends' in subconfig:
             extended_job = subconfig['.extends']
         elif 'extends' in subconfig:
             keyword_warning('extends')
             extended_job = subconfig['extends']
             subconfig.rename('extends', '.extends')
+        elif subjob_base != subjob and subjob_base in jobs_config:
+            extended_job = subjob_base
         if extended_job:
             extend(extended_job, jobs_config, extended_jobs)
 
         # Add global job settings
         pre_config = ConfigObj(interpolation=False)
-        pre_config.merge(job_dict)
+        if job_dict:
+            pre_config.merge(job_dict)
 
         # Add parent config
         if extended_job:
@@ -499,6 +503,7 @@ def extend(subjob, jobs_config, extended_jobs):
         # Replace subjob config by extended config
         jobs_config[subjob] = {}
         jobs_config[subjob].merge(pre_config)
+        expconfig.merge_comments(jobs_config[subjob], pre_config)
         del pre_config
 
         # Tick off extended jobs
@@ -510,7 +515,7 @@ extended_jobs = set()
 for subjob in jobs_config:
     if not subjob in remove_list:
         # Extend subjob config
-        extend(subjob, jobs_config, extended_jobs)
+        extend(subjob, jobs_config, extended_jobs, job_dict)
 
         # Add useful settings
         subconfig = jobs_config[subjob]
@@ -544,6 +549,12 @@ for subjob, subconfig in jobs_config.items():
         job_config[u'JOB'] = subconfig
         del subconfig
 
+        # Extend all namelists
+        for namelist, groups in job_config['namelists'].items():
+            extended_groups = set()
+            for group in groups.sections:
+                extend(group, groups, extended_groups)
+
         # Prepare namelists for inclusion in scripts
         var_format = job_config['JOB'].get('.var_format', '${%s}')
         var_list = set()

test.py

@@ -680,6 +680,62 @@ class NamelistDefaultValueTestCase(MkexpSimpleTestCase):
                   value = <DEFAULT>
         """)
 
+class NamelistInheritanceTestCase(MkexpSimpleTestCase):
+
+    def test_basic_inheritance(self):
+        self.run_test(u"""
+            %{NAMELIST}
+        """, u"""
+            &group1
+                value = 42
+            /
+            &group2
+                value = 42
+            /
+        """, u"""
+            [namelists]
+              [[namelist]]
+                [[[group1]]]
+                  value = 42
+                [[[group2]]]
+                  .extends = group1
+        """)
+
+    def test_hidden_inheritance(self):
+        self.run_test(u"""
+            %{NAMELIST}
+        """, u"""
+            &group2
+                value = 42
+            /
+        """, u"""
+            [namelists]
+              [[namelist]]
+                .remove = group1
+                [[[group1]]]
+                  value = 42
+                [[[group2]]]
+                  .extends = group1
+        """)
+
+    def test_inheritance_by_name(self):
+        self.run_test(u"""
+            %{NAMELIST}
+        """, u"""
+            &group
+                value = 42
+            /
+            &group ! 'clone'
+                value = 42
+            /
+        """, u"""
+            [namelists]
+              [[namelist]]
+                [[[group]]]
+                  value = 42
+                [[[group clone]]]
+        """)
+
 class JinjaTemplateTestCase(MkexpSimpleTestCase):
 
     def test_ignore_blocks(self):