Merge pull request #201 from commitizen-tools/refactor-error-code

refactor: use custom exception for error handling

Author: Lee-W

commitizen/bump.py

@@ -6,7 +6,6 @@
 
 from packaging.version import Version
 
-from commitizen import out
 from commitizen.defaults import (
     MAJOR,
     MINOR,
@@ -15,7 +14,7 @@
     bump_message,
     bump_pattern,
 )
-from commitizen.error_codes import CURRENT_VERSION_NOT_FOUND
+from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit
 
 
@@ -162,12 +161,11 @@ def update_version_in_files(
                     file_content.append(line)
 
         if check_consistency and not current_version_found:
-            out.error(
+            raise CurrentVersionNotFoundError(
                 f"Current version {current_version} is not found in {location}.\n"
                 "The version defined in commitizen configuration and the ones in "
                 "version_files are possibly inconsistent."
             )
-            raise SystemExit(CURRENT_VERSION_NOT_FOUND)
 
         # Write the file out again
         with open(filepath, "w") as file:

commitizen/cli.py

@@ -2,10 +2,12 @@
 import logging
 import sys
 import warnings
+from functools import partial
 
 from decli import cli
 
-from commitizen import commands, config, out
+from commitizen import commands, config
+from commitizen.exceptions import CommitizenException, ExpectedExit, NoCommandFoundError
 
 logger = logging.getLogger(__name__)
 data = {
@@ -237,6 +239,24 @@
     },
 }
 
+original_excepthook = sys.excepthook
+
+
+def commitizen_excepthook(type, value, tracekback, debug=False):
+    if isinstance(value, CommitizenException):
+        if value.message:
+            value.output_method(value.message)
+        if debug:
+            original_excepthook(type, value, tracekback)
+        sys.exit(value.exit_code)
+    else:
+        original_excepthook(type, value, tracekback)
+
+
+commitizen_debug_excepthook = partial(commitizen_excepthook, debug=True)
+
+sys.excepthook = commitizen_excepthook
+
 
 def main():
     conf = config.read_cfg()
@@ -245,14 +265,13 @@ def main():
     # Show help if no arg provided
     if len(sys.argv) == 1:
         parser.print_help(sys.stderr)
-        raise SystemExit()
+        raise ExpectedExit()
 
     # This is for the command required constraint in 2.0
     try:
         args = parser.parse_args()
     except TypeError:
-        out.error("Command is required")
-        raise SystemExit()
+        raise NoCommandFoundError()
 
     if args.name:
         conf.update({"name": args.name})
@@ -270,19 +289,16 @@ def main():
         args.func = commands.Version
 
     if args.debug:
-        warnings.warn(
-            (
-                "Debug will be deprecated in next major version. "
-                "Please remove it from your scripts"
-            ),
-            category=DeprecationWarning,
-        )
         logging.getLogger("commitizen").setLevel(logging.DEBUG)
+        sys.excepthook = commitizen_debug_excepthook
 
     # TODO: This try block can be removed after command is required in 2.0
     # Handle the case that argument is given, but no command is provided
     try:
         args.func(conf, vars(args))()
     except AttributeError:
-        out.error("Command is required")
-        raise SystemExit()
+        raise NoCommandFoundError()
+
+
+if __name__ == "__main__":
+    main()

commitizen/commands/bump.py

@@ -6,12 +6,14 @@
 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 (
+    BumpCommitFailedError,
+    BumpTagFailedError,
+    DryRunExit,
+    ExpectedExit,
+    NoCommitsFoundError,
+    NoPatternMapError,
+    NoVersionSpecifiedError,
 )
 
 
@@ -56,8 +58,9 @@ def find_increment(self, commits: List[git.GitCommit]) -> Optional[str]:
         bump_pattern = self.cz.bump_pattern
         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(
+                f"'{self.config.settings['name']}' rule does not support bump"
+            )
         increment = bump.find_increment(
             commits, regex=bump_pattern, increments_map=bump_map
         )
@@ -68,12 +71,7 @@ def __call__(self):  # noqa: C901
         try:
             current_version_instance: Version = Version(self.bump_settings["version"])
         except TypeError:
-            out.error(
-                "[NO_VERSION_SPECIFIED]\n"
-                "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"]
@@ -101,8 +99,7 @@ def __call__(self):  # noqa: C901
         # No commits, there is no need to create an empty tag.
         # 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("[NO_COMMITS_FOUND]\n" "No new commits found.")
 
         if increment is None:
             increment = self.find_increment(commits)
@@ -129,7 +126,7 @@ def __call__(self):  # noqa: C901
 
         # Do not perform operations over files or git.
         if dry_run:
-            raise SystemExit()
+            raise DryRunExit()
 
         bump.update_version_in_files(
             current_version,
@@ -138,7 +135,7 @@ def __call__(self):  # noqa: C901
             check_consistency=self.check_consistency,
         )
         if is_files_only:
-            raise SystemExit()
+            raise ExpectedExit()
 
         if self.changelog:
             changelog = Changelog(
@@ -154,12 +151,10 @@ def __call__(self):  # noqa: C901
         self.config.set_key("version", new_version.public)
         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 BumpCommitFailedError(f'git.commit error: "{c.err.strip()}"')
         c = git.tag(new_tag_version)
         if c.err:
-            out.error(c.err)
-            raise SystemExit(TAG_FAILED)
+            raise BumpTagFailedError(c.err)
         out.success("Done!")
 
     def _get_commit_args(self):

commitizen/commands/changelog.py

@@ -5,7 +5,12 @@
 
 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 (
+    DryRunExit,
+    NoCommitsFoundError,
+    NoPatternMapError,
+    NoRevisionError,
+)
 from commitizen.git import GitTag
 
 
@@ -51,9 +56,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
 
@@ -68,12 +73,10 @@ def __call__(self):
             Callable
         ] = self.cz.changelog_message_builder_hook
         changelog_hook: Optional[Callable] = self.cz.changelog_hook
-
         if not changelog_pattern or not commit_parser:
-            out.error(
+            raise NoPatternMapError(
                 f"'{self.config.settings['name']}' rule does not support changelog"
             )
-            raise SystemExit(NO_PATTERN_MAP)
 
         tags = git.get_tags()
         if not tags:
@@ -87,8 +90,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("No commits found")
 
         tree = changelog.generate_tree_from_commits(
             commits,
@@ -104,7 +106,7 @@ def __call__(self):
 
         if self.dry_run:
             out.write(changelog_out)
-            raise SystemExit(0)
+            raise DryRunExit()
 
         lines = []
         if self.incremental and os.path.isfile(self.file_name):

commitizen/commands/check.py

@@ -1,11 +1,14 @@
 import os
 import re
-import warnings
 from typing import Dict, Optional
 
 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 (
+    InvalidCommandArgumentError,
+    InvalidCommitMessageError,
+    NoCommitsFoundError,
+)
 
 
 class Check:
@@ -29,35 +32,32 @@ def __init__(self, config: BaseConfig, arguments: Dict[str, str], cwd=os.getcwd(
 
     def _valid_command_argument(self):
         if bool(self.commit_msg_file) is bool(self.rev_range):
-            out.error(
+            raise InvalidCommandArgumentError(
                 (
                     "One and only one argument is required for check command! "
                     "See 'cz check -h' for more information"
                 )
             )
-            raise SystemExit()
 
     def __call__(self):
         """Validate if commit messages follows the conventional pattern.
 
         Raises:
-            SystemExit: if the commit provided not follows the conventional pattern
+            InvalidCommitMessageError: if the commit provided not follows the conventional pattern
         """
         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(f"No commit found with range: '{self.rev_range}'")
 
         pattern = self.cz.schema_pattern()
         for commit_msg in commit_msgs:
             if not Check.validate_commit_message(commit_msg, pattern):
-                out.error(
+                raise InvalidCommitMessageError(
                     "commit validation: failed!\n"
                     "please enter a commit message in the commitizen format.\n"
                     f"commit: {commit_msg}\n"
                     f"pattern: {pattern}"
                 )
-                raise SystemExit(INVALID_COMMIT_MSG)
         out.success("Commit validation: successful!")
 
     def _get_commit_messages(self):

commitizen/commands/commit.py

@@ -7,12 +7,13 @@
 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,
+    DryRunExit,
+    NoAnswersError,
+    NoCommitBackupError,
+    NothingToCommitError,
 )
 
 
@@ -28,8 +29,7 @@ def __init__(self, config: BaseConfig, arguments: dict):
     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:
@@ -44,20 +44,18 @@ def prompt_commit_questions(self) -> str:
         except ValueError as err:
             root_err = err.__context__
             if isinstance(root_err, CzException):
-                out.error(root_err.__str__())
-                raise SystemExit(CUSTOM_ERROR)
+                raise CustomError(root_err.__str__())
             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("No files added to staging!")
 
         retry: bool = self.arguments.get("retry")
 
@@ -69,7 +67,7 @@ def __call__(self):
         out.info(f"\n{m}\n")
 
         if dry_run:
-            raise SystemExit(NOTHING_TO_COMMIT)
+            raise DryRunExit()
 
         c = git.commit(m)
 
@@ -80,7 +78,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)