refactor: minor review fixes

Author: Apkawa

commitizen/cli.py

@@ -207,7 +207,7 @@
                         "name": ["--version-type"],
                         "help": "choose version type",
                         "default": None,
-                        "choices": version_types.types,
+                        "choices": version_types.VERSION_TYPES,
                     },
                 ],
             },

commitizen/commands/bump.py

@@ -65,7 +65,7 @@ def __init__(self, config: BaseConfig, arguments: dict):
         version_type = arguments["version_type"] or self.config.settings.get(
             "version_type"
         )
-        self.version_type = version_type and version_types.types[version_type]
+        self.version_type = version_type and version_types.VERSION_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."""

commitizen/commands/changelog.py

@@ -54,7 +54,7 @@ def __init__(self, config: BaseConfig, args):
         ) or self.config.settings.get("changelog_merge_prerelease")
 
         version_type = self.config.settings.get("version_type")
-        self.version_type = version_type and version_types.types[version_type]
+        self.version_type = version_type and version_types.VERSION_TYPES[version_type]
 
     def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:
         """Try to find the 'start_rev'.

commitizen/version_types.py

@@ -1,5 +1,5 @@
 import sys
-import typing
+from typing import Optional, Tuple, Union
 
 if sys.version_info >= (3, 8):
     from typing import Protocol as _Protocol
@@ -10,26 +10,26 @@
 
 
 class VersionProtocol(_Protocol):
-    def __init__(self, _version: typing.Union[Version, str]):
+    def __init__(self, _version: Union[Version, str]):
         raise NotImplementedError("must be implemented")
 
     def __str__(self) -> str:
         raise NotImplementedError("must be implemented")
 
     @property
-    def release(self) -> typing.Tuple[int, ...]:
+    def release(self) -> Tuple[int, ...]:
         raise NotImplementedError("must be implemented")
 
     @property
     def is_prerelease(self) -> bool:
         raise NotImplementedError("must be implemented")
 
     @property
-    def pre(self) -> typing.Optional[typing.Tuple[str, int]]:
+    def pre(self) -> Optional[Tuple[str, int]]:
         raise NotImplementedError("must be implemented")
 
     @property
-    def local(self) -> typing.Optional[str]:
+    def local(self) -> Optional[str]:
         raise NotImplementedError("must be implemented")
 
     @property
@@ -42,19 +42,19 @@ def __init__(self, version: str):
         self._version = Version(version)
 
     @property
-    def release(self) -> typing.Tuple[int, ...]:
+    def release(self) -> Tuple[int, ...]:
         return self._version.release
 
     @property
     def is_prerelease(self) -> bool:
         return self._version.is_prerelease
 
     @property
-    def pre(self) -> typing.Optional[typing.Tuple[str, int]]:
+    def pre(self) -> Optional[Tuple[str, int]]:
         return self._version.pre
 
     @property
-    def local(self) -> typing.Optional[str]:
+    def local(self) -> Optional[str]:
         return self._version.local
 
     @property
@@ -74,7 +74,7 @@ def __str__(self) -> str:
         parts.append(".".join(str(x) for x in version.release))
 
         # Pre-release
-        if version.pre is not None:
+        if version.pre:
             pre = "".join(str(x) for x in version.pre)
             parts.append(f"-{pre}")
 
@@ -87,13 +87,13 @@ def __str__(self) -> str:
             parts.append(f"-dev{version.dev}")
 
         # Local version segment
-        if version.local is not None:
+        if version.local:
             parts.append(f"+{version.local}")
 
         return "".join(parts)
 
 
