refactor: use None instead of 0 for message_length_limit and update related logic, types, and tests

Author: Narwhal-fish

commitizen/commands/check.py

@@ -19,7 +19,7 @@ class CheckArgs(TypedDict, total=False):
     commit_msg: str
     rev_range: str
     allow_abort: bool
-    message_length_limit: int
+    message_length_limit: int | None
     allowed_prefixes: list[str]
     message: str
 
@@ -42,12 +42,7 @@ def __init__(self, config: BaseConfig, arguments: CheckArgs, *args: object) -> N
             arguments.get("allow_abort", config.settings["allow_abort"])
         )
 
-        # Use command line argument if provided, otherwise use config setting
-        cmd_length_limit = arguments.get("message_length_limit")
-        if cmd_length_limit is None:
-            self.max_msg_length = config.settings.get("message_length_limit", 0)
-        else:
-            self.max_msg_length = cmd_length_limit
+        self.max_msg_length = arguments.get("message_length_limit", config.settings.get("message_length_limit", None))
 
         # we need to distinguish between None and [], which is a valid value
         allowed_prefixes = arguments.get("allowed_prefixes")
@@ -90,7 +85,7 @@ def __call__(self) -> None:
         invalid_msgs_content = "\n".join(
             f'commit "{commit.rev}": "{commit.message}"'
             for commit in commits
-            if not self._validate_commit_message(commit.message, pattern)
+            if not self._validate_commit_message(commit.message, pattern, commit.rev)
         )
         if invalid_msgs_content:
             # TODO: capitalize the first letter of the error message for consistency in v5
@@ -150,21 +145,21 @@ def _filter_comments(msg: str) -> str:
         return "\n".join(lines)
 
     def _validate_commit_message(
-        self, commit_msg: str, pattern: re.Pattern[str]
+        self, commit_msg: str, pattern: re.Pattern[str], commit_hash: str
     ) -> bool:
         if not commit_msg:
             return self.allow_abort
 
         if any(map(commit_msg.startswith, self.allowed_prefixes)):
             return True
 
-        if self.max_msg_length:
+        if self.max_msg_length is not None:
             msg_len = len(commit_msg.partition("\n")[0].strip())
             if msg_len > self.max_msg_length:
                 raise CommitMessageLengthExceededError(
                     f"commit validation: failed!\n"
                     f"commit message length exceeds the limit.\n"
-                    f'commit "": "{commit_msg}"\n'
+                    f'commit "{commit_hash}": "{commit_msg}"\n'
                     f"message length limit: {self.max_msg_length} (actual: {msg_len})"
                 )
 

commitizen/commands/commit.py

@@ -33,7 +33,7 @@ class CommitArgs(TypedDict, total=False):
     dry_run: bool
     edit: bool
     extra_cli_args: str
-    message_length_limit: int
+    message_length_limit: int | None
     no_retry: bool
     signoff: bool
     write_message_to_file: Path | None
@@ -82,11 +82,12 @@ def _prompt_commit_questions(self) -> str:
         message = cz.message(answers)
         message_len = len(message.partition("\n")[0].strip())
 
-        message_length_limit = self.arguments.get("message_length_limit")
-        if message_length_limit is None:
-            message_length_limit = self.config.settings.get("message_length_limit", 0)
+        message_length_limit = self.arguments.get(
+            "message_length_limit",
+            self.config.settings.get("message_length_limit", None),
+        )
 
-        if 0 < message_length_limit < message_len:
+        if message_length_limit is not None and message_len > message_length_limit:
             raise CommitMessageLengthExceededError(
                 f"Length of commit message exceeds limit ({message_len}/{message_length_limit})"
             )

commitizen/defaults.py

@@ -46,7 +46,7 @@ class Settings(TypedDict, total=False):
     ignored_tag_formats: Sequence[str]
     legacy_tag_formats: Sequence[str]
     major_version_zero: bool
-    message_length_limit: int
+    message_length_limit: int | None
     name: str
     post_bump_hooks: list[str] | None
     pre_bump_hooks: list[str] | None
@@ -109,7 +109,7 @@ class Settings(TypedDict, total=False):
     "always_signoff": False,
     "template": None,  # default provided by plugin
     "extras": {},
-    "message_length_limit": 0,  # 0 for no limit
+    "message_length_limit": None,  # None for no limit
 }
 
 MAJOR = "MAJOR"

tests/commands/test_check_command.py

@@ -507,7 +507,7 @@ def test_check_command_cli_overrides_config_message_length_limit(
     success_mock.reset_mock()
     check_cmd = commands.Check(
         config=config,
-        arguments={"message": message, "message_length_limit": 0},
+        arguments={"message": message, "message_length_limit": None},
     )
 
     check_cmd()

tests/commands/test_commit_command.py

@@ -611,5 +611,5 @@ def test_commit_command_cli_overrides_config_message_length_limit(
     success_mock.assert_called_once()
 
     success_mock.reset_mock()
-    commands.Commit(config, {"message_length_limit": 0})()
+    commands.Commit(config, {"message_length_limit": None})()
     success_mock.assert_called_once()

tests/test_conf.py

@@ -95,7 +95,7 @@
     "always_signoff": False,
     "template": None,
     "extras": {},
-    "message_length_limit": 0,
+    "message_length_limit": None,
 }
 
 _new_settings: dict[str, Any] = {
@@ -127,7 +127,7 @@
     "always_signoff": False,
     "template": None,
     "extras": {},
-    "message_length_limit": 0,
+    "message_length_limit": None,
 }