RF: Move all version play from info to pkg_info

Author: effigies

nibabel/__init__.py

@@ -9,7 +9,8 @@
 
 import os
 
-from .info import __version__, long_description as __doc__
+from .pkg_info import __version__
+from .info import long_description as __doc__
 __doc__ += """
 Quickstart
 ==========

nibabel/deprecated.py

@@ -4,7 +4,7 @@
 import warnings
 
 from .deprecator import Deprecator
-from .info import cmp_pkg_version
+from .pkg_info import cmp_pkg_version
 
 
 class ModuleProxy(object):

nibabel/info.py

@@ -1,73 +1,11 @@
-""" Define distribution parameters for nibabel, including package version
+""" Define long_description parameter
 
-This file contains defines parameters for nibabel that we use to fill settings
-in setup.py, the nibabel top-level docstring, and for building the docs.  In
-setup.py in particular, we exec this file, so it cannot import nibabel.
+This parameter is used to fill settings in setup.py, the nibabel top-level
+docstring, and in building the docs.
+We exec this file in several places, so it cannot import nibabel or use
+relative imports.
 """
 
-import re
-from distutils.version import StrictVersion
-
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions
-
-
-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
-    """
-    return (a > b) - (a < b)
-
-
-def cmp_pkg_version(version_str, pkg_version_str=__version__):
-    """ Compare `version_str` to current package 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.
-    *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.
-
-    Parameters
-    ----------
-    version_str : str
-        Version string to compare to current package version
-    pkg_version_str : str, optional
-        Version of our package.  Optional, set fom ``__version__`` by default.
-
-    Returns
-    -------
-    version_cmp : int
-        1 if `version_str` is a later version than `pkg_version_str`, 0 if
-        same, -1 if earlier.
-
-    Examples
-    --------
-    >>> cmp_pkg_version('1.2.1', '1.2.0')
-    1
-    >>> cmp_pkg_version('1.2.0dev', '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))
-
-
 # Note: this long_description is the canonical place to edit this text.
 # It also appears in README.rst, but it should get there by running
 # ``tools/refresh_readme.py`` which pulls in this version.
@@ -157,5 +95,3 @@ def cmp_pkg_version(version_str, pkg_version_str=__version__):
 .. _zenodo: https://zenodo.org
 .. _Digital Object Identifier: https://en.wikipedia.org/wiki/Digital_object_identifier
 """
-
-VERSION = __version__

nibabel/pkg_info.py

@@ -1,6 +1,65 @@
 import sys
+import re
+from distutils.version import StrictVersion
 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
+    """
+    return (a > b) - (a < b)
+
+
+def cmp_pkg_version(version_str, pkg_version_str=__version__):
+    """ Compare `version_str` to current package 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.
+    *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.
+
+    Parameters
+    ----------
+    version_str : str
+        Version string to compare to current package version
+    pkg_version_str : str, optional
+        Version of our package.  Optional, set fom ``__version__`` by default.
+
+    Returns
+    -------
+    version_cmp : int
+        1 if `version_str` is a later version than `pkg_version_str`, 0 if
+        same, -1 if earlier.
+
+    Examples
+    --------
+    >>> cmp_pkg_version('1.2.1', '1.2.0')
+    1
+    >>> cmp_pkg_version('1.2.0dev', '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))
+
 
 def pkg_commit_hash(pkg_path=None):
     ''' Get short form of commit hash

nibabel/tests/test_deprecated.py

@@ -3,7 +3,7 @@
 
 import warnings
 
-from nibabel import info
+from nibabel import pkg_info
 from nibabel.deprecated import (ModuleProxy, FutureWarningMixin,
                                 deprecate_with_version)
 
@@ -14,12 +14,12 @@
 
 def setup():
     # Hack nibabel version string
-    info.cmp_pkg_version.__defaults__ = ('2.0',)
+    pkg_info.cmp_pkg_version.__defaults__ = ('2.0',)
 
 
 def teardown():
     # Hack nibabel version string back again
-    info.cmp_pkg_version.__defaults__ = (info.__version__,)
+    pkg_info.cmp_pkg_version.__defaults__ = (pkg_info.__version__,)
 
 
 def test_module_proxy():
@@ -76,8 +76,8 @@ def func():
         return 99
 
     try:
-        info.cmp_pkg_version.__defaults__ = ('2.0dev',)
+        pkg_info.cmp_pkg_version.__defaults__ = ('2.0dev',)
         # No error, even though version is dev version of current
         assert_equal(func(), 99)
     finally:
-        info.cmp_pkg_version.__defaults__ = ('2.0',)
+        pkg_info.cmp_pkg_version.__defaults__ = ('2.0',)

nibabel/tests/test_info.py

@@ -2,6 +2,10 @@
 """
 
 import nibabel as nib
+from nibabel.pkg_info import cmp_pkg_version
+
+from nose.tools import (assert_raises, assert_equal)
+
 
 def test_pkg_info():
     """Simple smoke test
@@ -12,3 +16,43 @@ def test_pkg_info():
         - nibabel.pkg_info.pkg_commit_hash
     """
     info = nib.get_info()
+
+
+def test_version():
+    # Test info version is the same as our own version
+    assert_equal(nib.pkg_info.__version__, nib.__version__)
+
+
+def test_cmp_pkg_version():
+    # Test version comparator
+    assert_equal(cmp_pkg_version(nib.__version__), 0)
+    assert_equal(cmp_pkg_version('0.0'), -1)
+    assert_equal(cmp_pkg_version('1000.1000.1'), 1)
+    assert_equal(cmp_pkg_version(nib.__version__, nib.__version__), 0)
+    for test_ver, pkg_ver, exp_out in (('1.0', '1.0', 0),
+                                       ('1.0.0', '1.0', 0),
+                                       ('1.0', '1.0.0', 0),
+                                       ('1.1', '1.1', 0),
+                                       ('1.2', '1.1', 1),
+                                       ('1.1', '1.2', -1),
+                                       ('1.1.1', '1.1.1', 0),
+                                       ('1.1.2', '1.1.1', 1),
+                                       ('1.1.1', '1.1.2', -1),
+                                       ('1.1', '1.1dev', 1),
+                                       ('1.1dev', '1.1', -1),
+                                       ('1.2.1', '1.2.1rc1', 1),
+                                       ('1.2.1rc1', '1.2.1', -1),
+                                       ('1.2.1rc1', '1.2.1rc', 1),
+                                       ('1.2.1rc', '1.2.1rc1', -1),
+                                       ('1.2.1rc1', '1.2.1rc', 1),
+                                       ('1.2.1rc', '1.2.1rc1', -1),
+                                       ('1.2.1b', '1.2.1a', 1),
+                                       ('1.2.1a', '1.2.1b', -1),
+                                      ):
+        assert_equal(cmp_pkg_version(test_ver, pkg_ver), exp_out)
+    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')
+

nibabel/tests/test_pkg_info.py

@@ -1,4 +1,4 @@
-from ..info import cmp_pkg_version
+from ..pkg_info import cmp_pkg_version
 from ..testing import assert_raises, assert_false
 
 MODULE_SCHEDULE = [