refactor: Move bump.normalize_tag to tags.tag_from_version

Author: robertschweizer

commitizen/bump.py

@@ -217,39 +217,6 @@ def _version_to_regex(version: str) -> str:
     return version.replace(".", r"\.").replace("+", r"\+")
 
 
-def normalize_tag(
-    version: Union[VersionProtocol, str],
-    tag_format: str,
-    version_type_cls: Optional[Type[VersionProtocol]] = None,
-) -> str:
-    """The tag and the software version might be different.
-
-    That's why this function exists.
-
-    Example:
-    | tag | version (PEP 0440) |
-    | --- | ------- |
-    | v0.9.0 | 0.9.0 |
-    | ver1.0.0 | 1.0.0 |
-    | ver1.0.0.a0 | 1.0.0a0 |
-    """
-    if version_type_cls is None:
-        version_type_cls = Version
-    if isinstance(version, str):
-        version = version_type_cls(version)
-
-    major, minor, patch = version.release
-    prerelease = ""
-    # version.pre is needed for mypy check
-    if version.is_prerelease and version.pre:
-        prerelease = f"{version.pre[0]}{version.pre[1]}"
-
-    t = Template(tag_format)
-    return t.safe_substitute(
-        version=version, major=major, minor=minor, patch=patch, prerelease=prerelease
-    )
-
-
 def create_commit_message(
     current_version: Union[Version, str],
     new_version: Union[Version, str],

commitizen/changelog.py

@@ -37,9 +37,9 @@
 from packaging.version import InvalidVersion, Version
 
 from commitizen import defaults
-from commitizen.bump import normalize_tag
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
+from commitizen.tags import tag_from_version
 
 if sys.version_info >= (3, 8):
     from commitizen.version_types import VersionProtocol
@@ -341,13 +341,13 @@ def get_oldest_and_newest_rev(
     except ValueError:
         newest = version
 
-    newest_tag = normalize_tag(
+    newest_tag = tag_from_version(
         newest, tag_format=tag_format, version_type_cls=version_type_cls
     )
 
     oldest_tag = None
     if oldest:
-        oldest_tag = normalize_tag(
+        oldest_tag = tag_from_version(
             oldest, tag_format=tag_format, version_type_cls=version_type_cls
         )
 

commitizen/commands/bump.py

@@ -22,6 +22,7 @@
     NoVersionSpecifiedError,
 )
 from commitizen.providers import get_provider
+from commitizen.tags import tag_from_version
 
 logger = getLogger("commitizen")
 
@@ -161,7 +162,7 @@ def __call__(self):  # noqa: C901
                     f"--major-version-zero is meaningless for current version {current_version}"
                 )
 
-        current_tag_version: str = bump.normalize_tag(
+        current_tag_version: str = tag_from_version(
             current_version,
             tag_format=tag_format,
             version_type_cls=self.version_type,
@@ -223,7 +224,7 @@ def __call__(self):  # noqa: C901
                 version_type_cls=self.version_type,
             )
 
-        new_tag_version = bump.normalize_tag(
+        new_tag_version = tag_from_version(
             new_version,
             tag_format=tag_format,
             version_type_cls=self.version_type,

commitizen/commands/changelog.py

@@ -5,7 +5,7 @@
 
 from packaging.version import parse
 
-from commitizen import bump, changelog, defaults, factory, git, out, version_types
+from commitizen import changelog, defaults, factory, git, out, version_types
 from commitizen.config import BaseConfig
 from commitizen.defaults import DEFAULT_SETTINGS
 from commitizen.exceptions import (
@@ -17,6 +17,7 @@
     NotAllowed,
 )
 from commitizen.git import GitTag, smart_open
+from commitizen.tags import tag_from_version
 
 
 class Changelog:
@@ -149,7 +150,7 @@ def __call__(self):
             changelog_meta = changelog.get_metadata(self.file_name)
             latest_version = changelog_meta.get("latest_version")
             if latest_version:
-                latest_tag_version: str = bump.normalize_tag(
+                latest_tag_version: str = tag_from_version(
                     latest_version,
                     tag_format=self.tag_format,
                     version_type_cls=self.version_type,

commitizen/tags.py

@@ -0,0 +1,44 @@
+import sys
+from string import Template
+from typing import Any, Optional, Type, Union
+
+from packaging.version import Version
+
+if sys.version_info >= (3, 8):
+    from commitizen.version_types import VersionProtocol
+else:
+    # workaround mypy issue for 3.7 python
+    VersionProtocol = Any
+
+
+def tag_from_version(
+    version: Union[VersionProtocol, str],
+    tag_format: str,
+    version_type_cls: Optional[Type[VersionProtocol]] = None,
+) -> str:
+    """The tag and the software version might be different.
+
+    That's why this function exists.
+
+    Example:
+    | tag | version (PEP 0440) |
+    | --- | ------- |
+    | v0.9.0 | 0.9.0 |
+    | ver1.0.0 | 1.0.0 |
+    | ver1.0.0.a0 | 1.0.0a0 |
+    """
+    if version_type_cls is None:
+        version_type_cls = Version
+    if isinstance(version, str):
+        version = version_type_cls(version)
+
+    major, minor, patch = version.release
+    prerelease = ""
+    # version.pre is needed for mypy check
+    if version.is_prerelease and version.pre:
+        prerelease = f"{version.pre[0]}{version.pre[1]}"
+
+    t = Template(tag_format)
+    return t.safe_substitute(
+        version=version, major=major, minor=minor, patch=patch, prerelease=prerelease
+    )

tests/test_bump_normalize_tag.py renamed to tests/test_tags.py

@@ -1,7 +1,7 @@
 import pytest
 from packaging.version import Version
 
-from commitizen import bump
+from commitizen.tags import tag_from_version
 
 conversion = [
     (("1.2.3", "v$version"), "v1.2.3"),
@@ -17,7 +17,7 @@
 
 
 @pytest.mark.parametrize("test_input,expected", conversion)
-def test_create_tag(test_input, expected):
+def test_tag_from_version(test_input, expected):
     version, format = test_input
-    new_tag = bump.normalize_tag(Version(version), format)
+    new_tag = tag_from_version(Version(version), format)
     assert new_tag == expected