refactor(config): add CzSettings and Questions TypedDict

Author: Lee-W

commitizen/commands/init.py

@@ -49,7 +49,7 @@ def __call__(self):
             out.line(f"Config file {self.config.path} already exists")
 
     def _ask_config_path(self) -> str:
-        name = questionary.select(
+        name: str = questionary.select(
             "Please choose a supported config file: (default: pyproject.toml)",
             choices=config_files,
             default="pyproject.toml",
@@ -58,7 +58,7 @@ def _ask_config_path(self) -> str:
         return name
 
     def _ask_name(self) -> str:
-        name = questionary.select(
+        name: str = questionary.select(
             "Please choose a cz (commit rule): (default: cz_conventional_commits)",
             choices=list(registry.keys()),
             default="cz_conventional_commits",

commitizen/cz/base.py

@@ -5,11 +5,12 @@
 
 from commitizen import git
 from commitizen.config.base_config import BaseConfig
+from commitizen.defaults import Questions
 
 
 class BaseCommitizen(metaclass=ABCMeta):
     bump_pattern: Optional[str] = None
-    bump_map: Optional[dict] = None
+    bump_map: Optional[Dict[str, str]] = None
     default_style_config: List[Tuple[str, str]] = [
         ("qmark", "fg:#ff9d00 bold"),
         ("question", "bold"),
@@ -45,7 +46,7 @@ def __init__(self, config: BaseConfig):
             self.config.settings.update({"style": BaseCommitizen.default_style_config})
 
     @abstractmethod
-    def questions(self) -> list:
+    def questions(self) -> Questions:
         """Questions regarding the commit message."""
 
     @abstractmethod

commitizen/cz/conventional_commits/conventional_commits.py

@@ -1,11 +1,11 @@
 import os
 import re
 from collections import OrderedDict
-from typing import Any, Dict, List
 
 from commitizen import defaults
 from commitizen.cz.base import BaseCommitizen
 from commitizen.cz.utils import multiple_line_breaker, required_validator
+from commitizen.defaults import Questions
 
 __all__ = ["ConventionalCommitsCz"]
 
@@ -49,8 +49,8 @@ class ConventionalCommitsCz(BaseCommitizen):
         "perf": "Perf",
     }
 
-    def questions(self) -> List[Dict[str, Any]]:
-        questions: List[Dict[str, Any]] = [
+    def questions(self) -> Questions:
+        questions: Questions = [
             {
                 "type": "list",
                 "name": "prefix",

commitizen/cz/customize/customize.py

@@ -3,11 +3,12 @@
 except ImportError:
     from string import Template  # type: ignore
 
-from typing import Any, Dict, List, Optional
+from typing import Optional
 
 from commitizen import defaults
 from commitizen.config import BaseConfig
 from commitizen.cz.base import BaseCommitizen
+from commitizen.defaults import Questions
 from commitizen.exceptions import MissingCzCustomizeConfigError
 
 __all__ = ["CustomizeCommitsCz"]
@@ -37,11 +38,11 @@ def __init__(self, config: BaseConfig):
         if custom_change_type_order:
             self.change_type_order = custom_change_type_order
 
-    def questions(self) -> List[Dict[str, Any]]:
-        return self.custom_settings.get("questions")
+    def questions(self) -> Questions:
+        return self.custom_settings.get("questions", [{}])
 
     def message(self, answers: dict) -> str:
-        message_template = Template(self.custom_settings.get("message_template"))
+        message_template = Template(self.custom_settings.get("message_template", ""))
         if getattr(Template, "substitute", None):
             return message_template.substitute(**answers)  # type: ignore
         else:

commitizen/cz/jira/jira.py

@@ -1,13 +1,13 @@
 import os
-from typing import Any, Dict, List
 
 from commitizen.cz.base import BaseCommitizen
+from commitizen.defaults import Questions
 
 __all__ = ["JiraSmartCz"]
 
 
 class JiraSmartCz(BaseCommitizen):
-    def questions(self) -> List[Dict[str, Any]]:
+    def questions(self) -> Questions:
         questions = [
             {
                 "type": "input",

commitizen/defaults.py

@@ -1,8 +1,35 @@
-from collections import OrderedDict
-from typing import Any, List, Optional, Tuple, TypedDict
-
+import collections
+import pathlib
+from typing import (
+    Any,
+    Iterable,
+    List,
+    MutableMapping,
+    Optional,
+    OrderedDict,
+    Tuple,
+    TypedDict,
+    Union,
+)
 
 # Type
+Questions = Iterable[MutableMapping[str, Any]]
+
+
+class CzSettings(TypedDict, total=False):
+    bump_pattern: str
+    bump_map: OrderedDict[str, str]
+    change_type_order: List[str]
+
+    questions: Questions
+    example: Optional[str]
+    schema_pattern: Optional[str]
+    schema: Optional[str]
+    info_path: Union[str, pathlib.Path]
+    info: str
+    message_template: str
+
+
 class Settings(TypedDict, total=False):
     name: str
     version: Optional[str]
@@ -15,7 +42,7 @@ class Settings(TypedDict, total=False):
     update_changelog_on_bump: bool
     use_shortcuts: bool
     style: Optional[List[Tuple[str, str]]]
-    customize: Any
+    customize: CzSettings
 
 
 name: str = "cz_conventional_commits"
@@ -46,7 +73,7 @@ class Settings(TypedDict, total=False):
 PATCH = "PATCH"
 
 bump_pattern = r"^(BREAKING[\-\ ]CHANGE|feat|fix|refactor|perf)(\(.+\))?(!)?"
-bump_map = OrderedDict(
+bump_map = collections.OrderedDict(
     (
         (r"^.+!$", MAJOR),
         (r"^BREAKING[\-\ ]CHANGE", MAJOR),
@@ -56,9 +83,10 @@ class Settings(TypedDict, total=False):
         (r"^perf", PATCH),
     )
 )
+change_type_order = ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"]
+
 bump_message = "bump: version $current_version → $new_version"
 
-change_type_order = ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"]
 
 commit_parser = r"^(?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?:\s(?P<message>.*)?"  # noqa
 version_parser = r"(?P<version>([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?(\w+)?)"

commitizen/git.py

@@ -14,7 +14,7 @@ class GitObject:
     def __eq__(self, other) -> bool:
         if not hasattr(other, "rev"):
             return False
-        return self.rev == other.rev
+        return self.rev == other.rev  # type: ignore
 
 
 class GitCommit(GitObject):