vcs-versioning 2.2.0__tar.gz → 2.2.2__tar.gz

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 <!-- towncrier release notes start -->
 
+## 2.2.2 (2026-06-29)
+
+### Fixed
+
+- Add missing pytest-timeout to vcs-versioning test dependencies. ([#1461](https://github.com/pypa/setuptools-scm/issues/1461))
+
+## 2.2.1 (2026-06-29)
+
+### Fixed
+
+- Fix crash in `_warn_if_tracked` when the version file target is a relative path
+  by resolving it against the project root before comparison.
+  Also warn (instead of crashing) when the target resolves outside the project root. ([#1451](https://github.com/pypa/setuptools-scm/issues/1451))
+
 ## 2.2.0 (2026-06-24)
 
 ### Added
@@ -18,6 +32,7 @@
 ### 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))
+- Scope `list_tracked_files` to `project_root` in monorepo setups so that sdists no longer include files from sibling projects when `root=".."` is configured. ([#1440](https://github.com/pypa/setuptools-scm/issues/1440))
 
 ## 2.1.1 (2026-06-23)
 

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/MANIFEST.in

@@ -9,5 +9,6 @@ include *.toml
 include LICENSE.txt
 include README.md
 include CHANGELOG.md
+include uv.lock
 
 prune .cursor

{vcs_versioning-2.2.0/src/vcs_versioning.egg-info → vcs_versioning-2.2.2}/PKG-INFO

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

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/pyproject.toml

@@ -46,7 +46,7 @@ dependencies = [
 [dependency-groups]
 test = [
   "pytest",
-  "pytest-cov",
+  "pytest-timeout",
   "pytest-xdist",
 ]
 
@@ -105,27 +105,29 @@ tag_regex = "^vcs-versioning-(?P<version>v?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)
 fallback_version = "0.1.0"
 scm.git.describe_command = ["git", "describe", "--dirty", "--tags", "--long", "--match", "vcs-versioning-*"]
 
-[tool.coverage.run]
-branch = true
-parallel = true
-omit = [
-  "vcs_versioning/__about__.py",
-]
-
-[tool.coverage.report]
-exclude_lines = [
-  "no cov",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
-]
-
 [tool.pytest.ini_options]
+minversion = "8.2"
 testpaths = ["testing_vcs"]
 python_files = ["test_*.py"]
-addopts = ["-ra", "--strict-markers", "-p", "vcs_versioning.test_api"]
+xfail_strict = true
+addopts = ["-ra", "--strict-config", "--strict-markers", "-p", "vcs_versioning.test_api"]
+timeout = 300
+filterwarnings = [
+  "error",
+  "ignore:.*tool\\.setuptools_scm.*",
+  "ignore:.*git archive did not support describe output.*:UserWarning",
+  "ignore:.*unprocessed git archival found.*:UserWarning",
+  "ignore:.*without VcsEnvironment.*:DeprecationWarning",
+  "ignore:.*Passing config to workdir.*:DeprecationWarning",
+  "ignore:.*tag_regex.*is deprecated.*:DeprecationWarning",
+  "ignore:.*write_to_source.*:DeprecationWarning",
+  "ignore:.*relative_to is expected to be a file.*:UserWarning",
+]
+log_level = "debug"
+log_cli_level = "info"
 markers = [
-  "issue: marks tests related to specific issues",
-  "no_init: use setup_hg(init=False) for wd fixture - hg check without worktree",
+  "issue(id): reference to github issue",
+  "no_init: skip initializing the VCS repository in the test fixture",
   "skip_commit: allows to skip committing in the helpers",
 ]
 

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_backends/_hg.py

@@ -22,9 +22,6 @@ log = logging.getLogger(__name__)
 _HG_PSEUDO_TAGS = frozenset({"tip", "qbase", "qtip", "qparent"})
 
 
-_DEFAULT_HG_COMMAND = "hg"
-
-
 def _get_hg_command() -> str:
     """Read the hg command from resolved runtime settings.
 

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_compat.py

@@ -86,19 +86,6 @@ def strip_path_suffix(
     return full_path[: -len(suffix_path)]
 
 
-# Legacy aliases for backward compatibility during transition
-def assert_path_endswith(
-    full_path: str, suffix_path: str, error_msg: str | None = None
-) -> None:
-    """Legacy alias - use strip_path_suffix instead."""
-    strip_path_suffix(full_path, suffix_path, error_msg)
-
-
-def compute_path_prefix(full_path: str, suffix_path: str) -> str:
-    """Legacy alias - use strip_path_suffix instead."""
-    return strip_path_suffix(full_path, suffix_path)
-
-
 def norm_real(path: PathT) -> str:
     """Normalize and resolve a path (combining normcase and realpath).
 

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_config.py

@@ -203,9 +203,6 @@ class TagConfiguration:
         return cls(**tag_data)
 
 
-_SENTINEL_TAG_CONFIG = TagConfiguration()
-
-
 class _TagRegexDescriptor:
     """Data descriptor for deprecated top-level tag_regex field.
 

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_file_finders/__init__.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import logging
 import os
 import sys
-from collections.abc import Callable, Mapping
+from collections.abc import Callable, Iterable, Mapping
 
 if sys.version_info >= (3, 10):
     from typing import TypeGuard
@@ -140,4 +140,35 @@ def find_files(path: _t.PathT = "") -> list[str]:
     return []
 
 
-__all__ = ["scm_find_files", "is_toplevel_acceptable", "find_files"]
+def collect_files_and_dirs(
+    raw_names: Iterable[str], toplevel: str
+) -> tuple[set[str], set[str]]:
+    """Normalize VCS file listings into absolute ``(files, dirs)`` sets.
+
+    Each backend produces a list of relative paths from its own command
+    (``git ls-files``, ``hg files``, ``jj file list``).  This helper
+    normalizes case and separators, joins with *toplevel*, and collects
+    the directory ancestry — the same loop that was previously duplicated
+    in every backend.
+    """
+    files: set[str] = set()
+    dirs: set[str] = {toplevel}
+    for name in raw_names:
+        if not name:
+            continue
+        name = os.path.normcase(name).replace("/", os.path.sep)
+        fullname = os.path.join(toplevel, name)
+        files.add(fullname)
+        dirname = os.path.dirname(fullname)
+        while len(dirname) > len(toplevel) and dirname not in dirs:
+            dirs.add(dirname)
+            dirname = os.path.dirname(dirname)
+    return files, dirs
+
+
+__all__ = [
+    "scm_find_files",
+    "is_toplevel_acceptable",
+    "find_files",
+    "collect_files_and_dirs",
+]

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_file_finders/_git.py

@@ -10,7 +10,7 @@ from .._backends._git import run_git
 from .._compat import norm_real, strip_path_suffix
 from .._integration import data_from_mime
 from .._run_cmd import run as _run
-from . import is_toplevel_acceptable, scm_find_files
+from . import collect_files_and_dirs, is_toplevel_acceptable, scm_find_files
 
 log = logging.getLogger(__name__)
 
@@ -85,22 +85,8 @@ 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"):
-        if not name:
-            continue
-        name = os.path.normcase(name).replace("/", os.path.sep)
-        fullname = os.path.join(toplevel, name)
-        git_files.add(fullname)
-        dirname = os.path.dirname(fullname)
-        while len(dirname) > len(toplevel) and dirname not in git_dirs:
-            git_dirs.add(dirname)
-            dirname = os.path.dirname(dirname)
-    return git_files, git_dirs
+    return collect_files_and_dirs(res.stdout.rstrip("\0").split("\0"), toplevel)
 
 
 def git_find_files(path: _t.PathT = "") -> list[str]:

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_file_finders/_hg.py

@@ -8,7 +8,7 @@ from .. import _types as _t
 from .._backends._hg import run_hg
 from .._compat import norm_real
 from .._integration import data_from_mime
-from . import is_toplevel_acceptable, scm_find_files
+from . import collect_files_and_dirs, is_toplevel_acceptable, scm_find_files
 
 log = logging.getLogger(__name__)
 
@@ -34,20 +34,10 @@ def _hg_ls_files_and_dirs(
     hg_command: str | None = None,
     timeout: int | None = None,
 ) -> tuple[set[str], set[str]]:
-    hg_files: set[str] = set()
-    hg_dirs = {toplevel}
     res = run_hg(["files"], cwd=toplevel, hg_command=hg_command, timeout=timeout)
     if res.returncode:
         return set(), set()
-    for name in res.stdout.splitlines():
-        name = os.path.normcase(name).replace("/", os.path.sep)
-        fullname = os.path.join(toplevel, name)
-        hg_files.add(fullname)
-        dirname = os.path.dirname(fullname)
-        while len(dirname) > len(toplevel) and dirname not in hg_dirs:
-            hg_dirs.add(dirname)
-            dirname = os.path.dirname(dirname)
-    return hg_files, hg_dirs
+    return collect_files_and_dirs(res.stdout.splitlines(), toplevel)
 
 
 def hg_find_files(path: str = "") -> list[str]:

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_file_finders/_jj.py

@@ -13,7 +13,7 @@ import subprocess
 from .. import _types as _t
 from .._compat import norm_real
 from .._run_cmd import run as _run
-from . import is_toplevel_acceptable, scm_find_files
+from . import collect_files_and_dirs, is_toplevel_acceptable, scm_find_files
 
 log = logging.getLogger(__name__)
 
@@ -51,19 +51,7 @@ def _jj_ls_files_and_dirs(
         log.error("listing jj files failed - pretending there aren't any")
         return set(), set()
 
-    jj_files: set[str] = set()
-    jj_dirs: set[str] = {toplevel}
-    for name in res.stdout.strip().split("\n"):
-        if not name:
-            continue
-        name = os.path.normcase(name).replace("/", os.path.sep)
-        fullname = os.path.join(toplevel, name)
-        jj_files.add(fullname)
-        dirname = os.path.dirname(fullname)
-        while len(dirname) > len(toplevel) and dirname not in jj_dirs:
-            jj_dirs.add(dirname)
-            dirname = os.path.dirname(dirname)
-    return jj_files, jj_dirs
+    return collect_files_and_dirs(res.stdout.strip().split("\n"), toplevel)
 
 
 def jj_find_files(path: _t.PathT = "") -> list[str]:

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_get_version_impl.py

@@ -6,13 +6,18 @@ import re
 import warnings
 from pathlib import Path
 from re import Pattern
-from typing import Any, NoReturn
+from typing import TYPE_CHECKING, Any, NoReturn
 
 from . import _config
 from . import _types as _t
 from ._config import Configuration, TagConfiguration
 from ._environment import resolve_runtime_env
 
+if TYPE_CHECKING:
+    from ._config import ParseFunction
+    from ._environment import VcsEnvironment
+    from ._version_cls import Version as _VersionType
+
 # Backward-compat re-export used by vcs-versioning/setup.py
 from ._legacy_parse import (
     resolved_fallback_root as resolved_fallback_root,  # noqa: F401
@@ -90,15 +95,31 @@ def _resolve_version(config: Configuration) -> ScmVersion | None:
     return None
 
 
-def _warn_if_tracked(target: Path, root: Path, config: Configuration) -> None:
+def _warn_if_tracked(target: Path, root: Path, config: Configuration) -> bool:
     """Warn when *target* is tracked in version control (#468).
 
     Writing a version file that is tracked makes ``git describe --dirty``
     report a dirty tree on tag checkouts, causing wrong version numbers.
+
+    Returns False if target resolves outside root (caller should skip the write).
     """
     from ._backends._git import GitWorkdir
     from ._backends._hg import HgWorkdir
 
+    if not target.is_absolute():
+        target = root / target
+    resolved_target = target.resolve()
+    resolved_root = root.resolve()
+    try:
+        resolved_target.relative_to(resolved_root)
+    except ValueError:
+        # todo: emit as GitHub Actions warning via ::warning:: syntax
+        warnings.warn(
+            f"version file target {target} resolves outside of the project root {root}",
+            stacklevel=2,
+        )
+        return False
+
     for workdir_cls in (GitWorkdir, HgWorkdir):
         try:
             wd = workdir_cls.from_potential_worktree(root, config)
@@ -113,7 +134,8 @@ def _warn_if_tracked(target: Path, root: Path, config: Configuration) -> None:
                 " See https://github.com/pypa/setuptools-scm/issues/468",
                 stacklevel=3,
             )
-            return
+            return True
+    return True
 
 
 def write_version_files(
@@ -125,7 +147,8 @@ 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, config)
+        if not _warn_if_tracked(target, root, config):
+            return
 
         dump_version(
             root=config.root,
@@ -142,7 +165,8 @@ 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, config)
+        if not _warn_if_tracked(target, root, config):
+            return
 
         write_version_to_path(
             target,
@@ -252,14 +276,14 @@ def get_version(
     parentdir_prefix_version: str | None = None,
     fallback_version: str | None = None,
     fallback_root: _t.PathT = ".",
-    parse: Any | None = None,
+    parse: ParseFunction | None = None,
     git_describe_command: _t.CMD_TYPE | None = None,
     dist_name: str | None = None,
-    version_cls: Any | None = None,
+    version_cls: type[_VersionType] | str | None = None,
     normalize: bool = True,
     search_parent_directories: bool = False,
     scm: dict[str, Any] | None = None,
-    _env: Any | None = None,
+    _env: VcsEnvironment | None = None,
 ) -> str:
     """
     If supplied, relative_to should be a file from which root may

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_overrides.py

@@ -19,7 +19,7 @@ from packaging.utils import canonicalize_name
 
 from . import _config
 from . import _types as _t
-from ._scm_version import ScmVersion, meta  # noqa: F401 - for type checking
+from ._scm_version import ScmVersion, meta
 from ._version_cls import Version as _Version
 
 log = logging.getLogger(__name__)

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_run_cmd.py

@@ -14,8 +14,6 @@ from . import _types as _t
 
 log = logging.getLogger(__name__)
 
-_DEFAULT_SUBPROCESS_TIMEOUT = 40
-
 
 def _get_timeout(env: Mapping[str, str]) -> int:
     """Read subprocess timeout from resolved runtime settings.

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_scm_version.py

@@ -152,19 +152,15 @@ def tag_to_version(
     version_str = tag_dict["version"]
     log.debug("version pre parse %s", version_str)
 
-    # Try to create version from base version first
     try:
         version: _Version = config.version_cls(version_str)
         log.debug("version=%r", version)
     except Exception:
         warnings.warn(
-            f"tag {tag!r} will be stripped of its suffix {tag_dict.get('suffix', '')!r}",
+            f"tag {tag!r} version {version_str!r} could not be parsed",
             stacklevel=2,
         )
-        # Fall back to trying without any suffix
-        version = config.version_cls(version_str)
-        log.debug("version=%r", version)
-        return version
+        return None
 
     # If base version is valid, check if we can preserve the suffix
     if suffix := tag_dict.get("suffix", ""):

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning/_version_schemes/_standard.py

@@ -11,7 +11,6 @@ import re
 import warnings
 from datetime import date, datetime, timedelta, timezone
 from re import Match
-from typing import TYPE_CHECKING
 
 from .. import _modify_version
 from .._exceptions import DirtyWorkingTreeError
@@ -19,9 +18,6 @@ from .._scm_version import ScmVersion, _parse_version_tag
 from .._version_cls import Version as PkgVersion
 from ._common import SEMVER_LEN, SEMVER_MINOR, SEMVER_PATCH
 
-if TYPE_CHECKING:
-    pass
-
 log = logging.getLogger(__name__)
 
 

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2/src/vcs_versioning.egg-info}/PKG-INFO

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

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/src/vcs_versioning.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ MANIFEST.in
 README.md
 pyproject.toml
 setup.py
+uv.lock
 src/vcs_versioning/__init__.py
 src/vcs_versioning/__main__.py
 src/vcs_versioning/_compat.py

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/testing_vcs/test_file_finders.py

@@ -13,7 +13,7 @@ from vcs_versioning.test_api import WorkDir
 def inwd(
     request: pytest.FixtureRequest, wd: WorkDir, monkeypatch: pytest.MonkeyPatch
 ) -> WorkDir:
-    param: str = request.param  # type: ignore[attr-defined]
+    param: str = request.param
     if param == "git":
         wd.setup_git(monkeypatch)
     elif param == "hg":

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/testing_vcs/test_regressions.py

@@ -82,11 +82,7 @@ def test_write_to_absolute_path_passes_when_subdir_of_root(tmp_path: Path) -> No
     write_version_files(replace(c, write_to="VERSION.py"), "1.0", v)
     subdir = tmp_path / "subdir"
     subdir.mkdir()
-    with pytest.raises(
-        # todo: python version specific error list
-        ValueError,
-        match=r".*VERSION.py' .* .*subdir.*",
-    ):
+    with pytest.warns(UserWarning, match=r"resolves outside of"):
         write_version_files(replace(c, root=subdir), "1.0", v)
 
 
@@ -138,6 +134,40 @@ def test_no_warn_when_version_file_not_tracked(tmp_path: Path, scm: str) -> None
     assert tracked_warnings == []
 
 
+@pytest.mark.issue(1451)
+def test_warn_if_tracked_relative_target_no_crash(tmp_path: Path) -> None:
+    """_warn_if_tracked must not crash when target is relative and root is absolute."""
+    from vcs_versioning._get_version_impl import _warn_if_tracked
+
+    wd = WorkDir(tmp_path).setup_git()
+    version_file = tmp_path / "pkg" / "__version__.py"
+    version_file.parent.mkdir()
+    version_file.write_text("__version__ = '0.0.0'\n")
+    wd.add_and_commit("add tracked version file")
+
+    c = Configuration(root=tmp_path)
+    relative_target = Path("pkg/__version__.py")
+
+    with pytest.warns(UserWarning, match="tracked by version control"):
+        _warn_if_tracked(relative_target, tmp_path, c)
+
+
+@pytest.mark.issue(1451)
+def test_warn_if_tracked_warns_when_target_escapes_root(tmp_path: Path) -> None:
+    """_warn_if_tracked must warn when target resolves outside root."""
+    from vcs_versioning._get_version_impl import _warn_if_tracked
+
+    project = tmp_path / "project"
+    project.mkdir()
+    WorkDir(project).setup_git()
+
+    c = Configuration(root=project)
+    escaping_target = Path("../../etc/passwd")
+
+    with pytest.warns(UserWarning, match="resolves outside of"):
+        _warn_if_tracked(escaping_target, project, c)
+
+
 @pytest.mark.issue(1423)
 def test_parse_version_importable_from_get_version_impl() -> None:
     """setuptools-scm <=10.0.x imports parse_version from this module."""

{vcs_versioning-2.2.0 → vcs_versioning-2.2.2}/testing_vcs/test_tag_config.py

@@ -4,6 +4,8 @@ from __future__ import annotations
 
 import warnings
 
+import pytest
+from packaging.version import Version
 from vcs_versioning import Configuration
 from vcs_versioning._config import TagConfiguration
 from vcs_versioning._scm_version import tag_to_version
@@ -109,6 +111,50 @@ class TestTagPrefixStripping:
         assert str(version) == "1.2.3"
 
 
+class TestTagToVersionSuffixPreservation:
+    """Test that tag_to_version preserves +local suffixes when possible."""
+
+    def test_tag_with_build_metadata_preserved(self) -> None:
+        config = Configuration()
+        version = tag_to_version("1.2.3+build.123", config)
+        assert version is not None
+        assert str(version) == "1.2.3+build.123"
+
+    def test_tag_with_invalid_suffix_stripped(self) -> None:
+        config = Configuration()
+        # "+invalid!!" is captured as suffix by the default regex but
+        # Version("1.2.3+invalid!!") raises, so the suffix gets stripped
+        with pytest.warns(UserWarning, match="will be stripped of its suffix"):
+            version = tag_to_version("1.2.3+invalid!!", config)
+        assert version is not None
+        assert str(version) == "1.2.3"
+
+    @pytest.mark.parametrize(
+        ("tag", "expected"),
+        [
+            ("1.0.0+ci.456", "1.0.0+ci.456"),
+            ("v2.0.0+build.789", "2.0.0+build.789"),
+            ("release-1.0.0+metadata", "1.0.0+metadata"),
+        ],
+    )
+    def test_various_build_metadata_tags(self, tag: str, expected: str) -> None:
+        config = Configuration()
+        version = tag_to_version(tag, config)
+        assert version is not None
+        assert str(version) == expected
+
+    def test_custom_version_cls_parse_failure_returns_none(self) -> None:
+        """When version_cls rejects the base version string, return None."""
+
+        def rejecting_version_cls(version_str: str) -> Version:
+            raise ValueError(f"rejected: {version_str}")
+
+        config = Configuration(version_cls=rejecting_version_cls)  # type: ignore[arg-type]
+        with pytest.warns(UserWarning, match="could not be parsed"):
+            result = tag_to_version("1.2.3", config)
+        assert result is None
+
+
 class TestConfigFromData:
     """Test that Configuration.from_data correctly parses tag config."""