refactor: fix mypy output and better type

Author: bearomorphism

commitizen/changelog.py

@@ -29,7 +29,7 @@
 
 import re
 from collections import OrderedDict, defaultdict
-from collections.abc import Generator, Iterable, Mapping
+from collections.abc import Generator, Iterable, Mapping, Sequence
 from dataclasses import dataclass
 from datetime import date
 from typing import TYPE_CHECKING, Any
@@ -225,7 +225,7 @@ def render_changelog(
     tree: Iterable,
     loader: BaseLoader,
     template: str,
-    **kwargs,
+    **kwargs: Any,
 ) -> str:
     jinja_template = get_changelog_template(loader, template)
     changelog: str = jinja_template.render(tree=tree, **kwargs)
@@ -282,7 +282,7 @@ def incremental_build(
 
 
 def get_smart_tag_range(
-    tags: list[GitTag], newest: str, oldest: str | None = None
+    tags: Sequence[GitTag], newest: str, oldest: str | None = None
 ) -> list[GitTag]:
     """Smart because it finds the N+1 tag.
 
@@ -308,10 +308,10 @@ def get_smart_tag_range(
 
 
 def get_oldest_and_newest_rev(
-    tags: list[GitTag],
+    tags: Sequence[GitTag],
     version: str,
     rules: TagRules,
-) -> tuple[str | None, str | None]:
+) -> tuple[str | None, str]:
     """Find the tags for the given version.
 
     `version` may come in different formats:

commitizen/cli.py

@@ -50,7 +50,7 @@ def __call__(
         namespace: argparse.Namespace,
         kwarg: str | Sequence[Any] | None,
         option_string: str | None = None,
-    ):
+    ) -> None:
         if not isinstance(kwarg, str):
             return
         if "=" not in kwarg:
@@ -551,8 +551,12 @@ def __call__(
 
 
 def commitizen_excepthook(
-    type, value, traceback, debug=False, no_raise: list[int] | None = None
-):
+    type: type,
+    value: Exception,
+    traceback: TracebackType | None,
+    debug: bool = False,
+    no_raise: list[int] | None = None,
+) -> None:
     traceback = traceback if isinstance(traceback, TracebackType) else None
     if not isinstance(value, CommitizenException):
         original_excepthook(type, value, traceback)
