feat: add --no-raise to avoid raising error codes

Closes #485

Author: woile

commitizen/cli.py

@@ -2,12 +2,18 @@
 import logging
 import sys
 from functools import partial
+from typing import List
 
 import argcomplete
 from decli import cli
 
-from commitizen import commands, config
-from commitizen.exceptions import CommitizenException, ExpectedExit, NoCommandFoundError
+from commitizen import commands, config, out
+from commitizen.exceptions import (
+    CommitizenException,
+    ExitCode,
+    ExpectedExit,
+    NoCommandFoundError,
+)
 
 logger = logging.getLogger(__name__)
 data = {
@@ -24,6 +30,12 @@
             "name": ["-n", "--name"],
             "help": "use the given commitizen (default: cz_conventional_commits)",
         },
+        {
+            "name": ["-nr", "--no-raise"],
+            "type": str,
+            "required": False,
+            "help": "comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
+        },
     ],
     "subcommands": {
         "title": "commands",
@@ -274,13 +286,20 @@
 original_excepthook = sys.excepthook
 
 
-def commitizen_excepthook(type, value, tracekback, debug=False):
+def commitizen_excepthook(
+    type, value, tracekback, debug=False, no_raise: List[int] = None
+):
+    if not no_raise:
+        no_raise = []
     if isinstance(value, CommitizenException):
         if value.message:
             value.output_method(value.message)
         if debug:
             original_excepthook(type, value, tracekback)
-        sys.exit(value.exit_code)
+        exit_code = value.exit_code
+        if exit_code in no_raise:
+            exit_code = 0
+        sys.exit(exit_code)
     else:
         original_excepthook(type, value, tracekback)
 
@@ -290,6 +309,27 @@ def commitizen_excepthook(type, value, tracekback, debug=False):
 sys.excepthook = commitizen_excepthook
 
 
+def parse_no_raise(comma_separated_no_raise: str) -> List[int]:
+    """
+    Convert the given string with exit code digits or exit
+    codes name to its integer representation
+    """
+    no_raise_items = comma_separated_no_raise.split(",")
+    no_raise_codes = []
+    for item in no_raise_items:
+        if item.isdecimal():
+            no_raise_codes.append(int(item))
+            continue
+        try:
+            exit_code = ExitCode[item]
+        except KeyError:
+            out.warn(f"WARN: no_raise key {item} does not exist. Skipping.")
+            continue
+        else:
+            no_raise_codes.append(exit_code.value)
+    return no_raise_codes
+
+
 def main():
     conf = config.read_cfg()
     parser = cli(data)
@@ -319,6 +359,12 @@ def main():
     if args.debug:
         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_debug_excepthook = partial(
+            commitizen_excepthook, no_raise=no_raise_exit_codes
+        )
+        sys.excepthook = no_raise_debug_excepthook
 
     args.func(conf, vars(args))()
 

commitizen/out.py

@@ -30,3 +30,8 @@ def info(value: str) -> None:
 
 def diagnostic(value: str):
     line(value, file=sys.stderr)
+
+
+def warn(value: str) -> None:
+    message = colored(value, "magenta")
+    line(message)

tests/test_cli.py

@@ -95,3 +95,46 @@ def test_argcomplete_activation():
     output = subprocess.run(["register-python-argcomplete", "cz"])
 
     assert output.returncode == 0
+
+
+def test_commitizen_excepthook_no_raises(capsys):
+    with pytest.raises(SystemExit) as excinfo:
+        cli.commitizen_excepthook(
+            NotAGitProjectError,
+            NotAGitProjectError(),
+            "",
+            no_raise=[NotAGitProjectError.exit_code],
+        )
+
+    assert excinfo.type == SystemExit
+    assert excinfo.value.code == 0
+
+
+def test_parse_no_raise_single_integer():
+    input_str = "1"
+    result = cli.parse_no_raise(input_str)
+    assert result == [1]
+
+
+def test_parse_no_raise_integers():
+    input_str = "1,2,3"
+    result = cli.parse_no_raise(input_str)
+    assert result == [1, 2, 3]
+
+
+def test_parse_no_raise_error_code():
+    input_str = "NO_COMMITIZEN_FOUND,NO_COMMITS_FOUND,NO_PATTERN_MAP"
+    result = cli.parse_no_raise(input_str)
+    assert result == [1, 3, 5]
+
+
+def test_parse_no_raise_mix_integer_error_code():
+    input_str = "NO_COMMITIZEN_FOUND,2,NO_COMMITS_FOUND,4"
+    result = cli.parse_no_raise(input_str)
+    assert result == [1, 2, 3, 4]
+
+
+def test_parse_no_raise_mix_invalid_arg_is_skipped():
+    input_str = "NO_COMMITIZEN_FOUND,2,nothing,4"
+    result = cli.parse_no_raise(input_str)
+    assert result == [1, 2, 4]