refactor: use custom exception for error handling

the error code used is embedded into these exceptions

Author: Lee-W

commitizen/bump.py

@@ -15,7 +15,7 @@
     bump_message,
     bump_pattern,
 )
-from commitizen.error_codes import CURRENT_VERSION_NOT_FOUND
+from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit
 
 
@@ -167,7 +167,7 @@ def update_version_in_files(
                 "The version defined in commitizen configuration and the ones in "
                 "version_files are possibly inconsistent."
             )
-            raise SystemExit(CURRENT_VERSION_NOT_FOUND)
+            raise CurrentVersionNotFoundError()
 
         # Write the file out again
         with open(filepath, "w") as file:

commitizen/cli.py

@@ -6,6 +6,7 @@
 from decli import cli
 
 from commitizen import commands, config, out
+from commitizen.exceptions import CommitizenError
 
 logger = logging.getLogger(__name__)
 data = {
@@ -237,6 +238,17 @@
     },
 }
 
+original_excepthook = sys.excepthook
+
+
+def commitizen_excepthook(type, value, tracekback):
+    original_excepthook(type, value, tracekback)
+    if isinstance(value, CommitizenError):
+        sys.exit(value.exit_code)
+
+
+sys.excepthook = commitizen_excepthook
+
 
 def main():
     conf = config.read_cfg()

commitizen/commands/bump.py

@@ -6,12 +6,12 @@
 from commitizen import bump, factory, git, out
 from commitizen.commands.changelog import Changelog
 from commitizen.config import BaseConfig
-from commitizen.error_codes import (
-    COMMIT_FAILED,
-    NO_COMMITS_FOUND,
-    NO_PATTERN_MAP,
-    NO_VERSION_SPECIFIED,
-    TAG_FAILED,
+from commitizen.exceptions import (
+    CommitFailedError,
+    NoCommitsFoundError,
+    NoPatternMapError,
+    NoVersionSpecifiedError,
+    TagFailedError,
 )
 
 
@@ -57,7 +57,7 @@ def find_increment(self, commits: List[git.GitCommit]) -> Optional[str]:
         bump_map = self.cz.bump_map
         if not bump_map or not bump_pattern:
             out.error(f"'{self.config.settings['name']}' rule does not support bump")
-            raise SystemExit(NO_PATTERN_MAP)
+            raise NoPatternMapError()
         increment = bump.find_increment(
             commits, regex=bump_pattern, increments_map=bump_map
         )
@@ -73,7 +73,7 @@ def __call__(self):  # noqa: C901
                 "Check if current version is specified in config file, like:\n"
                 "version = 0.4.3\n"
             )
-            raise SystemExit(NO_VERSION_SPECIFIED)
+            raise NoVersionSpecifiedError()
 
         # Initialize values from sources (conf)
         current_version: str = self.config.settings["version"]
@@ -102,7 +102,7 @@ def __call__(self):  # noqa: C901
         # Unless we previously had a prerelease.
         if not commits and not current_version_instance.is_prerelease:
             out.error("[NO_COMMITS_FOUND]\n" "No new commits found.")
-            raise SystemExit(NO_COMMITS_FOUND)
+            raise NoCommitsFoundError()
 
         if increment is None:
             increment = self.find_increment(commits)
@@ -155,11 +155,11 @@ def __call__(self):  # noqa: C901
         c = git.commit(message, args=self._get_commit_args())
         if c.err:
             out.error('git.commit error: "{}"'.format(c.err.strip()))
-            raise SystemExit(COMMIT_FAILED)
+            raise CommitFailedError()
         c = git.tag(new_tag_version)
         if c.err:
             out.error(c.err)
-            raise SystemExit(TAG_FAILED)
+            raise TagFailedError()
         out.success("Done!")
 
     def _get_commit_args(self):

commitizen/commands/changelog.py

@@ -5,7 +5,11 @@
 
 from commitizen import changelog, factory, git, out
 from commitizen.config import BaseConfig
-from commitizen.error_codes import NO_COMMITS_FOUND, NO_PATTERN_MAP, NO_REVISION
+from commitizen.exceptions import (
+    NoCommitsFoundError,
+    NoPatternMapError,
+    NoRevisionError,
+)
 from commitizen.git import GitTag
 
 
@@ -51,9 +55,9 @@ def _find_incremental_rev(self, latest_version: str, tags: List[GitTag]) -> str:
         try:
             score, tag = max(tag_ratio, key=itemgetter(0))
         except ValueError:
-            raise SystemExit(NO_REVISION)
+            raise NoRevisionError()
         if score < SIMILARITY_THRESHOLD:
-            raise SystemExit(NO_REVISION)
+            raise NoRevisionError()
         start_rev = tag.name
         return start_rev
 
@@ -73,7 +77,7 @@ def __call__(self):
             out.error(
                 f"'{self.config.settings['name']}' rule does not support changelog"
             )
-            raise SystemExit(NO_PATTERN_MAP)
+            raise NoPatternMapError()
 
         tags = git.get_tags()
         if not tags:
@@ -88,7 +92,7 @@ def __call__(self):
         commits = git.get_commits(start=start_rev, args="--author-date-order")
         if not commits:
             out.error("No commits found")