-types = {
+VERSION_TYPES = {
     "pep440": Version,
     "semver": SemVerVersion,
 }

docs/config.md

@@ -23,7 +23,7 @@
 | `use_shortcuts`            | `bool` | `false`                     | If enabled, commitizen will show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. [See more][shortcuts]                                                                                        |
 | `major_version_zero`       | `bool` | `false`                     | When true, breaking changes on a `0.x` will remain as a `0.x` version. On `false`, a breaking change will bump a `0.x` version to `1.0`. [major-version-zero]                                                                                        |
 | `prerelease_offset`        | `int`  | `0`                         | In special cases it may be necessary that a prerelease cannot start with a 0, e.g. in an embedded project the individual characters are encoded in bytes. This can be done by specifying an offset from which to start counting. [prerelease-offset] |
-| `version_type`             | `str`  | `pep440`                    | Select a version type from the following options [`pep440`, `semver`]. Useful for non python projects. [See more][version_type]                                                                                                                      |
+| `version_type`             | `str`  | `pep440`                    | Select a version type from the following options [`pep440`, `semver`]. Useful for non-python projects. [See more][version_type]                                                                                                                      |
 
 ## pyproject.toml or .cz.toml
 

tests/commands/test_bump_command.py

@@ -855,20 +855,12 @@ def test_bump_use_version_provider(mocker: MockFixture):
     mock.set_version.assert_called_once_with("0.0.1")
 
 
-def test_bump_command_prelease_version_provider_via_cli(
-    tmp_commitizen_project, mocker: MockFixture
+def test_bump_command_prelease_version_type_via_cli(
+    tmp_commitizen_project_initial, mocker: MockFixture
 ):
-    # PRERELEASE
+    tmp_commitizen_project = tmp_commitizen_project_initial()
     tmp_version_file = tmp_commitizen_project.join("__version__.py")
-    tmp_version_file.write("0.1.0")
     tmp_commitizen_cfg_file = tmp_commitizen_project.join("pyproject.toml")
-    tmp_version_file_string = str(tmp_version_file).replace("\\", "/")
-    tmp_commitizen_cfg_file.write(
-        f"{tmp_commitizen_cfg_file.read()}\n"
-        f'version_files = ["{tmp_version_file_string}"]'
-    )
-
-    create_file_and_commit("feat: new user interface")
 
     testargs = [
         "cz",
@@ -885,11 +877,9 @@ def test_bump_command_prelease_version_provider_via_cli(
     tag_exists = git.tag_exist("0.2.0-a0")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0-a0" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0-a0" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0-a0" in f.read()
 
     # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE
     testargs = ["cz", "bump", "--yes"]
@@ -899,28 +889,19 @@ def test_bump_command_prelease_version_provider_via_cli(
     tag_exists = git.tag_exist("0.2.0")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0" in f.read()
 
 
 def test_bump_command_prelease_version_type_via_config(
-    tmp_commitizen_project, mocker: MockFixture
+    tmp_commitizen_project_initial, mocker: MockFixture
 ):
-    # PRERELEASE
+    tmp_commitizen_project = tmp_commitizen_project_initial(
+        config_extra='version_type = "semver"\n',
+    )
     tmp_version_file = tmp_commitizen_project.join("__version__.py")
-    tmp_version_file.write("0.1.0")
     tmp_commitizen_cfg_file = tmp_commitizen_project.join("pyproject.toml")
-    tmp_version_file_string = str(tmp_version_file).replace("\\", "/")
-    tmp_commitizen_cfg_file.write(
-        f"{tmp_commitizen_cfg_file.read()}\n"
-        f'version_files = ["{tmp_version_file_string}"]\n'
-        f'version_type = "semver"'
-    )
-
-    create_file_and_commit("feat: new user interface")
 
     testargs = ["cz", "bump", "--prerelease", "alpha", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
@@ -929,11 +910,9 @@ def test_bump_command_prelease_version_type_via_config(
     tag_exists = git.tag_exist("0.2.0-a0")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0-a0" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0-a0" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0-a0" in f.read()
 
     testargs = ["cz", "bump", "--prerelease", "alpha", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
@@ -942,11 +921,9 @@ def test_bump_command_prelease_version_type_via_config(
     tag_exists = git.tag_exist("0.2.0-a1")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0-a1" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0-a1" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0-a1" in f.read()
 
     # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE
     testargs = ["cz", "bump", "--yes"]
@@ -956,28 +933,19 @@ def test_bump_command_prelease_version_type_via_config(
     tag_exists = git.tag_exist("0.2.0")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0" in f.read()
 
 
 def test_bump_command_prelease_version_type_check_old_tags(
-    tmp_commitizen_project, mocker: MockFixture
+    tmp_commitizen_project_initial, mocker: MockFixture
 ):
-    # PRERELEASE
+    tmp_commitizen_project = tmp_commitizen_project_initial(
+        config_extra=('tag_format = "v$version"\nversion_type = "semver"\n'),
+    )
     tmp_version_file = tmp_commitizen_project.join("__version__.py")
-    tmp_version_file.write("0.1.0")
     tmp_commitizen_cfg_file = tmp_commitizen_project.join("pyproject.toml")
-    tmp_version_file_string = str(tmp_version_file).replace("\\", "/")
-    tmp_commitizen_cfg_file.write(
-        f"{tmp_commitizen_cfg_file.read()}\n"
-        f'version_files = ["{tmp_version_file_string}"]\n'
-        f'tag_format = "v$version"\n'
-        f'version_type = "semver"\n'
-    )
-    create_file_and_commit("feat: new user interface")
 
     testargs = ["cz", "bump", "--prerelease", "alpha", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
@@ -986,11 +954,9 @@ def test_bump_command_prelease_version_type_check_old_tags(
     tag_exists = git.tag_exist("v0.2.0-a0")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0-a0" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0-a0" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0-a0" in f.read()
 
     testargs = ["cz", "bump", "--prerelease", "alpha"]
     mocker.patch.object(sys, "argv", testargs)
@@ -999,11 +965,9 @@ def test_bump_command_prelease_version_type_check_old_tags(
     tag_exists = git.tag_exist("v0.2.0-a1")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0-a1" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0-a1" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0-a1" in f.read()
 
     # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE
     testargs = ["cz", "bump"]
@@ -1013,8 +977,6 @@ def test_bump_command_prelease_version_type_check_old_tags(
     tag_exists = git.tag_exist("v0.2.0")
     assert tag_exists is True
 
-    with open(tmp_version_file, "r") as f:
-        assert "0.2.0" in f.read()
-
-    with open(tmp_commitizen_cfg_file, "r") as f:
-        assert "0.2.0" in f.read()
+    for version_file in [tmp_version_file, tmp_commitizen_cfg_file]:
+        with open(version_file, "r") as f:
+            assert "0.2.0" in f.read()

tests/commands/test_changelog_command.py

@@ -1208,4 +1208,4 @@ def test_changelog_prerelease_rev_with_use_version_type_semver(
 
     out, _ = capsys.readouterr()
 
-    assert out == "## 0.3.0-a1 (2022-02-13)\n\n"
+    file_regression.check(out, extension=".second-prerelease.md")

tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_version_type_semver.second-prerelease.md

@@ -0,0 +1,2 @@
+## 0.3.0-a1 (2022-02-13)
+

tests/conftest.py

@@ -2,11 +2,13 @@
 import re
 import tempfile
 from pathlib import Path
+from typing import Optional
 
 import pytest
 
 from commitizen import cmd, defaults
 from commitizen.config import BaseConfig
+from tests.utils import create_file_and_commit
 
 SIGNER = "GitHub Action"
 SIGNER_MAIL = "action@github.com"
@@ -42,6 +44,35 @@ def tmp_commitizen_project(tmp_git_project):
     yield tmp_git_project
 
 
+@pytest.fixture(scope="function")
+def tmp_commitizen_project_initial(tmp_git_project):
+    def _initial(
+        config_extra: Optional[str] = None,
+        version="0.1.0",
+        initial_commit="feat: new user interface",
+    ):
+        with tmp_git_project.as_cwd():
+            tmp_commitizen_cfg_file = tmp_git_project.join("pyproject.toml")
+            tmp_commitizen_cfg_file.write(
+                f"[tool.commitizen]\n" f'version="{version}"\n'
+            )
+            tmp_version_file = tmp_git_project.join("__version__.py")
+            tmp_version_file.write(version)
+            tmp_commitizen_cfg_file = tmp_git_project.join("pyproject.toml")
+            tmp_version_file_string = str(tmp_version_file).replace("\\", "/")
+            tmp_commitizen_cfg_file.write(
+                f"{tmp_commitizen_cfg_file.read()}\n"
+                f'version_files = ["{tmp_version_file_string}"]\n'
+            )
+            if config_extra:
+                tmp_commitizen_cfg_file.write(config_extra, mode="a")
+            create_file_and_commit(initial_commit)
+
+            return tmp_git_project
+
+    yield _initial
+
+
 def _get_gpg_keyid(signer_mail):
     _new_key = cmd.run(f"gpg --list-secret-keys {signer_mail}")
     _m = re.search(

tests/test_bump_find_version_type_semver.py

@@ -78,7 +78,7 @@
 
 
 @pytest.mark.parametrize(
-    "test_input,expected",
+    "test_input, expected",
     itertools.chain(tdd_cases, weird_cases, simple_flow, unexpected_cases),
 )
 def test_generate_version_type(test_input, expected):