fix: Improve type annotations

Author: chadrik

commitizen/bump.py

@@ -4,18 +4,19 @@
 import re
 from collections import OrderedDict
 from string import Template
+from typing import cast
 
 from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message, encoding
 from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit, smart_open
-from commitizen.version_schemes import DEFAULT_SCHEME, Version, VersionScheme
+from commitizen.version_schemes import DEFAULT_SCHEME, Increment, Version, VersionScheme
 
 VERSION_TYPES = [None, PATCH, MINOR, MAJOR]
 
 
 def find_increment(
     commits: list[GitCommit], regex: str, increments_map: dict | OrderedDict
-) -> str | None:
+) -> Increment | None:
     if isinstance(increments_map, dict):
         increments_map = OrderedDict(increments_map)
 
@@ -42,7 +43,7 @@ def find_increment(
                 if increment == MAJOR:
                     break
 
-    return increment
+    return cast(Increment, increment)
 
 
 def update_version_in_files(

commitizen/commands/bump.py

@@ -26,7 +26,9 @@
 from commitizen.providers import get_provider
 from commitizen.version_schemes import (
     get_version_scheme,
+    Increment,
     InvalidVersion,
+    Prerelease,
 )
 
 logger = getLogger("commitizen")
@@ -112,7 +114,7 @@ def is_initial_tag(self, current_tag_version: str, is_yes: bool = False) -> bool
                 is_initial = questionary.confirm("Is this the first tag created?").ask()
         return is_initial
 
-    def find_increment(self, commits: list[git.GitCommit]) -> str | None:
+    def find_increment(self, commits: list[git.GitCommit]) -> Increment | None:
         # Update the bump map to ensure major version doesn't increment.
         is_major_version_zero: bool = self.bump_settings["major_version_zero"]
         # self.cz.bump_map = defaults.bump_map_major_version_zero
@@ -132,7 +134,7 @@ def find_increment(self, commits: list[git.GitCommit]) -> str | None:
         )
         return increment
 
-    def __call__(self):  # noqa: C901
+    def __call__(self) -> None:  # noqa: C901
         """Steps executed to bump."""
         provider = get_provider(self.config)
 
@@ -149,11 +151,11 @@ def __call__(self):  # noqa: C901
 
         dry_run: bool = self.arguments["dry_run"]
         is_yes: bool = self.arguments["yes"]
-        increment: str | None = self.arguments["increment"]
-        prerelease: str | None = self.arguments["prerelease"]
+        increment: Increment | None = self.arguments["increment"]
+        prerelease: Prerelease | None = self.arguments["prerelease"]
         devrelease: int | None = self.arguments["devrelease"]
         is_files_only: bool | None = self.arguments["files_only"]
-        is_local_version: bool | None = self.arguments["local_version"]
+        is_local_version: bool = self.arguments["local_version"]
         manual_version = self.arguments["manual_version"]
         build_metadata = self.arguments["build_metadata"]
 
@@ -404,7 +406,7 @@ def __call__(self):  # noqa: C901
         else:
             out.success("Done!")
 
-    def _get_commit_args(self):
+    def _get_commit_args(self) -> str:
         commit_args = ["-a"]
         if self.no_verify:
             commit_args.append("--no-verify")

commitizen/version_schemes.py

@@ -4,7 +4,16 @@
 import sys
 import warnings
 from itertools import zip_longest
-from typing import TYPE_CHECKING, Any, ClassVar, Protocol, Type, cast, runtime_checkable
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    ClassVar,
+    Literal,
+    Protocol,
+    Type,
+    cast,
+    runtime_checkable,
+)
 
 import importlib_metadata as metadata
 from packaging.version import InvalidVersion  # noqa: F401: Rexpose the common exception
@@ -28,6 +37,8 @@
         from typing import Self
 
 
+Increment: TypeAlias = Literal["MAJOR", "MINOR", "PATCH"]
+Prerelease: TypeAlias = Literal["alpha", "beta", "rc"]
 DEFAULT_VERSION_PARSER = r"v?(?P<version>([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?(\w+)?)"
 
 
@@ -113,8 +124,8 @@ def __ne__(self, other: object) -> bool:
 
     def bump(
         self,
-        increment: str,
-        prerelease: str | None = None,
+        increment: Increment | None,
+        prerelease: Prerelease | None = None,
         prerelease_offset: int = 0,
         devrelease: int | None = None,
         is_local_version: bool = False,
@@ -203,7 +214,7 @@ def generate_build_metadata(self, build_metadata: str | None) -> str:
 
         return f"+{build_metadata}"
 
-    def increment_base(self, increment: str | None = None) -> str:
+    def increment_base(self, increment: Increment | None = None) -> str:
         prev_release = list(self.release)
         increments = [MAJOR, MINOR, PATCH]
         base = dict(zip_longest(increments, prev_release, fillvalue=0))
@@ -222,8 +233,8 @@ def increment_base(self, increment: str | None = None) -> str:
 
     def bump(
         self,
-        increment: str,
-        prerelease: str | None = None,
+        increment: Increment | None,
+        prerelease: Prerelease | None = None,
         prerelease_offset: int = 0,
         devrelease: int | None = None,
         is_local_version: bool = False,