fix(types): allow documented None bump_map values

Author: bearomorphism

commitizen/cz/base.py

@@ -37,8 +37,8 @@ class ValidationResult(NamedTuple):
 
 class BaseCommitizen(metaclass=ABCMeta):
     bump_pattern: str | None = None
-    bump_map: dict[str, str] | None = None
-    bump_map_major_version_zero: dict[str, str] | None = None
+    bump_map: Mapping[str, str | None] | None = None
+    bump_map_major_version_zero: Mapping[str, str | None] | None = None
     default_style_config: list[tuple[str, str]] = [
         ("qmark", "fg:#ff9d00 bold"),
         ("question", "bold"),

commitizen/cz/conventional_commits/conventional_commits.py

@@ -8,6 +8,8 @@
 from commitizen.cz.utils import multiple_line_breaker, required_validator
 
 if TYPE_CHECKING:
+    from collections.abc import Mapping
+
     from commitizen.question import CzQuestion
 
 __all__ = ["ConventionalCommitsCz"]
@@ -32,8 +34,10 @@ class ConventionalCommitsAnswers(TypedDict):
 
 class ConventionalCommitsCz(BaseCommitizen):
     bump_pattern = defaults.BUMP_PATTERN
-    bump_map = defaults.BUMP_MAP
-    bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO
+    bump_map: Mapping[str, str | None] = defaults.BUMP_MAP
+    bump_map_major_version_zero: Mapping[str, str | None] = (
+        defaults.BUMP_MAP_MAJOR_VERSION_ZERO
+    )
     commit_parser = r"^((?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?|\w+!):\s(?P<message>.*)?"
     change_type_map = {
         "feat": "Feat",

commitizen/cz/customize/customize.py

@@ -27,8 +27,8 @@
 
 
 def _derive_major_version_zero(
-    bump_map: Mapping[str, str],
-) -> OrderedDict[str, str]:
+    bump_map: Mapping[str, str | None],
+) -> OrderedDict[str, str | None]:
     """Derive a ``bump_map_major_version_zero`` from a user-supplied
     ``bump_map`` by demoting any ``MAJOR`` rule to ``MINOR``.
 
@@ -45,8 +45,10 @@ def _derive_major_version_zero(
 
 class CustomizeCommitsCz(BaseCommitizen):
     bump_pattern = defaults.BUMP_PATTERN
-    bump_map = defaults.BUMP_MAP
-    bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO
+    bump_map: Mapping[str, str | None] = defaults.BUMP_MAP
+    bump_map_major_version_zero: Mapping[str, str | None] = (
+        defaults.BUMP_MAP_MAJOR_VERSION_ZERO
+    )
     change_type_order = defaults.CHANGE_TYPE_ORDER
 
     def __init__(self, config: BaseConfig) -> None:

commitizen/defaults.py

@@ -13,8 +13,8 @@
 
 class CzSettings(TypedDict, total=False):
     bump_pattern: str
-    bump_map: OrderedDict[str, str]
-    bump_map_major_version_zero: OrderedDict[str, str]
+    bump_map: OrderedDict[str, str | None]
+    bump_map_major_version_zero: OrderedDict[str, str | None]
     change_type_order: list[str]
 
     questions: Iterable[CzQuestion]

tests/commands/test_bump_command.py

@@ -1406,6 +1406,26 @@ def test_bump_allow_no_commit_with_string_none_bump_map_raises(
     assert git.tag_exist("0.1.2") is False
 
 
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_bump_python_plugin_none_bump_map_is_a_supported_no_bump_value(
+    util: UtilFixture, mock_plugin: BaseCommitizen
+) -> None:
+    """A Python plugin may use ``None`` to match without bumping."""
+    mock_plugin.bump_pattern = r"^(docs|fix)"
+    mock_plugin.bump_map = {"docs": None, "fix": "PATCH"}
+    mock_plugin.bump_map_major_version_zero = {"docs": None, "fix": "PATCH"}
+
+    util.create_file_and_commit("fix: seed release")
+    util.run_cli("bump", "--yes")
+    util.create_file_and_commit("docs: update guide")
+
+    with pytest.raises(NoneIncrementExit):
+        util.run_cli("bump", "--yes")
+
+    util.run_cli("bump", "--yes", "--allow-no-commit")
+    assert git.tag_exist("0.1.2") is True
+
+
 def test_bump_allow_no_commit_with_increment(
     tmp_commitizen_project, monkeypatch, util: UtilFixture, capsys
 ):