feat(version_types): expose version_types as a commitizen.version_type endpoint

Author: noirbizarre

commitizen/bump.py

@@ -1,23 +1,20 @@
+from __future__ import annotations
+
 import os
 import re
-import sys
-import typing
 from collections import OrderedDict
 from itertools import zip_longest
 from string import Template
-from typing import List, Optional, Tuple, Type, Union
+from typing import TYPE_CHECKING, List, Optional, Tuple, Type, Union
 
 from packaging.version import Version
 
 from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message
 from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit, smart_open
 
-if sys.version_info >= (3, 8):
+if TYPE_CHECKING:
     from commitizen.version_types import VersionProtocol
-else:
-    # workaround mypy issue for 3.7 python
-    VersionProtocol = typing.Any
 
 
 def find_increment(

commitizen/changelog.py

@@ -24,14 +24,13 @@
 - [x] hook after changelog is generated (api calls)
 - [x] add support for change_type maps
 """
+from __future__ import annotations
 
 import os
 import re
-import sys
-import typing
 from collections import OrderedDict, defaultdict
 from datetime import date
-from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type
+from typing import TYPE_CHECKING, Callable, Dict, Iterable, List, Optional, Tuple, Type
 
 from jinja2 import Environment, PackageLoader
 from packaging.version import InvalidVersion, Version
@@ -41,11 +40,8 @@
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 
-if sys.version_info >= (3, 8):
+if TYPE_CHECKING:
     from commitizen.version_types import VersionProtocol
-else:
-    # workaround mypy issue for 3.7 python
-    VersionProtocol = typing.Any
 
 
 def get_commit_tag(commit: GitCommit, tags: List[GitTag]) -> Optional[GitTag]:

commitizen/version_types.py

@@ -1,15 +1,18 @@
-import sys
-from typing import Optional, Tuple, Union
+from __future__ import annotations
 
-if sys.version_info >= (3, 8):
-    from typing import Protocol as _Protocol
-else:
-    _Protocol = object
+from typing import Optional, Tuple, Union
 
+import importlib_metadata as metadata
 from packaging.version import Version
 
+# Protocol is Python 3.8+ but backported in typing-extensions
+try:
+    from typing import Protocol
+except ImportError:
+    from typing_extensions import Protocol  # type: ignore
+
 
-class VersionProtocol(_Protocol):
+class VersionProtocol(Protocol):
     def __init__(self, _version: Union[Version, str]):
         raise NotImplementedError("must be implemented")
 
@@ -37,7 +40,7 @@ def public(self) -> str:
         raise NotImplementedError("must be implemented")
 
 
-class SemVerVersion(VersionProtocol):
+class SemVer(VersionProtocol):
     def __init__(self, version: str):
         self._version = Version(version)
 
@@ -93,7 +96,10 @@ def __str__(self) -> str:
         return "".join(parts)
 
 
+class Pep440(Version):
+    pass
+
+
 VERSION_TYPES = {
-    "semver": SemVerVersion,
-    "pep440": Version,
+    ep.name: ep.load() for ep in metadata.entry_points(group="commitizen.version_type")
 }

pyproject.toml

@@ -89,6 +89,10 @@ pep621 = "commitizen.providers:Pep621Provider"
 poetry = "commitizen.providers:PoetryProvider"
 scm = "commitizen.providers:ScmProvider"
 
+[tool.poetry.plugins."commitizen.version_type"]
+pep440 = "commitizen.version_types:Pep440"
+semver = "commitizen.version_types:SemVer"
+
 [tool.coverage]
     [tool.coverage.report]
     show_missing = true

tests/test_bump_find_version_type_semver.py

@@ -3,7 +3,7 @@
 import pytest
 
 from commitizen.bump import generate_version
-from commitizen.version_types import SemVerVersion
+from commitizen.version_types import SemVer
 
 simple_flow = [
     (("0.1.0", "PATCH", None, 0, None), "0.1.1"),
@@ -95,7 +95,7 @@ def test_generate_version_type(test_input, expected):
                 prerelease=prerelease,
                 prerelease_offset=prerelease_offset,
                 devrelease=devrelease,
-                version_type_cls=SemVerVersion,
+                version_type_cls=SemVer,
             )
         )
         == expected