refactor: use namedtuple for return

Author: benediktziegler

commitizen/commands/check.py

@@ -72,7 +72,7 @@ def __call__(self):
 
         pattern = self.cz.schema_pattern()
         ill_formated_commits = [
-            (commit, check[1])
+            (commit, check.errors)
             for commit in commits
             if not (
                 check := self.cz.validate_commit_message(
@@ -82,7 +82,7 @@ def __call__(self):
                     allowed_prefixes=self.allowed_prefixes,
                     max_msg_length=self.max_msg_length,
                 )
-            )[0]
+            ).is_valid
         ]
 
         if ill_formated_commits:

commitizen/cz/base.py

@@ -2,7 +2,7 @@
 
 import re
 from abc import ABCMeta, abstractmethod
-from typing import Any, Callable, Iterable, Protocol
+from typing import Any, Callable, Iterable, NamedTuple, Protocol
 
 from jinja2 import BaseLoader, PackageLoader
 from prompt_toolkit.styles import Style, merge_styles
@@ -24,6 +24,11 @@ def __call__(
     ) -> dict[str, Any]: ...
 
 
+class ValidationResult(NamedTuple):
+    is_valid: bool
+    errors: list
+
+
 class BaseCommitizen(metaclass=ABCMeta):
     bump_pattern: str | None = None
     bump_map: dict[str, str] | None = None
@@ -41,7 +46,7 @@ class BaseCommitizen(metaclass=ABCMeta):
         ("disabled", "fg:#858585 italic"),
     ]
 
-    # The whole subject will be parsed as message by default
+    # The whole subject will be parsed as a message by default
     # This allows supporting changelog for any rule system.
     # It can be modified per rule
     commit_parser: str | None = r"(?P<message>.*)"
@@ -104,21 +109,21 @@ def validate_commit_message(
         allow_abort: bool,
         allowed_prefixes: list[str],
         max_msg_length: int,
-    ) -> tuple[bool, list]:
+    ) -> ValidationResult:
         """Validate commit message against the pattern."""
         if not commit_msg:
-            return allow_abort, []
+            return ValidationResult(allow_abort, [])
 
         if pattern is None:
-            return True, []
+            return ValidationResult(True, [])
 
         if any(map(commit_msg.startswith, allowed_prefixes)):
-            return True, []
+            return ValidationResult(True, [])
         if max_msg_length:
             msg_len = len(commit_msg.partition("\n")[0].strip())
             if msg_len > max_msg_length:
-                return False, []
-        return bool(re.match(pattern, commit_msg)), []
+                return ValidationResult(False, [])
+        return ValidationResult(bool(re.match(pattern, commit_msg)), [])
 
     def format_exception_message(
         self, ill_formated_commits: list[tuple[git.GitCommit, list]]

tests/conftest.py

@@ -16,7 +16,7 @@
 )
 from commitizen.config import BaseConfig
 from commitizen.cz import registry
-from commitizen.cz.base import BaseCommitizen
+from commitizen.cz.base import BaseCommitizen, ValidationResult
 from tests.utils import create_file_and_commit
 
 SIGNER = "GitHub Action"
@@ -255,26 +255,31 @@ def validate_commit_message(
         allow_abort: bool,
         allowed_prefixes: list[str],
         max_msg_length: int,
-    ) -> tuple[bool, list]:
+    ) -> ValidationResult:
         """Validate commit message against the pattern."""
         if not commit_msg:
-            return allow_abort, [] if allow_abort else ["commit message is empty"]
+            return ValidationResult(
+                allow_abort, [] if allow_abort else ["commit message is empty"]
+            )
 
         if pattern is None:
-            return True, []
+            return ValidationResult(True, [])
 
         if any(map(commit_msg.startswith, allowed_prefixes)):
-            return True, []
+            return ValidationResult(True, [])
         if max_msg_length:
             msg_len = len(commit_msg.partition("\n")[0].strip())
             if msg_len > max_msg_length:
-                return False, [
-                    f"commit message is too long. Max length is {max_msg_length}"
-                ]
+                return ValidationResult(
+                    False,
+                    [f"commit message is too long. Max length is {max_msg_length}"],
+                )
         pattern_match = bool(re.match(pattern, commit_msg))
         if not pattern_match:
-            return False, [f"commit message does not match pattern {pattern}"]
-        return True, []
+            return ValidationResult(
+                False, [f"commit message does not match pattern {pattern}"]
+            )
+        return ValidationResult(True, [])
 
     def format_exception_message(
         self, ill_formated_commits: list[tuple[git.GitCommit, list]]

tests/test_cz_base.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from commitizen.cz.base import BaseCommitizen
+from commitizen.cz.base import BaseCommitizen, ValidationResult
 
 
 class DummyCz(BaseCommitizen):
@@ -51,7 +51,7 @@ def test_validate_commit_message(config):
         allow_abort=False,
         allowed_prefixes=[],
         max_msg_length=0,
-    ) == (True, [])
+    ) == ValidationResult(True, [])
 
 
 def test_info(config):