style(mypy): add return type to all functions

Author: Lee-W

commitizen/bump.py

@@ -132,7 +132,7 @@ def generate_version(
 
 def update_version_in_files(
     current_version: str, new_version: str, files: List[str], *, check_consistency=False
-):
+) -> None:
     """Change old version to the new one in every file given.
 
     Note that this version is not the tag formatted one.
@@ -196,7 +196,7 @@ def _version_to_regex(version: str):
     return re.compile(f"{clean_regex}")
 
 
-def create_tag(version: Union[Version, str], tag_format: Optional[str] = None):
+def create_tag(version: Union[Version, str], tag_format: Optional[str] = None) -> str:
     """The tag and the software version might be different.
 
     That's why this function exists.

commitizen/config/base_config.py

@@ -25,11 +25,11 @@ def set_key(self, key, value):
         """
         raise NotImplementedError()
 
-    def update(self, data: dict):
+    def update(self, data: dict) -> None:
         self._settings.update(data)
 
-    def add_path(self, path: Union[str, Path]):
+    def add_path(self, path: Union[str, Path]) -> None:
         self._path = Path(path)
 
-    def _parse_setting(self, data: Union[bytes, str]) -> dict:
+    def _parse_setting(self, data: Union[bytes, str]) -> None:
         raise NotImplementedError()

commitizen/config/json_config.py

@@ -30,7 +30,7 @@ def set_key(self, key, value):
             json.dump(parser, f, indent=2)
         return self
 
-    def _parse_setting(self, data: Union[bytes, str]):
+    def _parse_setting(self, data: Union[bytes, str]) -> None:
         """We expect to have a section in .cz.json looking like
 
         ```

commitizen/config/toml_config.py

@@ -41,7 +41,7 @@ def set_key(self, key, value):
             f.write(parser.as_string().encode("utf-8"))
         return self
 
-    def _parse_setting(self, data: Union[bytes, str]):
+    def _parse_setting(self, data: Union[bytes, str]) -> None:
         """We expect to have a section in pyproject looking like
 
         ```

commitizen/config/yaml_config.py

@@ -17,7 +17,7 @@ def init_empty_config_content(self):
         with open(self.path, "a") as json_file:
             yaml.dump({"commitizen": {}}, json_file)
 
-    def _parse_setting(self, data: Union[bytes, str]):
+    def _parse_setting(self, data: Union[bytes, str]) -> None:
         """We expect to have a section in cz.yaml looking like
 
         ```

commitizen/defaults.py

@@ -1,5 +1,20 @@
 from collections import OrderedDict
-from typing import Any, Dict, List
+from typing import List, Optional, TypedDict
+
+
+# Type
+class Settings(TypedDict):
+    name: str
+    version: Optional[str]
+    version_files: List[str]
+    tag_format: Optional[str]
+    bump_message: Optional[str]
+    changelog_file: str
+    changelog_incremental: bool
+    changelog_start_rev: Optional[str]
+    update_changelog_on_bump: bool
+    use_shortcuts: bool
+
 
 name: str = "cz_conventional_commits"
 config_files: List[str] = [
@@ -11,7 +26,7 @@
     "cz.yaml",
 ]
 
-DEFAULT_SETTINGS: Dict[str, Any] = {
+DEFAULT_SETTINGS: Settings = {
     "name": "cz_conventional_commits",
     "version": None,
     "version_files": [],

commitizen/git.py

@@ -54,12 +54,12 @@ def from_line(cls, line: str, inner_delimiter: str) -> "GitTag":
         return cls(name=name, rev=obj, date=date)
 
 
-def tag(tag: str, annotated: bool = False):
+def tag(tag: str, annotated: bool = False) -> cmd.Command:
     c = cmd.run(f"git tag -a {tag} -m {tag}" if annotated else f"git tag {tag}")
     return c
 
 
-def commit(message: str, args: str = ""):
+def commit(message: str, args: str = "") -> cmd.Command:
     f = NamedTemporaryFile("wb", delete=False)
     f.write(message.encode("utf-8"))
     f.close()

commitizen/out.py

@@ -3,27 +3,27 @@
 from termcolor import colored
 
 
-def write(value: str, *args):
+def write(value: str, *args) -> None:
     """Intended to be used when value is multiline."""
     print(value, *args)
 
 
-def line(value: str, *args, **kwargs):
+def line(value: str, *args, **kwargs) -> None:
     """Wrapper in case I want to do something different later."""
     print(value, *args, **kwargs)
 
 
-def error(value: str):
+def error(value: str) -> None:
     message = colored(value, "red")
     line(message, file=sys.stderr)
 
 
-def success(value: str):
+def success(value: str) -> None:
     message = colored(value, "green")
     line(message)
 
 
-def info(value: str):
+def info(value: str) -> None:
     message = colored(value, "blue")
     line(message)