RF: Improve fallback version check, require PyPA packaging module

Author: effigies

nibabel/pkg_info.py

@@ -1,20 +1,10 @@
 import sys
-import re
-from distutils.version import StrictVersion
+from packaging.version import Version
 from . import _version
 
 __version__ = _version.get_versions()['version']
 
 
-def _parse_version(version_str):
-    """ Parse version string `version_str` in our format
-    """
-    match = re.match(r'([0-9.]*\d)(.*)', version_str)
-    if match is None:
-        raise ValueError('Invalid version ' + version_str)
-    return match.groups()
-
-
 def _cmp(a, b):
     """ Implementation of ``cmp`` for Python 3
     """
@@ -27,6 +17,8 @@ def cmp_pkg_version(version_str, pkg_version_str=__version__):
     To be valid, a version must have a numerical major version followed by a
     dot, followed by a numerical minor version.  It may optionally be followed
     by a dot and a numerical micro version, and / or by an "extra" string.
+    This comparator follows PEP 440 conventions for determining pre- and post-
+    releases.
     *Any* extra string labels the version as pre-release, so `1.2.0somestring`
     compares as prior to (pre-release for) `1.2.0`, where `somestring` can be
     any string.
@@ -50,15 +42,10 @@ def cmp_pkg_version(version_str, pkg_version_str=__version__):
     1
     >>> cmp_pkg_version('1.2.0dev', '1.2.0')
     -1
+    >>> cmp_pkg_version('1.2.0.post1', '1.2.0')
+    1
     """
-    version, extra = _parse_version(version_str)
-    pkg_version, pkg_extra = _parse_version(pkg_version_str)
-    if version != pkg_version:
-        return _cmp(StrictVersion(version), StrictVersion(pkg_version))
-    return (0 if extra == pkg_extra
-            else 1 if extra == ''
-            else -1 if pkg_extra == ''
-            else _cmp(extra, pkg_extra))
+    return _cmp(Version(version_str), Version(pkg_version_str))
 
 
 def pkg_commit_hash(pkg_path=None):

nibabel/tests/test_pkg_info.py

@@ -1,6 +1,8 @@
 """ Testing package info
 """
 
+from packaging.version import Version
+
 import nibabel as nib
 from nibabel.pkg_info import cmp_pkg_version
 from ..info import VERSION
@@ -30,12 +32,14 @@ def test_fallback_version():
     This should only fail if we fail to bump nibabel.info.VERSION immediately
     after release
     """
+    ver = Version(nib.__version__)
+    fallback = Version(VERSION)
     assert (
+        # Releases have no local information, archive matches versioneer
+        ver.local is None or
         # dev version should be larger than tag+commit-githash
-        cmp_pkg_version(VERSION) >= 0 or
-        # Allow VERSION bump to lag releases by one commit
-        VERSION == nib.__version__ + 'dev'), \
-        "nibabel.info.VERSION does not match current tag information"
+        fallback >= ver), \
+        "nibabel.info.VERSION does not match latest tag information"
 
 
 def test_cmp_pkg_version():
@@ -68,6 +72,10 @@ def test_cmp_pkg_version():
     assert_raises(ValueError, cmp_pkg_version, 'foo.2')
     assert_raises(ValueError, cmp_pkg_version, 'foo.2', '1.0')
     assert_raises(ValueError, cmp_pkg_version, '1.0', 'foo.2')
-    assert_raises(ValueError, cmp_pkg_version, '1')
     assert_raises(ValueError, cmp_pkg_version, 'foo')
 
+    # Check dev/RC sequence
+    seq = ('3.0.0dev', '3.0.0rc1', '3.0.0rc1.post.dev', '3.0.0rc2', '3.0.0rc2.post.dev', '3.0.0')
+    for stage1, stage2 in zip(seq[:-1], seq[1:]):
+        assert_equal(cmp_pkg_version(stage1, stage2), -1)
+        assert_equal(cmp_pkg_version(stage2, stage1), 1)

setup.cfg

@@ -31,6 +31,7 @@ provides =
 python_requires = >=3.5.1
 install_requires =
     numpy >=1.12
+    packaging
 tests_require =
     nose >=0.11
     pytest