Rename scm.py to scm_old.py and add new utility functions.

Refactored SCM-related imports to use the renamed `scm_old.py` for better module organization. Introduced `is_subpath` utility to simplify path checks and added support for moveable tags in version control systems. These changes improve code structure and extend functionality for tagging.

Author: coordt

bumpversion/config/__init__.py

@@ -65,7 +65,7 @@ def get_configuration(config_file: Union[str, Path, None] = None, **overrides: A
         The configuration
     """
     from bumpversion.config.utils import get_all_file_configs, get_all_part_configs
-    from bumpversion.scm import SCMInfo, SourceCodeManager, get_scm_info  # noqa: F401
+    from bumpversion.scm_old import SCMInfo, SourceCodeManager, get_scm_info  # noqa: F401
 
     logger.info("Reading configuration")
     logger.indent()

bumpversion/config/models.py

@@ -14,7 +14,7 @@
 from bumpversion.versioning.models import VersionComponentSpec  # NOQA: TC001
 
 if TYPE_CHECKING:
-    from bumpversion.scm import SCMInfo
+    from bumpversion.scm_old import SCMInfo
     from bumpversion.versioning.models import VersionSpec
     from bumpversion.versioning.version_config import VersionConfig
 

bumpversion/context.py

@@ -8,7 +8,7 @@
 
 if TYPE_CHECKING:  # pragma: no-coverage
     from bumpversion.config import Config
-    from bumpversion.scm import SCMInfo
+    from bumpversion.scm_old import SCMInfo
     from bumpversion.versioning.models import Version
 
 MONTH_ABBREVIATIONS = [abbr for abbr in calendar.month_abbr if abbr]
@@ -56,7 +56,7 @@ def prefixed_environ() -> dict:
 
 def base_context(scm_info: Optional["SCMInfo"] = None) -> ChainMap:
     """The default context for rendering messages and tags."""
-    from bumpversion.scm import SCMInfo  # Including this here to avoid circular imports
+    from bumpversion.scm_old import SCMInfo  # Including this here to avoid circular imports
 
     scm = asdict(scm_info) if scm_info else asdict(SCMInfo())
 

bumpversion/scm.py bumpversion/scm_old.py

@@ -9,7 +9,7 @@
 from typing import TYPE_CHECKING, Any, ClassVar, Dict, List, MutableMapping, Optional, Type, Union
 
 from bumpversion.ui import get_indented_logger
-from bumpversion.utils import extract_regex_flags, format_and_raise_error, run_command
+from bumpversion.utils import extract_regex_flags, format_and_raise_error, is_subpath, run_command
 
 if TYPE_CHECKING:  # pragma: no-coverage
     from bumpversion.config import Config
@@ -50,14 +50,12 @@ def __repr__(self):
             f"dirty={self.dirty})"
         )
 
-    def path_in_repo(self, path: Union[Path, str]) -> bool:
+    def path_in_repo(self, path: Path | str) -> bool:
         """Return whether a path is inside this repository."""
         if self.repository_root is None:
             return True
-        elif not Path(path).is_absolute():
-            return True
 
-        return str(path).startswith(str(self.repository_root))
+        return is_subpath(self.repository_root, path)
 
 
 class SourceCodeManager:
@@ -128,6 +126,11 @@ def tag(cls, name: str, sign: bool = False, message: Optional[str] = None) -> No
         """Create a tag of the new_version in VCS."""
         raise NotImplementedError
 
+    @classmethod
+    def moveable_tag(cls, name: str) -> None:
+        """Create a new lightweight tag that should overwrite any previous tags with the same name."""
+        raise NotImplementedError
+
     @classmethod
     def get_all_tags(cls) -> List[str]:
         """Return all tags in VCS."""
@@ -229,6 +232,12 @@ def tag_in_scm(cls, config: "Config", context: MutableMapping, dry_run: bool = F
         if do_tag:
             cls.tag(tag_name, sign_tags, tag_message)
 
+        for moveable_tag in config.moveable_tags:
+            tag_name = moveable_tag.format(**context)
+            logger.info("%s moveable tag '%s' in %s", "Tagging" if do_tag else "Would tag", tag_name, cls.__name__)
+            if do_tag:
+                cls.moveable_tag(moveable_tag)
+
     def __str__(self):
         return self.__repr__()
 
@@ -382,6 +391,17 @@ def tag(cls, name: str, sign: bool = False, message: Optional[str] = None) -> No
             command += ["--message", message]
         run_command(command)
 
+    @classmethod
+    def moveable_tag(cls, name: str) -> None:
+        """
+        Create a new lightweight tag that should overwrite any previous tags with the same name.
+
+        Args:
+            name: The name of the moveable tag.
+        """
+        run_command(["git", "tag", "-f", name])
+        run_command(["git", "push", "origin", name, "--force"])
+
 
 class Mercurial(SourceCodeManager):
     """Mercurial implementation."""

bumpversion/utils.py

@@ -2,6 +2,7 @@
 
 import string
 import subprocess
+from pathlib import Path
 from subprocess import CompletedProcess
 from typing import Any, List, Optional, Tuple, Union
 
@@ -126,3 +127,8 @@ def run_command(command: list, env: Optional[dict] = None) -> CompletedProcess:
     result = subprocess.run(command, text=True, check=True, capture_output=True, env=env)  # NOQA: S603
     result.check_returncode()
     return result
+
+
+def is_subpath(parent: Path | str, path: Path | str) -> bool:
+    """Return whether a path is inside the parent."""
+    return str(path).startswith(str(parent)) if Path(path).is_absolute() else True

tests/test_bump.py

@@ -1,7 +1,7 @@
 """Tests for the bump module."""
 
-from pathlib import Path
 import shutil
+from pathlib import Path
 from textwrap import dedent
 from unittest.mock import MagicMock, patch
 
@@ -10,7 +10,7 @@
 from bumpversion import bump
 from bumpversion.exceptions import ConfigurationError, VersionNotFoundError
 from bumpversion.files import ConfiguredFile
-from bumpversion.scm import Git, SCMInfo
+from bumpversion.scm_old import Git, SCMInfo
 from bumpversion.utils import run_command
 from tests.conftest import get_config_data, inside_dir
 

tests/test_config/test_init.py

@@ -3,8 +3,8 @@
 from dataclasses import dataclass
 from typing import Optional
 
-from bumpversion.scm import SCMInfo
 from bumpversion.config import check_current_version
+from bumpversion.scm_old import SCMInfo
 
 
 @dataclass

tests/test_scm.py tests/test_scm_old.py

@@ -6,10 +6,10 @@
 from pathlib import Path
 
 import pytest
-from pytest import param, LogCaptureFixture
+from pytest import LogCaptureFixture, param
 
-from bumpversion import scm
-from bumpversion.exceptions import DirtyWorkingDirectoryError, BumpVersionError
+from bumpversion import scm_old
+from bumpversion.exceptions import BumpVersionError, DirtyWorkingDirectoryError
 from bumpversion.ui import setup_logging
 from bumpversion.utils import run_command
 from tests.conftest import get_config_data, inside_dir
@@ -43,7 +43,7 @@ class TestGetVersionFromTag:
         def returns_version_from_pattern(self, tag: str, tag_name: str, parse_pattern: str, expected: str) -> None:
             """It properly returns the version from the tag."""
             # Act
-            version = scm.SourceCodeManager.get_version_from_tag(tag, tag_name, parse_pattern)
+            version = scm_old.SourceCodeManager.get_version_from_tag(tag, tag_name, parse_pattern)
 
             # Assert
             assert version == expected
@@ -55,7 +55,7 @@ def test_format_and_raise_error_returns_scm_error(self, git_repo: Path) -> None:
                 run_command(["git", "add", "newfile.txt"])
             except subprocess.CalledProcessError as e:
                 with pytest.raises(BumpVersionError) as bump_error:
-                    scm.Git.format_and_raise_error(e)
+                    scm_old.Git.format_and_raise_error(e)
                 assert bump_error.value.message == (
                     "Failed to run `git add newfile.txt`: return code 128, output: "
                     "fatal: pathspec 'newfile.txt' did not match any files\n"
@@ -71,29 +71,29 @@ class TestIsUsable:
         def test_recognizes_a_git_repo(self, git_repo: Path) -> None:
             """Should return true if git is available, and it is a git repo."""
             with inside_dir(git_repo):
-                assert scm.Git.is_usable()
+                assert scm_old.Git.is_usable()
 
         def test_recognizes_not_a_git_repo(self, tmp_path: Path) -> None:
             """Should return false if it is not a git repo."""
             with inside_dir(tmp_path):
-                assert not scm.Git.is_usable()
+                assert not scm_old.Git.is_usable()
 
     class TestAssertNonDirty:
         """Tests for the Git.assert_nondirty() function."""
 
         def test_does_nothing_when_not_dirty(self, git_repo: Path) -> None:
             """If the git repo is clean, assert_nondirty should do nothing."""
             with inside_dir(git_repo):
-                scm.Git.assert_nondirty()
+                scm_old.Git.assert_nondirty()
 
         def test_raises_error_when_dirty(self, git_repo: Path) -> None:
             """If the git repo has modified files, assert_nondirty should return false."""
             readme = git_repo.joinpath("readme.md")
             readme.touch()
             with pytest.raises(DirtyWorkingDirectoryError):
                 with inside_dir(git_repo):
-                    subprocess.run(["git", "add", "readme.md"])
-                    scm.Git.assert_nondirty()
+                    subprocess.run(["git", "add", "readme.md"], check=False)
+                    scm_old.Git.assert_nondirty()
 
     class TestLatestTagInfo:
         """Test for the Git.latest_tag_info() function."""
@@ -107,8 +107,8 @@ def test_an_empty_repo_only_fills_tool_info(self, git_repo: Path) -> None:
             tag_prefix = "app/"
             parse_pattern = r"(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)"
             tag_name = f"{tag_prefix}{{new_version}}"
-            expected = scm.SCMInfo(
-                tool=scm.Git,
+            expected = scm_old.SCMInfo(
+                tool=scm_old.Git,
                 commit_sha=None,
                 distance_to_latest_tag=0,
                 current_version=None,
@@ -118,7 +118,7 @@ def test_an_empty_repo_only_fills_tool_info(self, git_repo: Path) -> None:
                 dirty=None,
             )
             with inside_dir(git_repo):
-                latest_tag_info = scm.Git.latest_tag_info(tag_name, parse_pattern=parse_pattern)
+                latest_tag_info = scm_old.Git.latest_tag_info(tag_name, parse_pattern=parse_pattern)
                 assert latest_tag_info == expected
 
         def test_returns_commit_and_tag_info(self, git_repo: Path) -> None:
@@ -133,7 +133,7 @@ def test_returns_commit_and_tag_info(self, git_repo: Path) -> None:
                 subprocess.run(["git", "add", "readme.md"])
                 subprocess.run(["git", "commit", "-m", "first"])
                 subprocess.run(["git", "tag", f"{tag_prefix}0.1.0"])
-                tag_info = scm.Git.latest_tag_info(tag_name, parse_pattern=parse_pattern)
+                tag_info = scm_old.Git.latest_tag_info(tag_name, parse_pattern=parse_pattern)
                 assert tag_info.commit_sha is not None
                 assert tag_info.current_version == "0.1.0"
                 assert tag_info.current_tag == f"{tag_prefix}0.1.0"
@@ -165,7 +165,7 @@ def test_git_detects_existing_tag(git_repo: Path, caplog: LogCaptureFixture) ->
         subprocess.run(["git", "tag", "v0.2.0"])
 
         # Act
-        scm.Git.tag_in_scm(config=conf, context=context)
+        scm_old.Git.tag_in_scm(config=conf, context=context)
 
     # Assert
     assert "Will not tag" in caplog.text
@@ -174,14 +174,14 @@ def test_git_detects_existing_tag(git_repo: Path, caplog: LogCaptureFixture) ->
 def test_hg_is_not_usable(tmp_path: Path) -> None:
     """Should return false if it is not a mercurial repo."""
     with inside_dir(tmp_path):
-        assert not scm.Mercurial.is_usable()
+        assert not scm_old.Mercurial.is_usable()
 
 
 @pytest.mark.skipif(not shutil.which("hg"), reason="Mercurial is not available.")
 def test_hg_is_usable(hg_repo: Path) -> None:
     """Should return false if it is not a mercurial repo."""
     with inside_dir(hg_repo):
-        assert scm.Mercurial.is_usable()
+        assert scm_old.Mercurial.is_usable()
 
 
 @pytest.mark.parametrize(
@@ -190,20 +190,22 @@ def test_hg_is_usable(hg_repo: Path) -> None:
         param(
             "git_repo",
             "git",
-            scm.Git,
+            scm_old.Git,
             id="git",
             marks=pytest.mark.skipif(not shutil.which("git"), reason="Git is not available."),
         ),
         param(
             "hg_repo",
             "hg",
-            scm.Mercurial,
+            scm_old.Mercurial,
             id="hg",
             marks=pytest.mark.skipif(not shutil.which("hg"), reason="Mercurial is not available."),
         ),
     ],
 )
-def test_commit_and_tag_from_below_scm_root(repo: str, scm_command: str, scm_class: scm.SourceCodeManager, request):
+def test_commit_and_tag_from_below_scm_root(
+    repo: str, scm_command: str, scm_class: scm_old.SourceCodeManager, request
+):
     # Arrange
     repo_path: Path = request.getfixturevalue(repo)
     version_path = repo_path / "VERSION"
@@ -243,14 +245,14 @@ def test_commit_and_tag_from_below_scm_root(repo: str, scm_command: str, scm_cla
         param(
             "git_repo",
             "git",
-            scm.Git,
+            scm_old.Git,
             id="git",
             marks=pytest.mark.skipif(not shutil.which("git"), reason="Git is not available."),
         ),
         param(
             "hg_repo",
             "hg",
-            scm.Mercurial,
+            scm_old.Mercurial,
             id="hg",
             marks=pytest.mark.skipif(not shutil.which("hg"), reason="Mercurial is not available."),
         ),
@@ -267,7 +269,7 @@ def test_commit_and_tag_from_below_scm_root(repo: str, scm_command: str, scm_cla
 def test_commit_tag_dry_run_interactions(
     repo: str,
     scm_command: str,
-    scm_class: scm.SourceCodeManager,
+    scm_class: scm_old.SourceCodeManager,
     commit: bool,
     tag: bool,
     dry_run: bool,

tests/test_versioning/test_version_config.py

@@ -51,7 +51,7 @@ class TestSerialize:
 
     def test_distance_to_latest_tag_in_pattern(self):
         """Using ``distance_to_latest_tag`` in the serialization string outputs correctly."""
-        from bumpversion.scm import Git, SCMInfo
+        from bumpversion.scm_old import Git, SCMInfo
 
         overrides = {
             "current_version": "19.6.0",