refactor(bump): version_provider rename to version_type; pep option rename to pep440

Signed-off-by: apkawa <[email protected]>

Author: Apkawa

commitizen/bump.py

@@ -120,7 +120,7 @@ def generate_version(
     prerelease_offset: int = 0,
     devrelease: Optional[int] = None,
     is_local_version: bool = False,
-    version_provider_cls: Optional[Type[Version]] = None,
+    version_type_cls: Optional[Type[Version]] = None,
 ) -> Version:
     """Based on the given increment a proper semver will be generated.
 
@@ -133,18 +133,16 @@ def generate_version(
         MINOR 1.0.0 -> 1.1.0
         MAJOR 1.0.0 -> 2.0.0
     """
-    version_provider_cls = version_provider_cls or Version
+    version_type_cls = version_type_cls or Version
     if is_local_version:
-        version = version_provider_cls(current_version)
+        version = version_type_cls(current_version)
         dev_version = devrelease_generator(devrelease=devrelease)
         pre_version = prerelease_generator(
             str(version.local), prerelease=prerelease, offset=prerelease_offset
         )
         semver = semver_generator(str(version.local), increment=increment)
 
-        return version_provider_cls(
-            f"{version.public}+{semver}{pre_version}{dev_version}"
-        )
+        return version_type_cls(f"{version.public}+{semver}{pre_version}{dev_version}")
     else:
         dev_version = devrelease_generator(devrelease=devrelease)
         pre_version = prerelease_generator(
@@ -153,7 +151,7 @@ def generate_version(
         semver = semver_generator(current_version, increment=increment)
 
         # TODO: post version
-        return version_provider_cls(f"{semver}{pre_version}{dev_version}")
+        return version_type_cls(f"{semver}{pre_version}{dev_version}")
 
 
 def update_version_in_files(
@@ -214,7 +212,7 @@ def _version_to_regex(version: str) -> str:
 def normalize_tag(
     version: Union[Version, str],
     tag_format: Optional[str] = None,
-    version_provider_cls: Optional[Type[Version]] = None,
+    version_type_cls: Optional[Type[Version]] = None,
 ) -> str:
     """The tag and the software version might be different.
 
@@ -227,9 +225,9 @@ def normalize_tag(
     | ver1.0.0 | 1.0.0 |
     | ver1.0.0.a0 | 1.0.0a0 |
     """
-    version_provider_cls = version_provider_cls or Version
+    version_type_cls = version_type_cls or Version
     if isinstance(version, str):
-        version = version_provider_cls(version)
+        version = version_type_cls(version)
 
     if not tag_format:
         return str(version)

commitizen/cli.py

@@ -8,7 +8,7 @@
 import argcomplete
 from decli import cli
 
-from commitizen import commands, config, out, version_providers
+from commitizen import commands, config, out, version_types
 from commitizen.exceptions import (
     CommitizenException,
     ExitCode,
@@ -204,10 +204,10 @@
                         "metavar": "MANUAL_VERSION",
                     },
                     {
-                        "name": ["--version-provider"],
-                        "help": "choose version provider",
+                        "name": ["--version-type"],
+                        "help": "choose version type",
                         "default": None,
-                        "choices": version_providers.providers,
+                        "choices": version_types.types,
                     },
                 ],
             },

commitizen/commands/bump.py

@@ -5,7 +5,7 @@
 import questionary
 from packaging.version import InvalidVersion, Version
 
-from commitizen import bump, cmd, defaults, factory, git, hooks, out, version_providers
+from commitizen import bump, cmd, defaults, factory, git, hooks, out, version_types
 from commitizen.commands.changelog import Changelog
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
@@ -62,12 +62,10 @@ def __init__(self, config: BaseConfig, arguments: dict):
         self.retry = arguments["retry"]
         self.pre_bump_hooks = self.config.settings["pre_bump_hooks"]
         self.post_bump_hooks = self.config.settings["post_bump_hooks"]
-        version_provider = arguments["version_provider"] or self.config.settings.get(
-            "version_provider"
-        )
-        self.version_provider = (
-            version_provider and version_providers.providers[version_provider]
+        version_type = arguments["version_type"] or self.config.settings.get(
+            "version_type"
         )
+        self.version_type = version_type and version_types.types[version_type]
 
     def is_initial_tag(self, current_tag_version: str, is_yes: bool = False) -> bool:
         """Check if reading the whole git tree up to HEAD is needed."""
@@ -161,7 +159,7 @@ def __call__(self):  # noqa: C901
         current_tag_version: str = bump.normalize_tag(
             current_version,
             tag_format=tag_format,
-            version_provider_cls=self.version_provider,
+            version_type_cls=self.version_type,
         )
 
         is_initial = self.is_initial_tag(current_tag_version, is_yes)
@@ -217,13 +215,13 @@ def __call__(self):  # noqa: C901
                 prerelease_offset=prerelease_offset,
                 devrelease=devrelease,
                 is_local_version=is_local_version,
-                version_provider_cls=self.version_provider,
+                version_type_cls=self.version_type,
             )
 
         new_tag_version = bump.normalize_tag(
             new_version,
             tag_format=tag_format,
-            version_provider_cls=self.version_provider,
+            version_type_cls=self.version_type,
         )
         message = bump.create_commit_message(
             current_version, new_version, bump_commit_message

commitizen/defaults.py

@@ -45,7 +45,7 @@ class Settings(TypedDict, total=False):
     pre_bump_hooks: Optional[List[str]]
     post_bump_hooks: Optional[List[str]]
     prerelease_offset: int
-    version_provider: Optional[str]
+    version_type: Optional[str]
 
 
 name: str = "cz_conventional_commits"
@@ -76,7 +76,7 @@ class Settings(TypedDict, total=False):
     "pre_bump_hooks": [],
     "post_bump_hooks": [],
     "prerelease_offset": 0,
-    "version_provider": None,
+    "version_type": None,
 }
 
 MAJOR = "MAJOR"

commitizen/version_providers.py commitizen/version_types.pycommitizen/version_providers.py renamed to commitizen/version_types.py

@@ -32,7 +32,7 @@ def __str__(self) -> str:
         return "".join(parts)
 
 
-providers = {
-    "pep": Version,
+types = {
+    "pep440": Version,
     "semver": SemVerVersion,
 }

docs/bump.md

@@ -96,8 +96,8 @@ options:
   --retry               retry commit if it fails the 1st time
   --major-version-zero  keep major version at zero, even for breaking changes
   --prerelease-offset   start pre-releases with this offset
-  --version-provider {pep,semver}
-                        choose version provider
+  --version-type {pep440,semver}
+                        choose version type
 
 ```
 
@@ -479,24 +479,24 @@ Defaults to: `0`
 prerelease_offset = 1
 ```
 
-### `version_provider`
+### `version_type`
 
-Choose version provider
+Choose version type
 
-* `pep` - default version provider.
+* `pep440` - default version type.
     - prerelease - `1.0.1a0`
     - devrelease - `1.0.1dev0`
     - dev and pre - `1.0.1a0.dev0`
-* `semver` - semver compatibly provider. Added "-" delimiter
+* `semver` - semver compatibly type. Added "-" delimiter
     - prerelease - `1.0.1-a0`
     - devrelease - `1.0.1-dev0`
     - dev and pre - `1.0.1-a0-dev0`
 
-Defaults to: `pep`
+Defaults to: `pep440`
 
 ```toml
 [tool.commitizen]
-version_provider = "semver"
+version_type = "semver"
 ```
 
 ## Custom bump

tests/commands/test_bump_command.py

@@ -876,7 +876,7 @@ def test_bump_command_prelease_version_provider_via_cli(
         "--prerelease",
         "alpha",
         "--yes",
-        "--version-provider",
+        "--version-type",
         "semver",
     ]
     mocker.patch.object(sys, "argv", testargs)
@@ -906,7 +906,7 @@ def test_bump_command_prelease_version_provider_via_cli(
         assert "0.2.0" in f.read()
 
 
-def test_bump_command_prelease_version_provider_via_config(
+def test_bump_command_prelease_version_type_via_config(
     tmp_commitizen_project, mocker: MockFixture
 ):
     # PRERELEASE
@@ -917,7 +917,7 @@ def test_bump_command_prelease_version_provider_via_config(
     tmp_commitizen_cfg_file.write(
         f"{tmp_commitizen_cfg_file.read()}\n"
         f'version_files = ["{tmp_version_file_string}"]\n'
-        f'version_provider = "semver"'
+        f'version_type = "semver"'
     )
 
     create_file_and_commit("feat: new user interface")
@@ -963,7 +963,7 @@ def test_bump_command_prelease_version_provider_via_config(
         assert "0.2.0" in f.read()
 
 
-def test_bump_command_prelease_version_provider_check_old_tags(
+def test_bump_command_prelease_version_type_check_old_tags(
     tmp_commitizen_project, mocker: MockFixture
 ):
     # PRERELEASE
@@ -975,7 +975,7 @@ def test_bump_command_prelease_version_provider_check_old_tags(
         f"{tmp_commitizen_cfg_file.read()}\n"
         f'version_files = ["{tmp_version_file_string}"]\n'
         f'tag_format = "v$version"\n'
-        f'version_provider = "semver"\n'
+        f'version_type = "semver"\n'
     )
     create_file_and_commit("feat: new user interface")
 

tests/test_bump_find_version_provider.py …ts/test_bump_find_version_type_semver.pytests/test_bump_find_version_provider.py renamed to tests/test_bump_find_version_type_semver.py tests/test_bump_find_version_provider.py renamed to tests/test_bump_find_version_type_semver.py

@@ -3,7 +3,7 @@
 import pytest
 
 from commitizen.bump import generate_version
-from commitizen.version_providers import SemVerVersion
+from commitizen.version_types import SemVerVersion
 
 simple_flow = [
     (("0.1.0", "PATCH", None, 0, None), "0.1.1"),
@@ -81,7 +81,7 @@
     "test_input,expected",
     itertools.chain(tdd_cases, weird_cases, simple_flow, unexpected_cases),
 )
-def test_generate_version_provider(test_input, expected):
+def test_generate_version_type(test_input, expected):
     current_version = test_input[0]
     increment = test_input[1]
     prerelease = test_input[2]
@@ -95,7 +95,7 @@ def test_generate_version_provider(test_input, expected):
                 prerelease=prerelease,
                 prerelease_offset=prerelease_offset,
                 devrelease=devrelease,
-                version_provider_cls=SemVerVersion,
+                version_type_cls=SemVerVersion,
             )
         )
         == expected

tests/test_conf.py

@@ -60,7 +60,7 @@
     "pre_bump_hooks": ["scripts/generate_documentation.sh"],
     "post_bump_hooks": ["scripts/slack_notification.sh"],
     "prerelease_offset": 0,
-    "version_provider": None,
+    "version_type": None,
 }
 
 _new_settings = {
@@ -82,7 +82,7 @@
     "pre_bump_hooks": ["scripts/generate_documentation.sh"],
     "post_bump_hooks": ["scripts/slack_notification.sh"],
     "prerelease_offset": 0,
-    "version_provider": None,
+    "version_type": None,
 }
 
 _read_settings = {