rename unique_ordered_append to unique_ordered_extend and enforce closer behaviour to extend

Author: lexming

easybuild/tools/toolchain/toolchain.py

@@ -69,7 +69,7 @@
 from easybuild.tools.systemtools import LINUX, get_os_type
 from easybuild.tools.toolchain.options import ToolchainOptions
 from easybuild.tools.toolchain.toolchainvariables import ToolchainVariables
-from easybuild.tools.utilities import nub, unique_ordered_append, trace_msg
+from easybuild.tools.utilities import nub, unique_ordered_extend, trace_msg
 
 
 _log = fancylogger.getLogger('tools.toolchain', fname=False)
@@ -1089,7 +1089,7 @@ def _add_dependency_cpp_headers(self, dep_root, extra_dirs=None):
             extra_dirs = ()
 
         header_dirs = ["include"]
-        header_dirs = unique_ordered_append(header_dirs, extra_dirs)
+        header_dirs = unique_ordered_extend(header_dirs, extra_dirs)
 
         # mode of operation is defined by search-path-cpp-headers option
         # toolchain option has precedence over build option
@@ -1120,7 +1120,7 @@ def _add_dependency_linker_paths(self, dep_root, extra_dirs=None):
             extra_dirs = ()
 
         lib_dirs = ["lib64", "lib"]
-        lib_dirs = unique_ordered_append(lib_dirs, extra_dirs)
+        lib_dirs = unique_ordered_extend(lib_dirs, extra_dirs)
 
         env_var = "LDFLAGS"
         self.log.debug("Adding lib paths to toolchain variable '%s': %s", env_var, dep_root)

easybuild/tools/utilities.py

@@ -223,10 +223,11 @@ def nub(list_):
     return [x for x in list_ if x not in seen and not seen_add(x)]
 
 
-def unique_ordered_append(base, extra):
-    """Append elements of extra list to another base list keeping order and without duplicates"""
-    if extra and isinstance(extra, str):
-        extra = [extra]
+def unique_ordered_extend(base, extra):
+    """Extend base list with elements of extra list keeping order and without duplicates"""
+    if isinstance(extra, str):
+        # avoid strings as they are iterables and generate wrong result without error
+        raise EasyBuildError(f"given extra list is a string: {extra}")
 
     try:
         base.extend(extra)

test/framework/utilities_test.py

@@ -191,22 +191,22 @@ def test_LooseVersion(self):
         self.assertEqual(LooseVersion('2.a').version, [2, 'a'])
         self.assertEqual(LooseVersion('2.a5').version, [2, 'a', 5])
 
-    def test_unique_ordered_append(self):
+    def test_unique_ordered_extend(self):
         """Test unique_ordered_list_append method"""
         base = ["potato", "tomato", "orange"]
 
         reference = ["potato", "tomato", "orange", "apple"]
-        self.assertEqual(tu.unique_ordered_append(base, ["apple"]), reference)
-        self.assertEqual(tu.unique_ordered_append(base, ["apple", "apple"]), reference)
-        self.assertEqual(tu.unique_ordered_append(base, "apple"), reference)
-        self.assertNotEqual(tu.unique_ordered_append(base, "apple"), sorted(reference))
+        self.assertEqual(tu.unique_ordered_extend(base, ["apple"]), reference)
+        self.assertEqual(tu.unique_ordered_extend(base, ["apple", "apple"]), reference)
+        self.assertEqual(tu.unique_ordered_extend(base, "apple"), reference)
+        self.assertNotEqual(tu.unique_ordered_extend(base, "apple"), sorted(reference))
 
         error_pattern = "given extra list is not iterable"
-        self.assertErrorRegex(EasyBuildError, error_pattern, tu.unique_ordered_append, base, 0)
+        self.assertErrorRegex(EasyBuildError, error_pattern, tu.unique_ordered_extend, base, 0)
 
         base = "potato"
         error_pattern = "given base cannot be extended"
-        self.assertErrorRegex(EasyBuildError, error_pattern, tu.unique_ordered_append, base, reference)
+        self.assertErrorRegex(EasyBuildError, error_pattern, tu.unique_ordered_extend, base, reference)
 
 
 def suite():