refactor: Move bump.normalize_tag to tags.tag_from_version

Author: robertschweizer

commitizen/bump.py

@@ -207,33 +207,6 @@ def _version_to_regex(version: str) -> str:
     return version.replace(".", r"\.").replace("+", r"\+")
 
 
-def normalize_tag(version: Union[Version, str], tag_format: str) -> 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 isinstance(version, str):
-        version = Version(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

@@ -34,9 +34,9 @@
 from jinja2 import Environment, PackageLoader
 
 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
 
 
 def get_commit_tag(commit: GitCommit, tags: List[GitTag]) -> Optional[GitTag]:
@@ -301,11 +301,11 @@ def get_oldest_and_newest_rev(
     except ValueError:
         newest = version
 
-    newest_tag = normalize_tag(newest, tag_format=tag_format)
+    newest_tag = tag_from_version(newest, tag_format=tag_format)
 
     oldest_tag = None
     if oldest:
-        oldest_tag = normalize_tag(oldest, tag_format=tag_format)
+        oldest_tag = tag_from_version(oldest, tag_format=tag_format)
 
     tags_range = get_smart_tag_range(tags, newest=newest_tag, oldest=oldest_tag)
     if not tags_range:

commitizen/commands/bump.py

@@ -21,6 +21,7 @@
     NotAllowed,
     NoVersionSpecifiedError,
 )
+from commitizen.tags import tag_from_version
 
 logger = getLogger("commitizen")
 
@@ -151,7 +152,7 @@ def __call__(self):  # noqa: C901
             # Update the bump map to ensure major version doesn't increment.
             self.cz.bump_map = defaults.bump_map_major_version_zero
 
-        current_tag_version: str = bump.normalize_tag(
+        current_tag_version: str = tag_from_version(
             current_version, tag_format=tag_format
         )
 
@@ -210,7 +211,7 @@ def __call__(self):  # noqa: C901
                 is_local_version=is_local_version,
             )
 
-        new_tag_version = bump.normalize_tag(new_version, tag_format=tag_format)
+        new_tag_version = tag_from_version(new_version, tag_format=tag_format)
         message = bump.create_commit_message(
             current_version, new_version, bump_commit_message
         )

commitizen/commands/changelog.py

@@ -3,7 +3,7 @@
 from operator import itemgetter
 from typing import Callable, Dict, List, Optional
 
-from commitizen import bump, changelog, defaults, factory, git, out
+from commitizen import changelog, defaults, factory, git, out
 from commitizen.config import BaseConfig
 from commitizen.defaults import DEFAULT_SETTINGS
 from commitizen.exceptions import (
@@ -15,6 +15,7 @@
     NotAllowed,
 )
 from commitizen.git import GitTag, smart_open
+from commitizen.tags import tag_from_version
 
 
 class Changelog:
@@ -133,7 +134,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
                 )
                 start_rev = self._find_incremental_rev(latest_tag_version, tags)

commitizen/tags.py

@@ -0,0 +1,31 @@
+from string import Template
+from typing import Union
+
+from packaging.version import Version
+
+
+def tag_from_version(version: Union[Version, str], tag_format: str) -> 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 isinstance(version, str):
+        version = Version(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