vcs-versioning 2.1.1__tar.gz → 2.1.2__tar.gz

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!-- towncrier release notes start -->
 
+## 2.1.2 (2026-06-23)
+
+### Fixed
+
+- Fix MetadataWorkdir crash when using custom `tag_regex` — stored tags are already parsed version strings and no longer re-parsed through the tag regex. ([#1439](https://github.com/pypa/setuptools-scm/issues/1439))
+
 ## 2.1.1 (2026-06-23)
 
 ### Fixed

{vcs_versioning-2.1.1/src/vcs_versioning.egg-info → vcs_versioning-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vcs-versioning
-Version: 2.1.1
+Version: 2.1.2
 Summary: the blessed package to manage your versions by vcs metadata
 Author-email: Ronny Pfannschmidt <opensource@ronnypfannschmidt.de>
 License-Expression: MIT

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_backends/_git.py

@@ -238,11 +238,15 @@ class GitWorkdir(Workdir):
         return _git_parse_inner(config, self, pre_parse=effective_pre_parse)
 
     def list_tracked_files(self, path: Path | str = "") -> list[str]:
-        """List files tracked by git, honoring export-ignore."""
+        """List files tracked by git, honoring export-ignore.
+
+        When no path is given, scopes to ``project_root`` (not the VCS root)
+        so that monorepo projects only list their own files.
+        """
         from .._file_finders import scm_find_files
         from .._file_finders._git import _git_ls_files_and_dirs
 
-        base = str(path) if path else str(self.path)
+        base = str(path) if path else str(self.project_root)
         git_files, git_dirs = _git_ls_files_and_dirs(
             str(self.path), timeout=self._subprocess_timeout
         )

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_backends/_hg.py

@@ -293,7 +293,7 @@ class HgWorkdir(Workdir):
         from .._file_finders import scm_find_files
         from .._file_finders._hg import _hg_ls_files_and_dirs
 
-        base = str(path) if path else str(self.path)
+        base = str(path) if path else str(self.project_root)
         hg_files, hg_dirs = _hg_ls_files_and_dirs(
             str(self.path),
             hg_command=self._hg_command,

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_backends/_hg_git.py

@@ -95,7 +95,7 @@ class GitWorkdirHgClient(GitWorkdir, HgWorkdir):
         from .._file_finders import scm_find_files
         from .._file_finders._hg import _hg_ls_files_and_dirs
 
-        base = str(path) if path else str(self.path)
+        base = str(path) if path else str(self.project_root)
         hg_files, hg_dirs = _hg_ls_files_and_dirs(
             str(self.path),
             hg_command=self._hg_command,

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_backends/_jj.py

@@ -263,7 +263,7 @@ class JjWorkdir(Workdir):
         from .._file_finders import scm_find_files
         from .._file_finders._jj import _jj_ls_files_and_dirs
 
-        base = str(path) if path else str(self.path)
+        base = str(path) if path else str(self.project_root)
         jj_files, jj_dirs = _jj_ls_files_and_dirs(
             str(self.path), timeout=self._subprocess_timeout
         )

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_backends/_scm_workdir.py

@@ -5,7 +5,7 @@ from dataclasses import dataclass
 from dataclasses import field as dc_field
 from datetime import date, datetime, timezone
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, overload
 
 from .._scm_version import ScmVersion
 
@@ -16,6 +16,37 @@ if TYPE_CHECKING:
 log = logging.getLogger(__name__)
 
 
+class _ProjectRootDescriptor:
+    """Descriptor for ``project_root`` that defaults to ``path``.
+
+    Acts as default when no value has been set on the instance.
+    Stores explicitly assigned values in the instance ``__dict__``.
+    """
+
+    def __set_name__(self, owner: type, name: str) -> None:
+        self._name = name
+
+    @overload
+    def __get__(self, obj: None, objtype: type) -> _ProjectRootDescriptor: ...
+
+    @overload
+    def __get__(self, obj: ScmWorkdir, objtype: type | None = None) -> Path: ...
+
+    def __get__(
+        self, obj: ScmWorkdir | None, objtype: type | None = None
+    ) -> Path | _ProjectRootDescriptor:
+        if obj is None:
+            return self
+        value: Path | None = obj.__dict__.get(self._name)
+        if value is None:
+            return obj.path
+        return value
+
+    def __set__(self, obj: ScmWorkdir, value: Path | None) -> None:
+        if isinstance(value, Path):
+            obj.__dict__[self._name] = value
+
+
 def get_latest_file_mtime(changed_files: list[str], base_path: Path) -> date | None:
     """Get the latest modification time of the given files.
 
@@ -61,15 +92,11 @@ class ScmWorkdir:
     """
 
     path: Path
-    project_root: Path | None = dc_field(default=None)
+    project_root: Path = _ProjectRootDescriptor()  # type: ignore[assignment]
 
     _config: Configuration | None = dc_field(default=None, repr=False, compare=False)
     """Back-reference to the ``Configuration`` that discovered this workdir."""
 
-    def __post_init__(self) -> None:
-        if self.project_root is None:
-            self.project_root = self.path
-
     @property
     def _subprocess_timeout(self) -> int | None:
         """Subprocess timeout from ``config.env``.
@@ -95,7 +122,6 @@ class ScmWorkdir:
     @property
     def project_path(self) -> str:
         """Discovered relative path from VCS root to project directory."""
-        assert self.project_root is not None
         if self.path == self.project_root:
             return ""
         from .._paths import relative_project_path

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_fallback_workdir.py

@@ -34,6 +34,11 @@ class FallbackWorkdir:
     _config: Configuration | None = dc_field(default=None, repr=False, compare=False)
     """Back-reference to the ``Configuration`` that discovered this workdir."""
 
+    @property
+    def project_root(self) -> Path:
+        """Fallback workdirs always live at the project root."""
+        return self.path
+
     @property
     def config(self) -> Configuration:
         if self._config is None:
@@ -76,8 +81,20 @@ class MetadataWorkdir(FallbackWorkdir):
                     data.node_date,
                     self.metadata_dir,
                 )
+        # The tag in scm_version.json is already a parsed version string
+        # (e.g. "1.5.5"), not a raw VCS tag (e.g. "cuda-pathfinder-v1.5.5").
+        # Convert to version_cls so _parse_tag skips tag_regex matching.
+        try:
+            tag = self.config.version_cls(data.tag)
+        except Exception:
+            log.warning(
+                "cannot parse stored tag %r in metadata at %s",
+                data.tag,
+                self.metadata_dir,
+            )
+            return None
         return meta(
-            tag=data.tag,
+            tag=tag,
             distance=data.distance,
             node=data.node,
             dirty=data.dirty,

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_file_finders/_git.py

@@ -85,6 +85,9 @@ def _git_ls_files_and_dirs(
         log.error("listing git files failed - pretending there aren't any")
         return set(), set()
 
+    # Normalize toplevel to match what scm_find_files expects:
+    # absolute, symlinks resolved, case-normalized (normcase).
+    toplevel = norm_real(toplevel)
     git_files: set[str] = set()
     git_dirs: set[str] = {toplevel}
     for name in res.stdout.rstrip("\0").split("\0"):

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_get_version_impl.py

@@ -90,7 +90,7 @@ def _resolve_version(config: Configuration) -> ScmVersion | None:
     return None
 
 
-def _warn_if_tracked(target: Path, root: Path) -> None:
+def _warn_if_tracked(target: Path, root: Path, config: Configuration) -> None:
     """Warn when *target* is tracked in version control (#468).
 
     Writing a version file that is tracked makes ``git describe --dirty``
@@ -101,7 +101,7 @@ def _warn_if_tracked(target: Path, root: Path) -> None:
 
     for workdir_cls in (GitWorkdir, HgWorkdir):
         try:
-            wd = workdir_cls.from_potential_worktree(root)
+            wd = workdir_cls.from_potential_worktree(root, config)
         except Exception:
             continue
         if wd is not None and wd.is_file_tracked(target):
@@ -125,7 +125,7 @@ def write_version_files(
 
         write_to = Path(config.write_to)
         target = root / write_to if not write_to.is_absolute() else write_to
-        _warn_if_tracked(target, root)
+        _warn_if_tracked(target, root, config)
 
         dump_version(
             root=config.root,
@@ -142,7 +142,7 @@ def write_version_files(
         # todo: use a better name than fallback root
         assert config.relative_to is not None
         target = Path(config.relative_to).parent.joinpath(version_file)
-        _warn_if_tracked(target, root)
+        _warn_if_tracked(target, root, config)
 
         write_version_to_path(
             target,

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_legacy_parse.py

@@ -38,12 +38,7 @@ class LegacyParseWorkdir(ScmWorkdir):
     entry-point group.
     """
 
-    _parse_fn: ParseFunction | None = dc_field(default=None, repr=False)
-
-    def __post_init__(self) -> None:
-        super().__post_init__()
-        if self._parse_fn is None:
-            raise TypeError("LegacyParseWorkdir requires a _parse_fn")
+    parse_fn: ParseFunction = dc_field(repr=False, kw_only=True)
 
     def get_scm_version(self) -> ScmVersion | None:
         warnings.warn(
@@ -53,8 +48,7 @@ class LegacyParseWorkdir(ScmWorkdir):
             DeprecationWarning,
             stacklevel=2,
         )
-        assert self._parse_fn is not None
-        result = self._parse_fn(self.config.absolute_root, config=self.config)
+        result = self.parse_fn(self.config.absolute_root, config=self.config)
         if result is not None and not isinstance(result, ScmVersion):
             raise TypeError(
                 f"version parse result was {result!r}\n"

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_protocols.py

@@ -32,6 +32,16 @@ class WorkdirProtocol(Protocol):
     @property
     def path(self) -> Path: ...
 
+    @property
+    def project_root(self) -> Path:
+        """The project directory (where pyproject.toml lives).
+
+        For SCM workdirs this may differ from ``path`` (the VCS root).
+        For fallback workdirs this is always equal to ``path``.
+        Guaranteed non-None after construction.
+        """
+        ...
+
     def get_scm_version(self) -> ScmVersion | None:
         """Raw version metadata before overrides / formatting."""
         ...
@@ -49,9 +59,6 @@ class WorkdirProtocol(Protocol):
 class ScmWorkdirProtocol(WorkdirProtocol, Protocol):
     """Live VCS checkout: adds monorepo / nested-project fields."""
 
-    @property
-    def project_root(self) -> Path: ...
-
     @property
     def project_path(self) -> str:
         """POSIX relative path from VCS root to project_root (empty when equal)."""

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_scm_version.py

@@ -347,20 +347,14 @@ class ScmVersion:
 
 def _parse_tag(
     tag: _Version | str, preformatted: bool, config: _config.Configuration
-) -> _Version:
+) -> _Version | None:
     if preformatted:
-        # For preformatted versions, tag should already be validated as a version object
-        # String validation is handled in meta function before calling this
         if isinstance(tag, str):
-            # This should not happen with enhanced meta, but kept for safety
             return _v.NonNormalizedVersion(tag)
         else:
-            # Already a version object (including test mocks), return as-is
             return tag
     elif not isinstance(tag, config.version_cls):
-        version = tag_to_version(tag, config)
-        assert version is not None
-        return version
+        return tag_to_version(tag, config)
     else:
         return tag
 
@@ -389,18 +383,20 @@ def meta(
     node_date: date | None = None,
     time: datetime | None = None,
 ) -> ScmVersion:
-    parsed_version: _Version
-    # Enhanced string validation for preformatted versions
+    parsed_version: _Version | None
     if preformatted and isinstance(tag, str):
-        # Validate PEP 440 compliance using NonNormalizedVersion
-        # Let validation errors bubble up to the caller
         parsed_version = _v.NonNormalizedVersion(tag)
     else:
-        # Use existing _parse_tag logic for non-preformatted or already validated inputs
         parsed_version = _parse_tag(tag, preformatted, config)
 
+    if parsed_version is None:
+        raise ValueError(
+            f"Can't parse version from tag {tag!r}"
+            f" (tag_regex={config.tag.regex.pattern!r},"
+            f" tag_prefix={config.tag.prefix!r})"
+        )
+
     log.info("version %s -> %s", tag, parsed_version)
-    assert parsed_version is not None, f"Can't parse version {tag}"
 
     kwargs: _ScmVersionKwargs = {
         "distance": distance,

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/src/vcs_versioning/_worktree_discovery.py

@@ -84,7 +84,7 @@ def discover_workdir(config: Configuration) -> AnyWorkdir | None:
         return LegacyParseWorkdir(
             path=Path(config.absolute_root),
             _config=config,
-            _parse_fn=config.parse,
+            parse_fn=config.parse,
         )
 
     factories = _load_discovery_factories()

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2/src/vcs_versioning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vcs-versioning
-Version: 2.1.1
+Version: 2.1.2
 Summary: the blessed package to manage your versions by vcs metadata
 Author-email: Ronny Pfannschmidt <opensource@ronnypfannschmidt.de>
 License-Expression: MIT

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/testing_vcs/test_legacy_parse.py

@@ -34,8 +34,8 @@ class TestLegacyParseWorkdir:
         return Configuration.from_file(pyproject)
 
     def test_requires_parse_fn(self, tmp_path: Path) -> None:
-        with pytest.raises(TypeError, match="requires a _parse_fn"):
-            LegacyParseWorkdir(path=tmp_path)
+        with pytest.raises(TypeError, match="parse_fn"):
+            LegacyParseWorkdir(path=tmp_path)  # type: ignore[call-arg]
 
     def test_get_scm_version_emits_deprecation(self, tmp_path: Path) -> None:
         config = self._make_config(tmp_path)
@@ -43,7 +43,7 @@ class TestLegacyParseWorkdir:
         def fake_parse(root: _t.PathT, *, config: Configuration) -> ScmVersion | None:
             return ScmVersion(tag=Version("1.0.0"), config=config)
 
-        wd = LegacyParseWorkdir(path=tmp_path, _parse_fn=fake_parse)
+        wd = LegacyParseWorkdir(path=tmp_path, parse_fn=fake_parse)
         wd._config = config
 
         with warnings.catch_warnings(record=True) as w:
@@ -62,7 +62,7 @@ class TestLegacyParseWorkdir:
         def fake_parse(root: _t.PathT, *, config: Configuration) -> ScmVersion | None:
             return None
 
-        wd = LegacyParseWorkdir(path=tmp_path, _parse_fn=fake_parse)
+        wd = LegacyParseWorkdir(path=tmp_path, parse_fn=fake_parse)
         wd._config = config
 
         with warnings.catch_warnings(record=True):
@@ -75,7 +75,7 @@ class TestLegacyParseWorkdir:
         def bad_parse(root: _t.PathT, *, config: Configuration) -> ScmVersion | None:
             return "not-a-version"  # type: ignore[return-value]
 
-        wd = LegacyParseWorkdir(path=tmp_path, _parse_fn=bad_parse)
+        wd = LegacyParseWorkdir(path=tmp_path, parse_fn=bad_parse)
         wd._config = config
 
         with warnings.catch_warnings(record=True):

{vcs_versioning-2.1.1 → vcs_versioning-2.1.2}/testing_vcs/test_workdir_discovery.py

@@ -86,6 +86,48 @@ class TestDiscoverWorkdirGit:
         assert isinstance(result, ScmWorkdir)
         assert result.path == tmp_path
 
+    @pytest.mark.issue(1440)
+    def test_list_tracked_files_scoped_to_project_root(self, tmp_path: Path) -> None:
+        """In a monorepo, list_tracked_files() must only return files under project_root."""
+        # Resolve to real path to avoid Windows 8.3 short name mismatches
+        tmp_path = tmp_path.resolve()
+        _git_init(tmp_path)
+
+        # Create files in two sibling projects
+        proj_a = tmp_path / "project-a"
+        proj_b = tmp_path / "project-b"
+        proj_a.mkdir()
+        proj_b.mkdir()
+        (proj_a / "a.py").write_text("# a", encoding="utf-8")
+        (proj_b / "b.py").write_text("# b", encoding="utf-8")
+
+        subprocess.run(
+            ["git", "add", "."], cwd=tmp_path, check=True, capture_output=True
+        )
+        subprocess.run(
+            ["git", "commit", "-m", "add projects"],
+            cwd=tmp_path,
+            check=True,
+            capture_output=True,
+        )
+
+        # Discover from project-a with root=".." (monorepo pattern)
+        config = Configuration(
+            relative_to=str(proj_a / "pyproject.toml"),
+            root="..",
+        )
+        result = discover_workdir(config)
+        assert result is not None
+        assert isinstance(result, ScmWorkdir)
+        assert result.path == tmp_path
+        assert result.project_root == proj_a
+
+        files = list(result.list_tracked_files())
+        # Should only contain files under project-a, not project-b or repo root
+        assert any("a.py" in f for f in files), f"expected a.py in {files}"
+        assert not any("b.py" in f for f in files), f"unexpected b.py in {files}"
+        assert not any("dummy" in f for f in files), f"unexpected dummy in {files}"
+
 
 class TestDiscoverWorkdirFallback:
     def test_discovers_pkginfo(self, tmp_path: Path) -> None:
@@ -261,6 +303,27 @@ class TestMetadataWorkdir:
         files = wd.list_tracked_files()
         assert files == ["src/pkg/__init__.py"]
 
+    @pytest.mark.issue(1439)
+    def test_custom_tag_regex_does_not_break_metadata(self, tmp_path: Path) -> None:
+        """Stored tags are already parsed; custom tag_regex must not re-parse them."""
+        data = ScmVersionData(
+            tag="1.5.5",
+            distance=0,
+            node="gabc1234",
+            dirty=False,
+            branch="main",
+            node_date=None,
+        )
+        write_scm_version_data(tmp_path, data)
+
+        config = Configuration(
+            tag_regex=r"^cuda-pathfinder-(?P<version>v\d+\.\d+\.\d+(?:[ab]\d+)?)",
+        )
+        wd = MetadataWorkdir(path=tmp_path, metadata_dir=tmp_path, _config=config)
+        version = wd.get_scm_version()
+        assert version is not None
+        assert str(version.tag) == "1.5.5"
+
     def test_missing_metadata_returns_none(self, tmp_path: Path) -> None:
         config = Configuration()
         wd = MetadataWorkdir(path=tmp_path, metadata_dir=tmp_path, _config=config)