Merge pull request #4 from boegel/module_whatis

use None as default value for whatis + minor style fixes
easybuilders · Nov 27, 2015 · c51f466 · c51f466
2 parents 1c3caa6 + 4f997d2
commit c51f466
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/easybuild/framework/easyconfig/default.py b/easybuild/framework/easyconfig/default.py
@@ -155,7 +155,7 @@
     'exts_list': [[], 'List with extensions added to the base installation', EXTENSIONS],
 
     # MODULES easyconfig parameters
-    'whatis': [[], "List of brief (one line) package description entries", MODULES],
+    'whatis': [None, "List of brief (one line) package description entries", MODULES],
     'modaliases': [{}, "Aliases to be defined in module file", MODULES],
     'modextrapaths': [{}, "Extra paths to be prepended in module file", MODULES],
     'modextravars': [{}, "Extra environment variables to be added to module file", MODULES],

diff --git a/easybuild/tools/module_generator.py b/easybuild/tools/module_generator.py
@@ -163,7 +163,8 @@ def get_description(self, conflict=True):
         description = "%s - Homepage: %s" % (self.app.cfg['description'], self.app.cfg['homepage'])
 
         whatis = self.app.cfg['whatis']
-        if not whatis:
+        if whatis is None:
+            # default: include single 'whatis' statement with description as contents
             whatis = [description]
 
         lines = [
@@ -194,7 +195,7 @@ def get_description(self, conflict=True):
             'name': self.app.name,
             'version': self.app.version,
             'description': description,
-            'whatis_lines': "\n".join(("module-whatis {%s}" % line) for line in whatis),
+            'whatis_lines': '\n'.join(["module-whatis {%s}" % line for line in whatis]),
             'installdir': self.app.installdir,
         }
 
@@ -338,7 +339,8 @@ def get_description(self, conflict=True):
         description = "%s - Homepage: %s" % (self.app.cfg['description'], self.app.cfg['homepage'])
 
         whatis = self.app.cfg['whatis']
-        if not whatis:
+        if whatis is None:
+            # default: include single 'whatis' statement with description as contents
             whatis = [description]
 
         lines = [
@@ -360,7 +362,7 @@ def get_description(self, conflict=True):
             'name': self.app.name,
             'version': self.app.version,
             'description': description,
-            'whatis_lines': "\n".join(("whatis([[%s]])" % line) for line in whatis),
+            'whatis_lines': '\n'.join(["whatis([[%s]])" % line for line in whatis]),
             'installdir': self.app.installdir,
             'homepage': self.app.cfg['homepage'],
         }

diff --git a/test/framework/module_generator.py b/test/framework/module_generator.py
@@ -107,7 +107,7 @@ def test_descr(self):
         self.assertEqual(desc, expected)
 
         # Test description with list of 'whatis' strings
-        self.eb.cfg.update('whatis', ['foo', 'bar'])
+        self.eb.cfg['whatis'] = ['foo', 'bar']
         if self.MODULE_GENERATOR_CLASS == ModuleGeneratorTcl:
             expected = '\n'.join([
                 "#%Module",