refactor(ExitCode): add from_str in ExitCode and replace parse_no_raise with it

Author: bearomorphism

commitizen/cli.py

@@ -577,6 +577,7 @@ def commitizen_excepthook(
 sys.excepthook = commitizen_excepthook
 
 
+# TODO: unused, deprecate this?
 def parse_no_raise(comma_separated_no_raise: str) -> list[int]:
     """Convert the given string to exit codes.
 
@@ -673,7 +674,11 @@ def main() -> None:
         logging.getLogger("commitizen").setLevel(logging.DEBUG)
         sys.excepthook = commitizen_debug_excepthook
     elif args.no_raise:
-        no_raise_exit_codes = parse_no_raise(args.no_raise)
+        no_raise_exit_codes = [
+            code.value
+            for s in args.no_raise.split(",")
+            if (code := ExitCode.from_str(s)) is not None
+        ]
         no_raise_debug_excepthook = partial(
             commitizen_excepthook, no_raise=no_raise_exit_codes
         )

commitizen/exceptions.py

@@ -1,10 +1,12 @@
-import enum
+from __future__ import annotations
+
+from enum import IntEnum
 from typing import Any
 
 from commitizen import out
 
 
-class ExitCode(enum.IntEnum):
+class ExitCode(IntEnum):
     EXPECTED_EXIT = 0
     NO_COMMITIZEN_FOUND = 1
     NOT_A_GIT_PROJECT = 2
@@ -39,6 +41,16 @@ class ExitCode(enum.IntEnum):
     CONFIG_FILE_IS_EMPTY = 31
     COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED = 32
 
+    @classmethod
+    def from_str(cls, value: str) -> ExitCode | None:
+        try:
+            if value.isdecimal():
+                return cls(int(value))
+            return cls[value.strip()]
+        except (KeyError, ValueError):
+            out.warn(f"WARN: no_raise key `{value}` does not exist. Skipping.")
+            return None
+
 
 class CommitizenException(Exception):
     def __init__(self, *args: str, **kwargs: Any) -> None:

tests/test_exceptions.py

@@ -0,0 +1,32 @@
+from commitizen.exceptions import ExitCode
+
+
+def test_from_str_with_decimal():
+    """Test from_str with decimal values."""
+    assert ExitCode.from_str("0") == ExitCode.EXPECTED_EXIT
+    assert ExitCode.from_str("1") == ExitCode.NO_COMMITIZEN_FOUND
+    assert ExitCode.from_str("32") == ExitCode.COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED
+
+
+def test_from_str_with_enum_name():
+    """Test from_str with enum names."""
+    assert ExitCode.from_str("EXPECTED_EXIT") == ExitCode.EXPECTED_EXIT
+    assert ExitCode.from_str("NO_COMMITIZEN_FOUND") == ExitCode.NO_COMMITIZEN_FOUND
+    assert (
+        ExitCode.from_str("COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED")
+        == ExitCode.COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED
+    )
+
+
+def test_from_str_with_whitespace():
+    """Test from_str with whitespace in enum names."""
+    assert ExitCode.from_str("  EXPECTED_EXIT  ") == ExitCode.EXPECTED_EXIT
+    assert ExitCode.from_str("\tNO_COMMITIZEN_FOUND\t") == ExitCode.NO_COMMITIZEN_FOUND
+
+
+def test_from_str_with_invalid_values():
+    """Test from_str with invalid values."""
+    assert ExitCode.from_str("invalid_name") is None
+    assert ExitCode.from_str("999") is None  # Out of range decimal
+    assert ExitCode.from_str("") is None
+    assert ExitCode.from_str(" ") is None