Inference of setuptools' own version from git history (without setuptools-scm)

.github/workflows/main.yml

@@ -70,6 +70,8 @@ jobs:
     timeout-minutes: 75
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Install build dependencies
         # Install dependencies for building packages on pre-release Pythons
         # jaraco/skeleton#161
@@ -182,6 +184,8 @@ jobs:
     timeout-minutes: 75
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Install Cygwin with Python
         uses: cygwin/cygwin-install-action@v4
         with:
@@ -243,6 +247,8 @@ jobs:
     timeout-minutes: 75
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Install OS-level dependencies
         run: |
           sudo apt-get update
@@ -268,6 +274,8 @@ jobs:
     timeout-minutes: 75
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Setup Python
         uses: actions/setup-python@v5
         with:

MANIFEST.in

@@ -16,6 +16,7 @@ include msvc-build-launcher.cmd
 include mypy.ini
 include pytest.ini
 include tox.ini
+include NEWS.rst
 include setuptools/tests/config/setupcfg_examples.txt
 include setuptools/config/*.schema.json
 global-exclude *.py[cod] __pycache__

newsfragments/4948.misc.rst

@@ -0,0 +1,4 @@
+Setuptools stopped using ``egg_info --tag-build --tag-date`` for its own build
+process. Instead version is now inferred from git tag history.
+To ensure the proper version is considered, please make sure to fetch the git tags.
+Local development tags are added to the latest version if the latest commit is not tagged.

pyproject.toml

@@ -10,7 +10,6 @@ backend-path = ["."]
 
 [project]
 name = "setuptools"
-version = "80.9.0"
 authors = [
 	{ name = "Python Packaging Authority", email = "[email protected]" },
 ]
@@ -31,6 +30,7 @@ license = "MIT"
 dependencies = [
 ]
 keywords = ["CPAN PyPI distutils eggs package management"]
+dynamic = ["version"]
 
 [project.urls]
 Source = "https://github.com/pypa/setuptools"

setup.py

@@ -1,10 +1,17 @@
 #!/usr/bin/env python
+from __future__ import annotations
 
 import os
+import re
+import subprocess
 import sys
 import textwrap
+import time
+from contextlib import suppress
+from itertools import starmap
 
 import setuptools
+from setuptools import _normalization
 from setuptools.command.install import install
 
 here = os.path.dirname(__file__)
@@ -26,6 +33,29 @@
     package_data.setdefault('setuptools.command', []).extend(['*.xml'])
 
 
+_VERSION_FALLBACK = [
+    ("PKG-INFO", r"^Version: (\d+\.\d+\.\d+.*)$", "{match[1]}"),  # sdist
+    ("NEWS.rst", r"^v(\d+\.\d+\.\d+)", "{match[1]}.dev+{timestamp}"),  # latest version
+]
+
+
+def _extract_version(file: str, pattern: str, fmt: str) -> str | None:
+    with suppress(FileNotFoundError), open(file, encoding="utf-8") as fp:
+        if match := re.search(pattern, fp.read(), re.M):
+            return fmt.format(match=match, timestamp=time.strftime("%Y%m%d"))
+    return None
+
+
+def _get_version() -> str:
+    cmd = ["git", "describe", "--abbrev", "--match", "v?[0-9]*", "--dirty"]
+    try:
+        version = subprocess.check_output(cmd, encoding="utf-8")
+        return _normalization.best_effort_version(version, "{safe}.dev+{sanitized}")
+    except subprocess.CalledProcessError:  # e.g.: git not installed or history missing
+        candidates = filter(None, starmap(_extract_version, _VERSION_FALLBACK))
+        return next(candidates, f"0.0.0.dev+{time.strftime('%Y%m%d')}")
+
+
 def pypi_link(pkg_filename):
     """
     Given the filename, including md5 fragment, construct the
@@ -76,13 +106,14 @@
         """
         Undo secondary effect of `extra_path` adding to `install_lib`
         """
         suffix = os.path.relpath(self.install_lib, self.install_libbase)
 
         if suffix.strip() == self._pth_contents.strip():
             self.install_lib = self.install_libbase
 
 
 setup_params = dict(
+    version=_get_version(),
     cmdclass={'install': install_with_pth},
     package_data=package_data,
 )

setuptools/_normalization.py

@@ -12,7 +12,7 @@
 _VALID_NAME = re.compile(r"^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$", re.I)
 _UNSAFE_NAME_CHARS = re.compile(r"[^A-Z0-9._-]+", re.I)
 _NON_ALPHANUMERIC = re.compile(r"[^A-Z0-9]+", re.I)
-_PEP440_FALLBACK = re.compile(r"^v?(?P<safe>(?:[0-9]+!)?[0-9]+(?:\.[0-9]+)*)", re.I)
+_PEP440_FALLBACK = re.compile(r"^(?P<safe>v?(?:[0-9]+!)?[0-9]+(?:\.[0-9]+)*)", re.I)
 
 
 def safe_identifier(name: str) -> str:
@@ -64,7 +64,10 @@ def safe_version(version: str) -> str:
         return str(packaging.version.Version(attempt))
 
 
-def best_effort_version(version: str) -> str:
+def best_effort_version(
+    version: str,
+    template: str = "{safe}.dev0+sanitized.{sanitized}",
+) -> str:
     """Convert an arbitrary string into a version-like string.
     Fallback when ``safe_version`` is not safe enough.
     >>> best_effort_version("v0.2 beta")
@@ -79,6 +82,10 @@ def best_effort_version(version: str) -> str:
     '0.dev0+sanitized'
     >>> best_effort_version("42.+?1")
     '42.dev0+sanitized.1'
+    >>> best_effort_version("v78.1.0-2-g3a3144f0d")
+    '78.1.0.dev0+sanitized.2.g3a3144f0d'
+    >>> best_effort_version("v80.9.0-18-gdf932b02e-dirty", "{safe}.dev+{sanitized}")
+    '80.9.0.dev0+18.gdf932b02e.dirty'
     """
     try:
         return safe_version(version)
@@ -92,8 +99,8 @@ def best_effort_version(version: str) -> str:
             safe = "0"
             rest = version
         safe_rest = _NON_ALPHANUMERIC.sub(".", rest).strip(".")
-        local = f"sanitized.{safe_rest}".strip(".")
-        return safe_version(f"{safe}.dev0+{local}")
+        fallback = template.format(safe=safe, sanitized=safe_rest).strip(".")
+        return safe_version(fallback)
 
 
 def safe_extra(extra: str) -> str:

setuptools/tests/test_setuptools.py

@@ -265,6 +265,15 @@ def test_findall_missing_symlink(tmpdir):
         assert found == []
 
 
+def test_setuptools_own_dists_infers_version(setuptools_sdist, setuptools_wheel):
+    # Sanity check
+    # Validates that `setup.py:_get_version` works as expected
+    assert "0.0.0" not in setuptools_sdist.name
+    # Validates that `setup.py:_get_version` guarantees the fallback
+    # code path is finding something in PKG-INFO:
+    assert "0.0.0" not in setuptools_wheel.name
+
+
 @pytest.mark.xfail(reason="unable to exclude tests; #4475 #3260")
 def test_its_own_wheel_does_not_contain_tests(setuptools_wheel):
     with ZipFile(setuptools_wheel) as zipfile:

tox.ini

@@ -63,11 +63,10 @@ description = assemble changelog and tag a release
 skip_install = True
 deps =
 	towncrier
-	bump2version
 	jaraco.develop >= 7.23
 pass_env = *
 commands =
-	python tools/finalize.py
+	python -m jaraco.develop.finalize
 
 [testenv:vendor]
 skip_install = True
@@ -102,8 +101,6 @@ setenv =
 	TWINE_USERNAME = {env:TWINE_USERNAME:__token__}
 commands =
 	python -c "import shutil; shutil.rmtree('dist', ignore_errors=True)"
-	# unset tag_build and tag_date pypa/setuptools#2500
-	python setup.py egg_info -Db "" saveopts
 	python -m build
 	python -m twine upload dist/*
 	python -m jaraco.develop.create-github-release