-            raise SystemExit(NO_COMMITS_FOUND)
+            raise NoCommitsFoundError()
 
         tree = changelog.generate_tree_from_commits(
             commits,

commitizen/commands/check.py

@@ -5,7 +5,7 @@
 
 from commitizen import factory, git, out
 from commitizen.config import BaseConfig
-from commitizen.error_codes import INVALID_COMMIT_MSG, NO_COMMITS_FOUND
+from commitizen.exceptions import InvalidCommitMessageError, NoCommitsFoundError
 
 
 class Check:
@@ -46,7 +46,7 @@ def __call__(self):
         commit_msgs = self._get_commit_messages()
         if not commit_msgs:
             warnings.warn(f"No commit found with range: '{self.rev_range}'")
-            raise SystemExit(NO_COMMITS_FOUND)
+            raise NoCommitsFoundError()
 
         pattern = self.cz.schema_pattern()
         for commit_msg in commit_msgs:
@@ -57,7 +57,7 @@ def __call__(self):
                     f"commit: {commit_msg}\n"
                     f"pattern: {pattern}"
                 )
-                raise SystemExit(INVALID_COMMIT_MSG)
+                raise InvalidCommitMessageError()
         out.success("Commit validation: successful!")
 
     def _get_commit_messages(self):

commitizen/commands/commit.py

@@ -7,12 +7,12 @@
 from commitizen import factory, git, out
 from commitizen.config import BaseConfig
 from commitizen.cz.exceptions import CzException
-from commitizen.error_codes import (
-    COMMIT_ERROR,
-    CUSTOM_ERROR,
-    NO_ANSWERS,
-    NO_COMMIT_BACKUP,
-    NOTHING_TO_COMMIT,
+from commitizen.exceptions import (
+    CommitError,
+    CustomError,
+    NoAnswersError,
+    NoCommitBackupError,
+    NothingToCommitError,
 )
 
 
@@ -29,7 +29,7 @@ def read_backup_message(self) -> str:
         # Check the commit backup file exists
         if not os.path.isfile(self.temp_file):
             out.error("No commit backup found")
-            raise SystemExit(NO_COMMIT_BACKUP)
+            raise NoCommitBackupError()
 
         # Read commit message from backup
         with open(self.temp_file, "r") as f:
@@ -45,19 +45,19 @@ def prompt_commit_questions(self) -> str:
             root_err = err.__context__
             if isinstance(root_err, CzException):
                 out.error(root_err.__str__())
-                raise SystemExit(CUSTOM_ERROR)
+                raise CustomError()
             raise err
 
         if not answers:
-            raise SystemExit(NO_ANSWERS)
+            raise NoAnswersError()
         return cz.message(answers)
 
     def __call__(self):
         dry_run: bool = self.arguments.get("dry_run")
 
         if git.is_staging_clean() and not dry_run:
             out.write("No files added to staging!")
-            raise SystemExit(NOTHING_TO_COMMIT)
+            raise NothingToCommitError()
 
         retry: bool = self.arguments.get("retry")
 
@@ -69,7 +69,7 @@ def __call__(self):
         out.info(f"\n{m}\n")
 
         if dry_run:
-            raise SystemExit(NOTHING_TO_COMMIT)
+            raise NothingToCommitError()
 
         c = git.commit(m)
 
@@ -80,7 +80,7 @@ def __call__(self):
             with open(self.temp_file, "w") as f:
                 f.write(m)
 
-            raise SystemExit(COMMIT_ERROR)
+            raise CommitError()
 
         if "nothing added" in c.out or "no changes added to commit" in c.out:
             out.error(c.out)

commitizen/config/__init__.py

@@ -2,8 +2,8 @@
 from pathlib import Path
 from typing import Optional, Union
 
-from commitizen import defaults, git, out
-from commitizen.error_codes import NOT_A_GIT_PROJECT
+from commitizen import defaults, git
+from commitizen.exceptions import NotAGitProjectError
 
 from .base_config import BaseConfig
 from .ini_config import IniConfig
@@ -38,10 +38,7 @@ def read_cfg() -> BaseConfig:
 
     git_project_root = git.find_git_project_root()
     if not git_project_root:
-        out.error(
-            "fatal: not a git repository (or any of the parent directories): .git"
-        )
-        raise SystemExit(NOT_A_GIT_PROJECT)
+        raise NotAGitProjectError()
 
     cfg_paths = (
         path / Path(filename)

commitizen/cz/customize/customize.py

@@ -5,10 +5,10 @@
 
 from typing import Any, Dict, List, Optional
 
-from commitizen import defaults, out
+from commitizen import defaults
 from commitizen.config import BaseConfig
 from commitizen.cz.base import BaseCommitizen
-from commitizen.error_codes import MISSING_CONFIG
+from commitizen.exceptions import MissingConfigError
 
 __all__ = ["CustomizeCommitsCz"]
 
@@ -21,8 +21,7 @@ def __init__(self, config: BaseConfig):
         super(CustomizeCommitsCz, self).__init__(config)
 
         if "customize" not in self.config.settings:
-            out.error("fatal: customize is not set in configuration file.")
-            raise SystemExit(MISSING_CONFIG)
+            raise MissingConfigError()
         self.custom_settings = self.config.settings["customize"]
 
         custom_bump_pattern = self.custom_settings.get("bump_pattern")