@@ -572,7 +576,7 @@ def commitizen_excepthook(
 
 commitizen_debug_excepthook = partial(commitizen_excepthook, debug=True)
 
-sys.excepthook = commitizen_excepthook
+sys.excepthook = commitizen_excepthook  # type: ignore
 
 
 def parse_no_raise(comma_separated_no_raise: str) -> list[int]:
@@ -582,7 +586,7 @@ def parse_no_raise(comma_separated_no_raise: str) -> list[int]:
     represents the exit code found in exceptions.
     """
     no_raise_items: list[str] = comma_separated_no_raise.split(",")
-    no_raise_codes = []
+    no_raise_codes: list[int] = []
     for item in no_raise_items:
         if item.isdecimal():
             no_raise_codes.append(int(item))
@@ -597,7 +601,7 @@ def parse_no_raise(comma_separated_no_raise: str) -> list[int]:
     return no_raise_codes
 
 
-def main():
+def main() -> None:
     parser = cli(data)
     argcomplete.autocomplete(parser)
     # Show help if no arg provided

commitizen/cmd.py

@@ -1,6 +1,7 @@
 import os
 import subprocess
-from typing import NamedTuple
+from collections.abc import Mapping
+from typing import NamedTuple, Union
 
 from charset_normalizer import from_bytes
 
@@ -28,7 +29,7 @@ def _try_decode(bytes_: bytes) -> str:
             raise CharacterSetDecodeError() from e
 
 
-def run(cmd: str, env=None) -> Command:
+def run(cmd: str, env: Union[Mapping[str, str], None] = None) -> Command:
     if env is not None:
         env = {**os.environ, **env}
     process = subprocess.Popen(

commitizen/commands/changelog.py

@@ -2,10 +2,11 @@
 
 import os
 import os.path
-from collections.abc import Generator
+from collections.abc import Generator, Iterable, Mapping
 from difflib import SequenceMatcher
 from operator import itemgetter
 from pathlib import Path
+from typing import Any, cast
 
 from commitizen import changelog, defaults, factory, git, out
 from commitizen.changelog_formats import get_changelog_format
@@ -28,7 +29,7 @@
 class Changelog:
     """Generate a changelog based on the commit history."""
 
-    def __init__(self, config: BaseConfig, args):
+    def __init__(self, config: BaseConfig, args: Mapping[str, Any]):
         if not git.is_git_project():
             raise NotAGitProjectError()
 
@@ -76,10 +77,11 @@ def __init__(self, config: BaseConfig, args):
         self.change_type_map = (
             self.config.settings.get("change_type_map") or self.cz.change_type_map
         )
-        self.change_type_order = (
+        self.change_type_order = cast(
+            list[str],
             self.config.settings.get("change_type_order")
             or self.cz.change_type_order
-            or defaults.CHANGE_TYPE_ORDER
+            or defaults.CHANGE_TYPE_ORDER,
         )
         self.rev_range = args.get("rev_range")
         self.tag_format: str = (
@@ -102,7 +104,7 @@ def __init__(self, config: BaseConfig, args):
         self.extras = args.get("extras") or {}
         self.export_template_to = args.get("export_template")
 
-    def _find_incremental_rev(self, latest_version: str, tags: list[GitTag]) -> str:
+    def _find_incremental_rev(self, latest_version: str, tags: Iterable[GitTag]) -> str:
         """Try to find the 'start_rev'.
 
         We use a similarity approach. We know how to parse the version from the markdown
@@ -151,18 +153,18 @@ def write_changelog(
 
             changelog_file.write(changelog_out)
 
-    def export_template(self):
+    def export_template(self) -> None:
         tpl = changelog.get_changelog_template(self.cz.template_loader, self.template)
-        src = Path(tpl.filename)
-        Path(self.export_template_to).write_text(src.read_text())
+        src = Path(tpl.filename)  # type: ignore
+        Path(self.export_template_to).write_text(src.read_text())  # type: ignore
 
-    def __call__(self):
+    def __call__(self) -> None:
         commit_parser = self.cz.commit_parser
         changelog_pattern = self.cz.changelog_pattern
         start_rev = self.start_rev
         unreleased_version = self.unreleased_version
         changelog_meta = changelog.Metadata()
-        change_type_map: dict | None = self.change_type_map
+        change_type_map: dict[str, str] | None = self.change_type_map  # type: ignore
         changelog_message_builder_hook: MessageBuilderHook | None = (
             self.cz.changelog_message_builder_hook
         )
@@ -190,7 +192,7 @@ def __call__(self):
             changelog_meta = self.changelog_format.get_metadata(self.file_name)
             if changelog_meta.latest_version:
                 start_rev = self._find_incremental_rev(
-                    strip_local_version(changelog_meta.latest_version_tag), tags
+                    strip_local_version(changelog_meta.latest_version_tag or ""), tags
                 )
         if self.rev_range:
             start_rev, end_rev = changelog.get_oldest_and_newest_rev(

commitizen/commands/check.py

@@ -17,7 +17,9 @@
 class Check:
     """Check if the current commit msg matches the commitizen format."""
 
-    def __init__(self, config: BaseConfig, arguments: dict[str, Any], cwd=os.getcwd()):
+    def __init__(
+        self, config: BaseConfig, arguments: dict[str, Any], cwd: str = os.getcwd()
+    ):
         """Initial check command.
 
         Args:
@@ -48,7 +50,7 @@ def __init__(self, config: BaseConfig, arguments: dict[str, Any], cwd=os.getcwd(
         self.encoding = config.settings["encoding"]
         self.cz = factory.committer_factory(self.config)
 
-    def _valid_command_argument(self):
+    def _valid_command_argument(self) -> None:
         num_exclusive_args_provided = sum(
             arg is not None
             for arg in (self.commit_msg_file, self.commit_msg, self.rev_range)
@@ -61,7 +63,7 @@ def _valid_command_argument(self):
                 "See 'cz check -h' for more information"
             )
 
-    def __call__(self):
+    def __call__(self) -> None:
         """Validate if commit messages follows the conventional pattern.
 
         Raises:
@@ -97,7 +99,7 @@ def _get_commit_message(self) -> str | None:
             # Get commit message from file (--commit-msg-file)
             return commit_file.read()
 
-    def _get_commits(self):
+    def _get_commits(self) -> list[git.GitCommit]:
         if (msg := self._get_commit_message()) is not None:
             return [git.GitCommit(rev="", title="", body=self._filter_comments(msg))]
 

commitizen/commands/commit.py

@@ -5,6 +5,8 @@
 import shutil
 import subprocess
 import tempfile
+from pathlib import Path
+from typing import Union, cast
 
 import questionary
 
@@ -105,11 +107,13 @@ def _get_message(self) -> str:
             return self.read_backup_message() or self.prompt_commit_questions()
         return self.prompt_commit_questions()
 
-    def __call__(self):
-        extra_args: str = self.arguments.get("extra_cli_args", "")
-        dry_run: bool = self.arguments.get("dry_run")
-        write_message_to_file: bool = self.arguments.get("write_message_to_file")
-        signoff: bool = self.arguments.get("signoff")
+    def __call__(self) -> None:
+        extra_args = cast(str, self.arguments.get("extra_cli_args", ""))
+        dry_run = cast(bool, self.arguments.get("dry_run"))
+        write_message_to_file = cast(
+            Union[Path, None], self.arguments.get("write_message_to_file")
+        )
+        signoff = cast(bool, self.arguments.get("signoff"))
 
         if self.arguments.get("all"):
             git.add("-u")

commitizen/commands/info.py

@@ -5,9 +5,9 @@
 class Info:
     """Show in depth explanation of your rules."""
 
-    def __init__(self, config: BaseConfig, *args):
+    def __init__(self, config: BaseConfig, *args: object):
         self.config: BaseConfig = config
         self.cz = factory.committer_factory(self.config)
 
-    def __call__(self):
+    def __call__(self) -> None:
         out.write(self.cz.info())

commitizen/commands/init.py

@@ -207,7 +207,7 @@ def _ask_tag(self) -> str:
                 raise NoAnswersError("Tag is required!")
         return latest_tag
 
-    def _ask_tag_format(self, latest_tag) -> str:
+    def _ask_tag_format(self, latest_tag: str) -> str:
         is_correct_format = False
         if latest_tag.startswith("v"):
             tag_format = r"v$version"
@@ -302,7 +302,7 @@ def _ask_update_changelog_on_bump(self) -> bool:
         ).unsafe_ask()
         return update_changelog_on_bump
 
-    def _exec_install_pre_commit_hook(self, hook_types: list[str]):
+    def _exec_install_pre_commit_hook(self, hook_types: list[str]) -> None:
         cmd_str = self._gen_pre_commit_cmd(hook_types)
         c = cmd.run(cmd_str)
         if c.return_code != 0:
@@ -323,7 +323,7 @@ def _gen_pre_commit_cmd(self, hook_types: list[str]) -> str:
         )
         return cmd_str
 
-    def _install_pre_commit_hook(self, hook_types: list[str] | None = None):
+    def _install_pre_commit_hook(self, hook_types: list[str] | None = None) -> None:
         pre_commit_config_filename = ".pre-commit-config.yaml"
         cz_hook_config = {
             "repo": "https://github.com/commitizen-tools/commitizen",
@@ -369,6 +369,6 @@ def _install_pre_commit_hook(self, hook_types: list[str] | None = None):
         self._exec_install_pre_commit_hook(hook_types)
         out.write("commitizen pre-commit hook is now installed in your '.git'\n")
 
-    def _update_config_file(self, values: dict[str, Any]):
+    def _update_config_file(self, values: dict[str, Any]) -> None:
         for key, value in values.items():
             self.config.set_key(key, value)

commitizen/commands/list_cz.py

@@ -6,8 +6,8 @@
 class ListCz:
     """List currently installed rules."""
 
-    def __init__(self, config: BaseConfig, *args):
+    def __init__(self, config: BaseConfig, *args: object):
         self.config: BaseConfig = config
 
-    def __call__(self):
+    def __call__(self) -> None:
         out.write("\n".join(registry.keys()))

commitizen/commands/version.py

@@ -1,5 +1,7 @@
 import platform
 import sys
+from collections.abc import Mapping
+from typing import Any
 
 from commitizen import out
 from commitizen.__version__ import __version__
@@ -10,13 +12,13 @@
 class Version:
     """Get the version of the installed commitizen or the current project."""
 
-    def __init__(self, config: BaseConfig, *args):
+    def __init__(self, config: BaseConfig, *args: Mapping[str, Any]):
         self.config: BaseConfig = config
         self.parameter = args[0]
         self.operating_system = platform.system()
         self.python_version = sys.version
 
-    def __call__(self):
+    def __call__(self) -> None:
         if self.parameter.get("report"):
             out.write(f"Commitizen Version: {__version__}")
             out.write(f"Python Version: {self.python_version}")

commitizen/config/base_config.py

@@ -6,7 +6,7 @@
 
 
 class BaseConfig:
-    def __init__(self):
+    def __init__(self) -> None:
         self._settings: Settings = DEFAULT_SETTINGS.copy()
         self.encoding = self.settings["encoding"]
         self._path: Path | None = None

commitizen/cz/conventional_commits/conventional_commits.py

@@ -9,7 +9,7 @@
 __all__ = ["ConventionalCommitsCz"]
 
 
-def parse_scope(text):
+def parse_scope(text: str) -> str:
     if not text:
         return ""
 
@@ -20,7 +20,7 @@ def parse_scope(text):
     return "-".join(scope)
 
 
-def parse_subject(text):
+def parse_subject(text: str) -> str:
     if isinstance(text, str):
         text = text.strip(".").strip()
 

commitizen/cz/utils.py

@@ -1,20 +1,21 @@
 import os
 import re
 import tempfile
+from typing import Union
 
 from commitizen import git
 from commitizen.cz import exceptions
 
 _RE_LOCAL_VERSION = re.compile(r"\+.+")
 
 
-def required_validator(answer, msg=None):
+def required_validator(answer: str, msg: Union[str, None] = None) -> str:
     if not answer:
         raise exceptions.AnswerRequiredError(msg)
     return answer
 
 
-def multiple_line_breaker(answer, sep="|"):
+def multiple_line_breaker(answer: str, sep: str = "|") -> str:
     return "\n".join(line.strip() for line in answer.split(sep) if line)