Use static versioning over setuptools_scm

Author: gselzer

.gitignore

@@ -9,9 +9,6 @@
 /.eggs/
 *egg-info/
 
-# setuptools_scm
-/src/*/_version.py
-
 # Vi
 *.swp
 

dev-environment.yml

@@ -27,7 +27,7 @@ dependencies:
   - flake8
   - pytest
   - pytest-cov
-  - setuptools-scm >= 6.2
+  - toml
   # Project from source
   - pip
   - pip:

pyproject.toml

@@ -4,6 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scyjava"
+version = "1.5.2.dev0"
 authors = [
     {name = "Curtis Rueden", email = "ctrueden@wisc.edu"},
     {name = "Philipp Hanslovsky"},
@@ -38,8 +39,6 @@ dependencies = [
     "jpype1 >= 1.3.0",
     "jgo",
 ]
-dynamic = ["version"]
-
 
 [project.urls]
 Homepage = "https://github.com/scijava/scyjava"
@@ -58,7 +57,7 @@ dev = [
     "pytest-cov",
     "numpy",
     "pandas",
-    "setuptools-scm >= 6.2",
+    "toml",
 ]
 
 [tool.setuptools]
@@ -69,5 +68,3 @@ include-package-data = false
 [tool.setuptools.packages.find]
 where = ["src"]
 namespaces = false
-
-[tool.setuptools_scm]

src/scyjava/__init__.py

@@ -25,9 +25,14 @@
     JLong,
     JShort,
 )
+from scyjava._version import _find_version
 
 import scyjava.config
 
+
+__version__ = _find_version()
+
+
 _logger = logging.getLogger(__name__)
 
 # Set of module properties
@@ -65,33 +70,6 @@ def __getattr__(name):
     raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
 
 
-@constant
-def ___version__():
-    # First pass: use the version output by setuptools_scm
-    try:
-        import scyjava.version
-
-        return scyjava.version.version
-    except ImportError:
-        pass
-    # Second pass: use importlib.metadata
-    try:
-        from importlib.metadata import PackageNotFoundError, version
-
-        return version("scyjava")
-    except ImportError or PackageNotFoundError:
-        pass
-    # Third pass: use pkg_resources
-    try:
-        from pkg_resources import get_distribution
-
-        return get_distribution("scyjava").version
-    except ImportError:
-        pass
-    # Fourth pass: Give up
-    return "Cannot determine version! Ensure pkg_resources is installed!"
-
-
 # -- JVM setup --
 
 _startup_callbacks = []

src/scyjava/_version.py

@@ -0,0 +1,16 @@
+from importlib.util import find_spec
+
+
+def _find_version():
+    # First pass: use importlib.metadata
+    if find_spec("importlib.metadata"):
+        from importlib.metadata import version
+
+        return version("scyjava")
+
+    if find_spec("pkg_resources"):
+        from pkg_resources import get_distribution
+
+        return get_distribution("scyjava").version
+    # Fourth pass: Give up
+    return "Cannot determine version! Ensure pkg_resources is installed!"

tests/test_version.py

@@ -1,37 +1,25 @@
-import os
 import sys
+import toml
 
+from pathlib import Path
 import pytest
-
-setuptools_file = os.path.join(os.getcwd(), "src", "scyjava", "_version.py")
+import scyjava
+from scyjava._version import _find_version
 
 
 def _scyjava_version():
     """
     Get ScyJava's version.
     """
-    import scyjava
-
-    # It's important that we clear the cache here,
-    # so that we can test different behaviors.
-    scyjava.___version__.cache_clear()
-    # Get the version
-    return scyjava.__version__
-
+    pyproject = toml.load(Path(__file__).parents[1] / "pyproject.toml")
+    return pyproject["project"]["version"]
 
-def test_version_file():
-    """Ensures that, ideally, the version from setuptools_scm is used"""
-    # Get the version from setuptools_scm
-    from setuptools_scm import get_version
 
-    setuptools_version = get_version(write_to="src/scyjava/_version.py")
-    # Ensure that the version was written to file
-    assert os.path.isfile(setuptools_file)
-    # Ensure that scyjava.__version__ matches this.
-    assert _scyjava_version() == setuptools_version
-    # Cleanup - remove file
-    os.remove(setuptools_file)
-    assert not os.path.isfile(setuptools_file)
+def test_version_dunder():
+    """
+    Ensures that the dunder variable matches _scyjava_version
+    """
+    assert scyjava.__version__ == _scyjava_version()
 
 
 @pytest.mark.skipif(sys.version_info < (3, 8), reason="Requires Python >= 3.8")
@@ -43,9 +31,8 @@ def test_version_importlib():
     # Remove scyjava.version
     sys.modules["scyjava.version"] = None
     # Ensure scyjava.__version__ matches importlib.metadata.version()
-    from importlib.metadata import version
 
-    assert _scyjava_version() == version("scyjava")
+    assert _scyjava_version() == _find_version()
 
 
 @pytest.mark.skipif(
@@ -57,30 +44,25 @@ def test_version_pkg_resources():
     importlib.metadata unavailable,
     pkg_resources is used next.
     """
-    # Remove scyjava.version
-    sys.modules["scyjava.version"] = None
     # Remove importlib.metadata
     sys.modules["importlib.metadata"] = None
     # Ensure scyjava.__version__ matches
     # pkg_resources.get_distribution().version
-    from pkg_resources import get_distribution
 
-    assert _scyjava_version() == get_distribution("scyjava").version
+    assert _scyjava_version() == _find_version()
 
 
 def test_version_unvailable():
     """
     Ensures that no version is returned if none of these
     strategies works.
     """
-    # Remove scyjava.version
-    sys.modules["scyjava.version"] = None
     # Remove importlib.metadata
     sys.modules["importlib.metadata"] = None
     # Remove pkg_resources
     sys.modules["pkg_resources"] = None
     # Ensure scyjava.__version__ is an error message.
     assert (
-        _scyjava_version()
-        == "Cannot determine version! Ensure pkg_resources is installed!"
+        "Cannot determine version! Ensure pkg_resources is installed!"
+        == _find_version()
     )