feat: include new version of hatch-vcs-footgun

adjust __init__.py, and pyproject.toml, include version.py, details see https://github.com/maresb/hatch-vcs-footgun-example

Author: dornech

pyproject.toml

@@ -68,8 +68,8 @@ local_scheme = "dirty-tag"
 [tool.hatch.build]
 packages = ["src/utils_COMobjects"]
 
-[tool.hatch.build.hooks.vcs]
-version-file = "src/utils_COMobjects/_version.py"
+# [tool.hatch.build.hooks.vcs]
+# version-file = "src/utils_COMobjects/_version.py"
 
 [tool.hatch.build.targets.sdist]
 artifacts = ["_version.py"]

src/utils_COMobjects/__init__.py

@@ -13,39 +13,30 @@
 """
 
 
+# ruff and mypy per file settings
+#
+# empty lines
+# ruff: noqa: E302, E303
+# naming conventions
+# ruff: noqa: N801, N802, N803, N806, N812, N813, N815, N816, N818, N999
 
-from importlib.metadata import PackageNotFoundError, version
+# fmt: off
 
+
+
+# version determination
+
+# original Hatchlor version
+# from importlib.metadata import PackageNotFoundError, version
 # try:
-#     __version__ = version('utils-COMobjects')
+#     __version__ = version('{{ cookiecutter.project_slug }}')
 # except PackageNotFoundError:  # pragma: no cover
 #     __version__ = 'unknown'
 # finally:
 #     del version, PackageNotFoundError
 
-# up-to-date version tag for modules installed in editable mode inspired by
-# https://github.com/maresb/hatch-vcs-footgun-example/blob/main/hatch_vcs_footgun_example/__init__.py
-# Define the variable '__version__':
-try:
-
-    # own developed alternative variant to hatch-vcs-footgun overcoming problem of ignored setuptools_scm settings
-    # from hatch-based pyproject.toml libraries
-    from hatch.cli import hatch
-    from click.testing import CliRunner
-    # determine version via hatch
-    __version__ = CliRunner().invoke(hatch, ["version"]).output.strip()
-
-except (ImportError, LookupError):
-    # As a fallback, use the version that is hard-coded in the file.
-    try:
-        from ._version import __version__  # noqa: F401
-    except ModuleNotFoundError:
-        # The user is probably trying to run this without having installed the
-        # package, so complain.
-        raise RuntimeError(
-            f"Package {__package__} is not correctly installed. Please install it with pip."
-        )
-
+# latest import requirement for hatch-vcs-footgun-example
+from utils_COMobjects.version import __version__
 
 
 import sys

src/utils_COMobjects/version.py

@@ -0,0 +1,55 @@
+"""Compute the version number and store it in the `__version__` variable.
+
+Based on <https://github.com/maresb/hatch-vcs-footgun-example>.
+"""
+
+
+# ruff and mypy per file settings
+# others
+# ruff: noqa: PLC0415
+
+# fmt: off
+
+
+def _get_hatch_version():
+    """Compute the most up-to-date version number in a development environment.
+
+    Returns `None` if Hatchling is not installed, e.g. in a production environment.
+
+    For more details, see <https://github.com/maresb/hatch-vcs-footgun-example/>.
+    """
+    import os
+
+    try:
+        from hatchling.metadata.core import ProjectMetadata
+        from hatchling.plugin.manager import PluginManager
+        from hatchling.utils.fs import locate_file
+    except ImportError:
+        # Hatchling is not installed, so probably we are not in a development environment.
+        return None
+
+    pyproject_toml = locate_file(__file__, "pyproject.toml")
+    if pyproject_toml is None:
+        err_msg = "pyproject.toml not found although hatchling is installed"
+        raise RuntimeError(err_msg)
+    root = os.path.dirname(pyproject_toml)
+    metadata = ProjectMetadata(root=root, plugin_manager=PluginManager())
+    # Version can be either statically set in pyproject.toml or computed dynamically:
+    return metadata.core.version or metadata.hatch.version.cached
+
+
+def _get_importlib_metadata_version():
+    """Compute the version number using importlib.metadata.
+
+    This is the official Pythonic way to get the version number of an installed
+    package. However, it is only updated when a package is installed. Thus, if a
+    package is installed in editable mode, and a different version is checked out,
+    then the version number will not be updated.
+    """
+    from importlib.metadata import version
+
+    __version__ = version(__package__)
+    return __version__
+
+
+__version__ = _get_hatch_version() or _get_importlib_metadata_version()