use setuptools_scm

bnavigator · bnavigator · commit 7dab9f6a85fc · 2022-07-09T17:08:14.000+02:00
diff --git a/.coveragerc b/.coveragerc
@@ -2,7 +2,6 @@
 source = slycot
 omit = 
   */tests/*
-  */version.py
 
 
 # please do not add any sections after this block
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,7 +6,7 @@ if (CMAKE_VERSION VERSION_GREATER "3.11.99")
   cmake_policy(SET CMP0074 NEW)
 endif()
 
-project(slycot VERSION ${SLYCOT_VERSION} LANGUAGES NONE)
+project(slycot LANGUAGES NONE)
 
 enable_language(C)
 enable_language(Fortran)
@@ -22,6 +22,5 @@ message(STATUS "NumPy included from: ${NumPy_INCLUDE_DIR}")
 message(STATUS "F2PY included from: ${F2PY_INCLUDE_DIR}")
 message(STATUS "LAPACK: ${LAPACK_LIBRARIES}")
 message(STATUS "BLAS: ${BLAS_LIBRARIES}")
-message(STATUS "Slycot version: ${SLYCOT_VERSION}")
 
 add_subdirectory(slycot)
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -9,7 +9,6 @@ include conda-recipe/*
 include slycot/CMakeLists.txt
 include slycot/tests/CMakeLists.txt
 include slycot/*.py
-include slycot/version.py.in
 include slycot/src/*.f
 include slycot/tests/*.py
 graft slycot/src/SLICOT-Reference
diff --git a/conda-recipe/meta.yaml b/conda-recipe/meta.yaml
@@ -27,14 +27,16 @@ requirements:
     - libcblas * *netlib
     - liblapack * *netlib
     - python
-    - numpy!=1.23.0
+    - numpy !=1.23.0
     - pip
     - scikit-build >=0.14.1
+    - setuptools_scm >=6.3    
 
   run:
     - python {{ PY_VER }}
     - {{ pin_compatible('numpy') }}
     - libflang  # [win]
+    - importlib_metadata  # [py<38]
 
 test:
   requires:
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,16 @@
 [build-system]
 requires = [
     "setuptools",
+    "setuptools_scm>=6.3",
     "wheel",
     "scikit-build>=0.14.1",
     "cmake",
-    "numpy!=1.23.0"]
+    "numpy!=1.23.0",
+    "importlib-metadata; python_version < '3.8'"]
 build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+
+[tool.pytest.ini_options]
+# run the tests with compiled and installed package
+addopts = "--pyargs slycot"
diff --git a/setup.cfg.in b/setup.cfg.in
diff --git a/setup.py b/setup.py
@@ -12,17 +12,18 @@
 import subprocess
 import re
 import platform
-try:
-    import configparser
-except ImportError:
-    import ConfigParser as configparser
 
 try:
     from skbuild import setup
     from skbuild.command.sdist import sdist
 except ImportError:
     raise ImportError('scikit-build must be installed before running setup.py')
 
+try:
+    from setuptools_scm import get_version
+except ImportError:
+    raise ImportError('setuptools_scm must be installed before running setup.py')
+
 DOCLINES = __doc__.split("\n")
 
 CLASSIFIERS = """\
@@ -46,144 +47,13 @@
 Operating System :: MacOS
 """
 
-# defaults
-ISRELEASED = True
-# assume a version set by conda, next update with git,
-# otherwise count on default
-VERSION = 'Unknown'
-
-
-class GitError(RuntimeError):
-    """Exception for git errors occuring in in git_version"""
-    pass
-
-
-def git_version(srcdir=None):
-    """Return the git version, revision and cycle
-
-    Uses rev-parse to get the revision tag to get the version number from the
-    latest tag and detects (approximate) revision cycles
-
-    """
-    def _minimal_ext_cmd(cmd, srcdir):
-        # construct minimal environment
-        env = {}
-        for k in ['SYSTEMROOT', 'PATH']:
-            v = os.environ.get(k)
-            if v is not None:
-                env[k] = v
-        # LANGUAGE is used on win32
-        env['LANGUAGE'] = 'C'
-        env['LANG'] = 'C'
-        env['LC_ALL'] = 'C'
-        proc = subprocess.Popen(
-            cmd,
-            cwd=srcdir,
-            stdout=subprocess.PIPE,
-            stderr=subprocess.PIPE,
-            env=env)
-        out, err = proc.communicate()
-        if proc.returncode:
-            errmsg = err.decode('ascii', errors='ignore').strip()
-            raise GitError("git err; return code %d, error message:\n  '%s'"
-                           % (proc.returncode, errmsg))
-        return out
-
-    try:
-        GIT_VERSION = VERSION
-        GIT_REVISION = 'Unknown'
-        GIT_CYCLE = 0
-        out = _minimal_ext_cmd(['git', 'rev-parse', 'HEAD'], srcdir)
-        GIT_REVISION = out.strip().decode('ascii')
-        out = _minimal_ext_cmd(['git', 'tag'], srcdir)
-        GIT_VERSION = out.strip().decode('ascii').split('\n')[-1][1:]
-        out = _minimal_ext_cmd(['git', 'describe', '--tags',
-                                '--long', '--always'], srcdir)
-        try:
-            # don't get a good description with shallow clones
-            GIT_CYCLE = out.strip().decode('ascii').split('-')[1]
-        except IndexError:
-            pass
-    except OSError:
-        pass
-
-    return GIT_VERSION, GIT_REVISION, GIT_CYCLE
-
-# BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
-# update it when the contents of directories change.
-if os.path.exists('MANIFEST'):
-    os.remove('MANIFEST')
-
 # This is a bit hackish: we are setting a global variable so that the main
 # slycot __init__ can detect if it is being loaded by the setup routine, to
 # avoid attempting to load components that aren't built yet.  While ugly, it's
 # a lot more robust than what was previously being used.
 builtins.__SLYCOT_SETUP__ = True
 
 
-def rewrite_setup_cfg(version, gitrevision, release):
-    toreplace = dict(locals())
-    data = ''.join(open('setup.cfg.in', 'r').readlines()).split('@')
-    for k, v in toreplace.items():
-        idx = data.index(k)
-        data[idx] = v
-    cfg = open('setup.cfg', 'w')
-    cfg.write(''.join(data))
-    cfg.close()
-
-
-def get_version_info(srcdir=None):
-    global ISRELEASED
-    GIT_CYCLE = 0
-
-    # Adding the git rev number needs to be done inside write_version_py(),
-    # otherwise the import of slycot.version messes up
-    # the build under Python 3.
-    if os.environ.get('CONDA_BUILD', False):
-        FULLVERSION = os.environ.get('PKG_VERSION', '???')
-        GIT_REVISION = os.environ.get('GIT_DESCRIBE_HASH', '')
-        ISRELEASED = True
-        rewrite_setup_cfg(FULLVERSION, GIT_REVISION, 'yes')
-    elif os.path.exists('.git'):
-        FULLVERSION, GIT_REVISION, GIT_CYCLE = git_version(srcdir)
-        ISRELEASED = (GIT_CYCLE == 0)
-        rewrite_setup_cfg(FULLVERSION, GIT_REVISION,
-                          (ISRELEASED and 'yes') or 'no')
-    elif os.path.exists('setup.cfg'):
-        # valid distribution
-        setupcfg = configparser.ConfigParser(allow_no_value=True)
-        setupcfg.read('setup.cfg')
-
-        FULLVERSION = setupcfg.get(section='metadata', option='version')
-
-        if FULLVERSION is None:
-            FULLVERSION = "Unknown"
-
-        GIT_REVISION = setupcfg.get(section='metadata', option='gitrevision')
-
-        if GIT_REVISION is None:
-            GIT_REVISION = ""
-
-        return FULLVERSION, GIT_REVISION
-    else:
-
-        # try to find a version number from the dir name
-        dname = os.getcwd().split(os.sep)[-1]
-
-        m = re.search(r'[0-9.]+', dname)
-        if m:
-            FULLVERSION = m.group()
-            GIT_REVISION = ''
-
-        else:
-            FULLVERSION = VERSION
-            GIT_REVISION = "Unknown"
-
-    if not ISRELEASED:
-        FULLVERSION += '.' + str(GIT_CYCLE)
-
-    return FULLVERSION, GIT_REVISION
-
 def check_submodules():
     """ verify that the submodules are checked out and clean
         use `git submodule update --init`; on failure
@@ -216,14 +86,12 @@ def setup_package():
     src_path = os.path.dirname(os.path.abspath(__file__))
     sys.path.insert(0, src_path)
 
-    # Rewrite the version file everytime
-    VERSION, gitrevision = get_version_info(src_path)
 
     metadata = dict(
         name='slycot',
         packages=['slycot', 'slycot.tests'],
         cmake_languages=('C', 'Fortran'),
-        version=VERSION,
+        use_scm_version=True,
         maintainer="Slycot developers",
         maintainer_email="python-control-discuss@lists.sourceforge.net",
         description=DOCLINES[0],
@@ -234,20 +102,16 @@ def setup_package():
         classifiers=[_f for _f in CLASSIFIERS.split('\n') if _f],
         platforms=["Windows", "Linux", "Solaris", "Mac OS-X", "Unix"],
         cmdclass={"sdist": sdist_checked},
-        cmake_args=['-DSLYCOT_VERSION:STRING=' + VERSION,
-                    '-DGIT_REVISION:STRING=' + gitrevision,
-                    '-DISRELEASE:STRING=' + str(ISRELEASED),
-                    '-DFULL_VERSION=' + VERSION + '.git' + gitrevision[:7]],
         zip_safe=False,
-        install_requires=['numpy'],
+        install_requires=["numpy",
+                          "importlib-metadata; python_version < '3.8'"],
         python_requires=">=3.7"
     )
 
     try:
         setup(**metadata)
     finally:
         del sys.path[0]
-    return
 
 
 if __name__ == '__main__':
diff --git a/slycot/CMakeLists.txt b/slycot/CMakeLists.txt
@@ -630,13 +630,11 @@ set(F2PYSOURCE_DEPS
   src/transform.pyf src/synthesis.pyf
   src/_helper.pyf)
 
-configure_file(version.py.in version.py @ONLY)
-
 set(PYSOURCE
 
   __init__.py  examples.py exceptions.py
   analysis.py math.py synthesis.py transform.py
-  ${CMAKE_CURRENT_BINARY_DIR}/version.py)
+)
 
 set(SLYCOT_MODULE "_wrapper")
 
diff --git a/slycot/__init__.py b/slycot/__init__.py
@@ -45,8 +45,11 @@
     from .transform import tf01md, tf01rd
     from .transform import td04ad, tb01pd
 
-    # Version information
-    from .version import version as __version__
+    try:
+        from importlib.metadata import version
+    except ImportError:
+        from importlib_metadata import version
+    __version__ = version("slycot")
 
 
 def test():
diff --git a/slycot/version.py.in b/slycot/version.py.in
