Remove redundant usage of sort_looseversions

This now works directly.
Also fix the sort_looseversions function for the distutils version of LooseVersion

easybuild/tools/docs.py

@@ -57,7 +57,7 @@
 from easybuild.tools.config import build_option
 from easybuild.tools.filetools import read_file
 from easybuild.tools.modules import modules_tool
-from easybuild.tools.py2vs3 import OrderedDict, ascii_lowercase, sort_looseversions
+from easybuild.tools.py2vs3 import OrderedDict, ascii_lowercase
 from easybuild.tools.toolchain.toolchain import DUMMY_TOOLCHAIN_NAME, SYSTEM_TOOLCHAIN_NAME, is_system_toolchain
 from easybuild.tools.toolchain.utilities import search_toolchain
 from easybuild.tools.utilities import INDENT_2SPACES, INDENT_4SPACES
@@ -663,7 +663,7 @@ def key_to_ref(name):
  # sort pairs by version (and then by versionsuffix);
  # we sort by LooseVersion to obtain chronological version ordering,
  # but we also need to retain original string version for filtering-by-version done below
- sorted_pairs = sort_looseversions((LooseVersion(v), vs, v) for v, vs in pairs)
+ sorted_pairs = sorted((LooseVersion(v), vs, v) for v, vs in pairs)
 
  for _, vsuff, ver in sorted_pairs:
  table_values[0].append('``%s``' % ver)
@@ -721,7 +721,7 @@ def list_software_txt(software, detailed=False):
  # sort pairs by version (and then by versionsuffix);
  # we sort by LooseVersion to obtain chronological version ordering,
  # but we also need to retain original string version for filtering-by-version done below
- sorted_pairs = sort_looseversions((LooseVersion(v), vs, v) for v, vs in pairs)
+ sorted_pairs = sorted((LooseVersion(v), vs, v) for v, vs in pairs)
 
  for _, vsuff, ver in sorted_pairs:
  tcs = [x['toolchain'] for x in software[key] if x['version'] == ver and x['versionsuffix'] == vsuff]

easybuild/tools/py2vs3/py3.py

@@ -37,7 +37,6 @@
 import urllib.request as std_urllib # noqa
 from collections import OrderedDict # noqa
 from collections.abc import Mapping # noqa
-from easybuild.tools import LooseVersion
 from functools import cmp_to_key
 from html.parser import HTMLParser # noqa
 from itertools import zip_longest
@@ -50,6 +49,13 @@
 # importlib only works with Python 3.4 & newer
 from importlib import reload # noqa
 
+# distutils is deprecated, so prepare for it being removed
+try:
+ import distutils.version
+ HAVE_DISTUTILS = True
+except ImportError:
+ HAVE_DISTUTILS = False
+
 # string type that can be used in 'isinstance' calls
 string_type = str
 
@@ -121,7 +127,7 @@ def simple_compare(x1, x2):
  else:
  return 0
 
- if isinstance(v1, LooseVersion) and isinstance(v2, LooseVersion):
+ if isinstance(v1, distutils.version.LooseVersion) and isinstance(v2, distutils.version.LooseVersion):
  # implementation based on '14894.patch' patch file provided in https://bugs.python.org/issue14894
  for ver1_part, ver2_part in zip_longest(v1.version, v2.version, fillvalue=''):
  # use string comparison if version parts have different type
@@ -143,7 +149,10 @@ def simple_compare(x1, x2):
 
 
 def sort_looseversions(looseversions):
- """Sort list of (values including) LooseVersion instances."""
+ """Sort list of (values including) distutils.version.LooseVersion instances."""
  # with Python 2, we can safely use 'sorted' on LooseVersion instances
  # (but we can't in Python 3, see https://bugs.python.org/issue14894)
- return sorted(looseversions, key=cmp_to_key(safe_cmp_looseversions))
+ if HAVE_DISTUTILS:
+ return sorted(looseversions, key=cmp_to_key(safe_cmp_looseversions))
+ else:
+ return sorted(looseversions)

test/framework/options.py

@@ -6196,30 +6196,45 @@ def test_installdir(self):
  self.assertTrue(eb.installdir.endswith('/software/Core/toy/0.0'))
 
  def test_sort_looseversions(self):
- """Test sort_looseversions funuction."""
- ver1 = LooseVersion('1.2.3')
- ver2 = LooseVersion('4.5.6')
- ver3 = LooseVersion('1.2.3dev')
- ver4 = LooseVersion('system')
- ver5 = LooseVersion('rc3')
- ver6 = LooseVersion('v1802')
-
- # some versions are included multiple times on purpose,
- # to also test comparison between equal LooseVersion instances
- input = [ver3, ver5, ver1, ver2, ver4, ver6, ver3, ver4, ver1]
- expected = [ver1, ver1, ver3, ver3, ver2, ver5, ver4, ver4, ver6]
- self.assertEqual(sort_looseversions(input), expected)
-
- # also test on list of tuples consisting of a LooseVersion instance + a string
- # (as in the list_software_* functions)
- suff1 = ''
- suff2 = '-foo'
- suff3 = '-bar'
- input = [(ver3, suff1), (ver5, suff3), (ver1, suff2), (ver2, suff3), (ver4, suff1),
- (ver6, suff2), (ver3, suff3), (ver4, suff3), (ver1, suff1)]
- expected = [(ver1, suff1), (ver1, suff2), (ver3, suff1), (ver3, suff3), (ver2, suff3),
- (ver5, suff3), (ver4, suff1), (ver4, suff3), (ver6, suff2)]
- self.assertEqual(sort_looseversions(input), expected)
+ """Test sort_looseversions function."""
+ # Test twice: With the standard distutils LooseVersion (when available) and with our class
+ # Note that our class directly allows sorting but should also work with sort_loosversions
+ for use_distutils in (True, False):
+ if use_distutils:
+ try:
+ from distutils.version import LooseVersion as version_class
+ except ImportError:
+ continue
+ else:
+ version_class = LooseVersion
+
+ ver1 = version_class('1.2.3')
+ ver2 = version_class('4.5.6')
+ ver3 = version_class('1.2.3dev')
+ ver4 = version_class('system')
+ ver5 = version_class('rc3')
+ ver6 = version_class('v1802')
+
+ # some versions are included multiple times on purpose,
+ # to also test comparison between equal LooseVersion instances
+ input = [ver3, ver5, ver1, ver2, ver4, ver6, ver3, ver4, ver1]
+ expected = [ver1, ver1, ver3, ver3, ver2, ver5, ver4, ver4, ver6]
+ self.assertEqual(sort_looseversions(input), expected)
+ if not use_distutils:
+ self.assertEqual(sorted(input), expected)
+
+ # also test on list of tuples consisting of a LooseVersion instance + a string
+ # (as in the list_software_* functions)
+ suff1 = ''
+ suff2 = '-foo'
+ suff3 = '-bar'
+ input = [(ver3, suff1), (ver5, suff3), (ver1, suff2), (ver2, suff3), (ver4, suff1),
+ (ver6, suff2), (ver3, suff3), (ver4, suff3), (ver1, suff1)]
+ expected = [(ver1, suff1), (ver1, suff2), (ver3, suff1), (ver3, suff3), (ver2, suff3),
+ (ver5, suff3), (ver4, suff1), (ver4, suff3), (ver6, suff2)]
+ self.assertEqual(sort_looseversions(input), expected)
+ if not use_distutils:
+ self.assertEqual(sorted(input), expected)
 
  def test_cuda_compute_capabilities(self):
  """Test --cuda-compute-capabilities configuration option."""