Refactor make_extension_string

The current usage was confusing as it isn't clear what should be
overridden and what should be used.
See #4340

- Make `make_extension_string` a free function to just provide a common format
- Promote `make_extension_list` to a public method and document it
- Error when overriding the old methods
- Update the module generator and remove the confusingly named member methods

Author: Flamefire

easybuild/framework/easyblock.py

@@ -120,6 +120,18 @@
 _log = fancylogger.getLogger('easyblock')
 
 
+def make_extension_string(app, name_version_sep='-', ext_sep=', ', sort=True):
+    """
+    Generate a string with a list of extensions of the given EasyBlock instance.
+
+    The name and version are separated by name_version_sep and each extension is separated by ext_sep
+    """
+    exts_list = (name_version_sep.join(ext) for ext in app.make_extension_list())
+    if sort:
+        exts_list = sorted(exts_list, key=str.lower)
+    return ext_sep.join(exts_list)
+
+
 class EasyBlock(object):
     """Generic support for building and installing software, base class for actual easyblocks."""
 
@@ -1519,9 +1531,9 @@ def make_module_extra_extensions(self):
 
         # set environment variable that specifies list of extensions
         # We need only name and version, so don't resolve templates
-        exts_list = self.make_extension_string(ext_sep=',', sort=False)
-        env_var_name = convert_name(self.name, upper=True)
-        lines.append(self.module_generator.set_environment('EBEXTSLIST%s' % env_var_name, exts_list))
+        exts_list = make_extension_string(self, ext_sep=',', sort=False)
+        env_var_name = 'EBEXTSLIST' + convert_name(self.name, upper=True)
+        lines.append(self.module_generator.set_environment(env_var_name, exts_list))
 
         return ''.join(lines)
 
@@ -1800,14 +1812,19 @@ def load_dependency_modules(self):
     # EXTENSIONS UTILITY FUNCTIONS
     #
 
-    def _make_extension_list(self):
+    def make_extension_list(self):
         """
         Return a list of extension names and their versions included in this installation
 
-        Each entry should be a (name, version) tuple or just (name, ) if no version exists
+        Each entry should be a (name, version) tuple or just (name, ) if no version exists.
+        Custom EasyBlocks may override this to add extensions that cannot be found automatically.
         """
         # Each extension in exts_list is either a string or a list/tuple with name, version as first entries
         # As name can be a templated value we must resolve templates
+        if hasattr(self, '_make_extension_list'):
+            self.log.nosupport("self._make_extension_list is replaced by self.make_extension_list", '5.0')
+        if hasattr(self, 'make_extension_string'):
+            self.log.nosupport("self.make_extension_string was removed in favor of the free function", '5.0')
         exts_list = []
         for ext in self.cfg.get_ref('exts_list'):
             if isinstance(ext, str):
@@ -1817,17 +1834,6 @@ def _make_extension_list(self):
                                   resolve_template(ext[1], self.cfg.template_values)))
         return exts_list
 
-    def make_extension_string(self, name_version_sep='-', ext_sep=', ', sort=True):
-        """
-        Generate a string with a list of extensions.
-
-        The name and version are separated by name_version_sep and each extension is separated by ext_sep
-        """
-        exts_list = (name_version_sep.join(ext) for ext in self._make_extension_list())
-        if sort:
-            exts_list = sorted(exts_list, key=str.lower)
-        return ext_sep.join(exts_list)
-
     def prepare_for_extensions(self):
         """Ran before installing extensions (eg to set templates)"""
 

easybuild/tools/module_generator.py

@@ -45,6 +45,7 @@
 from textwrap import wrap
 
 from easybuild.base import fancylogger
+from easybuild.framework.easyblock import make_extension_string
 from easybuild.tools.build_log import EasyBuildError, print_warning
 from easybuild.tools.config import build_option, get_module_syntax, install_path
 from easybuild.tools.filetools import convert_name, mkdir, read_file, remove_file, resolve_path, symlink, write_file
@@ -610,21 +611,6 @@ def use(self, paths, prefix=None, guarded=False, user_modpath=None):
         """
         raise NotImplementedError
 
-    def _generate_extension_list(self):
-        """
-        Generate a string with a list of extensions.
-
-        The name and version are separated by name_version_sep and each extension is separated by ext_sep
-        """
-        return self.app.make_extension_string()
-
-    def _generate_extensions_list(self):
-        """
-        Generate a list of all extensions in name/version format
-        """
-        exts_str = self.app.make_extension_string(name_version_sep='/', ext_sep=',')
-        return exts_str.split(',') if exts_str else []
-
     def _generate_help_text(self):
         """
         Generate syntax-independent help text used for `module help`.
@@ -671,7 +657,7 @@ def _generate_help_text(self):
             lines.extend(self._generate_section("Compatible modules", compatible_modules_txt))
 
         # Extensions (if any)
-        extensions = self._generate_extension_list()
+        extensions = make_extension_string(self.app)
         lines.extend(self._generate_section("Included extensions", '\n'.join(wrap(extensions, 78))))
 
         return '\n'.join(lines)
@@ -686,10 +672,10 @@ def _generate_multi_deps_list(self):
                 mod_list = []
                 txt = ''
                 vlist = self.app.cfg['multi_deps'].get(key)
-                for idx in range(len(vlist)):
+                for idx, version in enumerate(vlist):
                     for deplist in self.app.cfg.multi_deps:
                         for dep in deplist:
-                            if dep['name'] == key and dep['version'] == vlist[idx]:
+                            if dep['name'] == key and dep['version'] == version:
                                 modname = dep['short_mod_name']
                                 # indicate which version is loaded by default (unless that's disabled)
                                 if idx == 0 and self.app.cfg['multi_deps_load_default']:
@@ -728,7 +714,7 @@ def _generate_whatis_lines(self):
             if multi_deps:
                 whatis.append("Compatible modules: %s" % ', '.join(multi_deps))
 
-            extensions = self._generate_extension_list()
+            extensions = make_extension_string(self.app)
             if extensions:
                 whatis.append("Extensions: %s" % extensions)
 
@@ -1284,12 +1270,9 @@ def get_description(self, conflict=True):
         elif conflict:
             # conflict on 'name' part of module name (excluding version part at the end)
             lines.extend(['', 'conflict("%s")' % os.path.dirname(self.app.short_mod_name)])
-
-        if build_option('module_extensions'):
-            extensions_list = self._generate_extensions_list()
-
+            extensions_list = self.app.make_extension_list()
             if extensions_list:
-                extensions_stmt = 'extensions("%s")' % ','.join([str(x) for x in extensions_list])
+                extensions_stmt = 'extensions("%s")' % ','.join(['/'.join(x) for x in extensions_list])
                 # put this behind a Lmod version check as 'extensions' is only (well) supported since Lmod 8.2.8,
                 # see https://lmod.readthedocs.io/en/latest/330_extensions.html#module-extensions and
                 # https://github.com/TACC/Lmod/issues/428