Merge pull request #1325 from RonnyPfannschmidt/issue-1302-setuptools-build-bootstrap

build: setuptools + setup.py for vcs-versioning and setuptools-scm (#1302)

Author: RonnyPfannschmidt

.pre-commit-config.yaml

@@ -47,6 +47,8 @@ repos:
     rev: v1.19.1
     hooks:
     -   id: mypy
+        # Both are named setup.py → duplicate module "setup"; runtime path hacks are not modeled
+        exclude: ^(vcs-versioning|setuptools-scm)/setup\.py$
         args: [--strict]
         additional_dependencies:
             - types-setuptools

pyproject.toml

@@ -65,14 +65,11 @@ no_implicit_reexport = true
 # Workspace-specific paths
 mypy_path = "vcs-versioning/src:setuptools-scm/src"
 explicit_package_bases = true
-
-[[tool.mypy.overrides]]
-module = [
-  "vcs-versioning._own_version_of_vcs_versioning",
-  "setuptools-scm._own_version_helper",
+# setup.py scripts add src/ at runtime; duplicate module name "setup" across packages
+exclude = [
+  "^vcs-versioning/setup\\.py$",
+  "^setuptools-scm/setup\\.py$",
 ]
-# Version helper files use imports before they're installed
-ignore_errors = true
 
 [tool.uv]
 package = true
@@ -87,6 +84,10 @@ setuptools-scm = { workspace = true }
 [tool.ruff]
 lint.extend-select = ["UP", "I", "B"]
 
+[tool.ruff.lint.per-file-ignores]
+"vcs-versioning/setup.py" = ["E402"]
+"setuptools-scm/setup.py" = ["E402"]
+
 [tool.repo-review]
 ignore = [
     "PP002", # this is a uv workspace

setuptools-scm/_own_version_helper.py

@@ -0,0 +1 @@
+Anchor ``get_version`` in ``setup.py`` with ``relative_to`` and ``fallback_root`` so SCM fallbacks (e.g. ``PKG-INFO``) do not resolve against the wrong directory when the build cwd is the workspace or repo root.

setuptools-scm/changelog.d/1302.bugfix.md

@@ -1,7 +1,5 @@
-
-
 [build-system]
-build-backend = "_own_version_helper:build_meta"
+build-backend = "setuptools.build_meta"
 requires = [
   "setuptools>=77.0.3",
   "vcs-versioning>=1.0.0.dev0",
@@ -10,12 +8,8 @@ requires = [
   'tomli>=1; python_version < "3.11"',
   'typing-extensions; python_version < "3.11"',
 ]
-backend-path = [
-  ".",
-  "./src",
-]
-[tools.uv.sources]
-vcs-versioning= "../vcs-versioning"
+[tool.uv.sources]
+vcs-versioning = { workspace = true }
 [project]
 name = "setuptools-scm"
 description = "the blessed package to manage your versions by scm tags"
@@ -120,8 +114,8 @@ setuptools_scm = "setuptools_scm._integration.setuptools:infer_version"
 where = ["src"]
 namespaces = false
 
-[tool.setuptools.dynamic]
-version = { attr = "_own_version_helper.version"}
+[tool.setuptools.package-data]
+setuptools_scm = [".git_archival.txt"]
 
 [tool.setuptools_scm]
 root = ".."
@@ -148,7 +142,6 @@ lint.preview = true
 "**/src/setuptools_scm/hg.py" = ["PLC0414"]
 "**/src/setuptools_scm/hg_git.py" = ["PLC0414"]
 "**/src/setuptools_scm/fallbacks.py" = ["PLC0414"]
-"**/_own_version_helper.py" = ["PLC0414"]
 "**/src/setuptools_scm/_integration/pyproject_reading.py" = ["BLE001", "S112"]
 "**/testing_scm/conftest.py" = ["BLE001", "S110"]
 "**/testing_scm/test_main.py" = ["S102"]

setuptools-scm/pyproject.toml

@@ -0,0 +1,48 @@
+"""Build entry point: compute ``version`` here so it is not part of the installed package."""
+
+from __future__ import annotations
+
+import os
+import sys
+
+from pathlib import Path
+
+from setuptools import setup
+
+_root = Path(__file__).resolve().parent
+sys.path.insert(0, str(_root / "src"))
+
+from setuptools_scm import get_version
+from vcs_versioning._backends._git import make_describe_command
+
+
+def _package_version() -> str:
+    """Resolve version using this package's tree, not the process cwd.
+
+    ``root`` is the monorepo (``..`` relative to ``pyproject.toml``) for SCM
+    discovery. ``fallback_root`` is ``.`` (the package tree) so ``PKG-INFO``
+    fallbacks resolve under that directory when building from an sdist.
+
+    ``get_version`` defaults ``fallback_root`` to ``.``; PEP 517 builds often run
+    with cwd at the repo or workspace root, so fallbacks (e.g. ``PKG-INFO`` /
+    ``pyproject.toml`` entry-point matching) could pick the wrong directory.
+    """
+    local_scheme = (
+        "no-local-version"
+        if os.environ.get("SETUPTOOLS_SCM_NO_LOCAL")
+        else "node-and-date"
+    )
+    pyproject_toml = _root / "pyproject.toml"
+    return get_version(
+        root="..",
+        relative_to=str(pyproject_toml),
+        fallback_root=".",
+        version_scheme="guess-next-dev",
+        local_scheme=local_scheme,
+        tag_regex=r"^setuptools-scm-(?P<version>v?\d+(?:\.\d+){0,2}[^\+]*)(?:\+.*)?$",
+        scm={"git": {"describe_command": make_describe_command("setuptools-scm-*")}},
+    )
+
+
+if __name__ == "__main__":
+    setup(version=_package_version())

setuptools-scm/setup.py

@@ -0,0 +1 @@
+Build ``vcs-versioning`` with setuptools instead of hatchling to avoid a bootstrap cycle (hatchling → pluggy → setuptools-scm → vcs-versioning) for downstream packagers.

vcs-versioning/changelog.d/1302.misc.md

@@ -1,7 +1,12 @@
+# Build backend: setuptools (not hatchling) until the bootstrap cycle described in
+# https://github.com/pypa/setuptools-scm/issues/1302 is gone: hatchling → pluggy →
+# setuptools-scm → vcs-versioning → hatchling. Revisit switching back to hatchling
+# once hatch/hatchling no longer depend on pluggy (or pluggy no longer pulls
+# setuptools-scm into the vcs-versioning build graph).
 [build-system]
-build-backend = "hatchling.build"
+build-backend = "setuptools.build_meta"
 requires = [
-  "hatchling",
+  "setuptools>=77.0.3",
   "packaging>=20",
   'typing-extensions; python_version < "3.11"',
 ]
@@ -80,25 +85,12 @@ node-and-timestamp = "vcs_versioning._version_schemes:get_local_node_and_timesta
 "semver-pep440-release-branch" = "vcs_versioning._version_schemes:release_branch_semver_version"
 "towncrier-fragments" = "vcs_versioning._version_schemes._towncrier:version_from_fragments"
 
-[tool.hatch.version]
-source = "code"
-path = "_own_version_of_vcs_versioning.py"
-search-paths = ["src"]
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
 
-[tool.hatch.build.targets.wheel]
-packages = ["src/vcs_versioning"]
-
-[tool.hatch.envs.default]
-dependencies = [
-  "pytest",
-  "pytest-cov",
-]
-[tool.hatch.envs.default.scripts]
-cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=vcs_versioning --cov=tests {args}"
-no-cov = "cov --no-cov {args}"
-
-[[tool.hatch.envs.test.matrix]]
-python = [ "38", "39", "310", "311", "312", "313" ]
+[tool.setuptools.package-data]
+"vcs_versioning._cli" = ["git_archival_stable.txt", "git_archival_full.txt"]
 
 [tool.vcs-versioning]
 root = ".."

vcs-versioning/pyproject.toml

@@ -1,25 +1,24 @@
-"""
-Version helper for vcs-versioning package.
-
-This module allows vcs-versioning to use VCS metadata for its own version,
-with the tag prefix 'vcs-versioning-'.
-
-Used by hatchling's code version source.
-"""
+"""Build entry point: compute ``version`` here so it is not part of the installed package."""
 
 from __future__ import annotations
 
 import logging
 import os
+import sys
 from collections.abc import Callable
 from pathlib import Path
 
+from setuptools import setup
+
+_root = Path(__file__).resolve().parent
+sys.path.insert(0, str(_root / "src"))
+
 from vcs_versioning import Configuration
 from vcs_versioning import _types as _t
 from vcs_versioning._backends import _git as git
 from vcs_versioning._backends import _hg as hg
 from vcs_versioning._fallbacks import fallback_version, parse_pkginfo
-from vcs_versioning._get_version_impl import get_version
+from vcs_versioning._get_version_impl import get_version, resolved_fallback_root
 from vcs_versioning._version_schemes import (
     ScmVersion,
     get_local_node_and_date,
@@ -29,21 +28,23 @@
 
 log = logging.getLogger("vcs_versioning")
 
-# Try these parsers in order for vcs-versioning's own version
-try_parse: list[Callable[[_t.PathT, Configuration], ScmVersion | None]] = [
+_try_parse: list[Callable[[_t.PathT, Configuration], ScmVersion | None]] = [
     parse_pkginfo,
     git.parse,
     hg.parse,
     git.parse_archival,
     hg.parse_archival,
-    fallback_version,  # Last resort: use fallback_version from config
+    fallback_version,
 ]
 
 
-def parse(root: str, config: Configuration) -> ScmVersion | None:
-    for maybe_parse in try_parse:
+def _parse(root: str, config: Configuration) -> ScmVersion | None:
+    for maybe_parse in _try_parse:
         try:
-            parsed = maybe_parse(root, config)
+            parse_root = (
+                resolved_fallback_root(config) if maybe_parse is parse_pkginfo else root
+            )
+            parsed = maybe_parse(parse_root, config)
         except OSError as e:
             log.warning("parse with %s failed with: %s", maybe_parse, e)
         else:
@@ -52,26 +53,26 @@ def parse(root: str, config: Configuration) -> ScmVersion | None:
     return None
 
 
-def _get_version() -> str:
-    """Get version from VCS with vcs-versioning- tag prefix."""
-    # Use no-local-version if VCS_VERSIONING_NO_LOCAL is set (for CI uploads)
+def _package_version() -> str:
+    """Version from VCS with ``vcs-versioning-`` tag prefix.
+
+    ``root`` is the monorepo (``..`` relative to ``pyproject.toml``) for SCM
+    discovery. ``fallback_root`` is ``.`` (the package tree next to
+    ``pyproject.toml``) so ``PKG-INFO`` from an sdist is read from the right
+    place (see ``_parse`` / ``_pkginfo_root``).
+    """
     local_scheme = (
         get_no_local_node
         if os.environ.get("VCS_VERSIONING_NO_LOCAL")
         else get_local_node_and_date
     )
-
-    # Resolve repo root from this file's location so version detection works
-    # regardless of cwd (e.g. when uv build runs from workspace root).
-    _here = Path(__file__).resolve()
-    _repo_root = _here.parent.parent
-    _pyproject_path = _here.parent / "pyproject.toml"
+    _pyproject_path = _root / "pyproject.toml"
 
     return get_version(
-        root=str(_repo_root),
-        fallback_root=str(_here.parent),
+        root="..",
+        fallback_root=".",
         relative_to=str(_pyproject_path),
-        parse=parse,
+        parse=_parse,
         version_scheme=guess_next_dev_version,
         local_scheme=local_scheme,
         tag_regex=r"^vcs-versioning-(?P<version>v?\d+(?:\.\d+){0,2}[^\+]*)(?:\+.*)?$",
@@ -82,4 +83,5 @@ def _get_version() -> str:
     )
 
 
-__version__: str = _get_version()
+if __name__ == "__main__":
+    setup(version=_package_version())

…ioning/_own_version_of_vcs_versioning.py vcs-versioning/setup.pyvcs-versioning/_own_version_of_vcs_versioning.py renamed to vcs-versioning/setup.py vcs-versioning/_own_version_of_vcs_versioning.py renamed to vcs-versioning/setup.py

@@ -23,6 +23,14 @@
 log = logging.getLogger(__name__)
 
 
+def resolved_fallback_root(config: Configuration) -> str:
+    """Absolute path for *fallback_root* when it is relative to *relative_to*'s directory."""
+    rel = config.relative_to
+    if rel and not Path(config.fallback_root).is_absolute():
+        return str((Path(rel).resolve().parent / config.fallback_root).resolve())
+    return str(Path(config.fallback_root).resolve())
+
+
 def parse_scm_version(config: Configuration) -> ScmVersion | None:
     try:
         if config.parse is not None:
@@ -48,7 +56,7 @@ def parse_fallback_version(config: Configuration) -> ScmVersion | None:
     return _entrypoints.version_from_entrypoint(
         config,
         entrypoint="setuptools_scm.parse_scm_fallback",
-        root=config.fallback_root,
+        root=resolved_fallback_root(config),
     )