refactor: address review comments on PR #1932

- tests/test_cz_conventional_commits.py: use type annotations instead of
  cast() for answers dicts (avoids ty limitation with dict literal inference)
- config/__init__.py: widen read_cfg to accept str | Path | None
- tests/test_conf.py: revert str() wrapper now that read_cfg accepts Path
- changelog.py: add comment explaining ty limitation requiring cast
- version_schemes.py: add comment explaining ty limitation requiring cast

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: bearomorphism

commitizen/changelog.py

@@ -194,6 +194,7 @@ def process_commit_message(
     for msg in messages:
         if not isinstance(msg, dict):
             continue
+        # cast needed: ty cannot narrow dict type from Iterable union
         msg_dict = cast("dict[str, Any]", msg)
         change_type = msg_dict.pop("change_type", None)
         if change_type_map and change_type:

commitizen/config/__init__.py

@@ -31,7 +31,7 @@ def _create_config_from_path(path: Path) -> BaseConfig:
     return create_config(data=path.read_bytes(), path=path)
 
 
-def read_cfg(filepath: str | None = None) -> BaseConfig:
+def read_cfg(filepath: str | Path | None = None) -> BaseConfig:
     if filepath is not None:
         conf_path = Path(filepath)
         if not conf_path.is_file():

commitizen/version_schemes.py

@@ -385,6 +385,7 @@ def _get_prerelease(self) -> str:
         return ".".join(prerelease_parts)
 
 
+# cast needed: ty cannot resolve type[Pep440] as type[VersionProtocol]
 DEFAULT_SCHEME: VersionScheme = cast("VersionScheme", Pep440)
 
 SCHEMES_ENTRYPOINT = "commitizen.scheme"

tests/test_conf.py

@@ -346,7 +346,7 @@ def test_no_warn_with_explicit_config_path(self, tmp_path, monkeypatch, capsys):
         (tmp_path / ".cz.json").write_text(JSON_STR)
 
         # Read config with explicit path
-        cfg = config.read_cfg(str(Path(".cz.json")))
+        cfg = config.read_cfg(Path(".cz.json"))
 
         # No warning should be issued
         captured = capsys.readouterr()

tests/test_cz_conventional_commits.py

@@ -1,5 +1,3 @@
-from typing import cast
-
 import pytest
 
 from commitizen.cz.conventional_commits.conventional_commits import (
@@ -61,29 +59,29 @@ def test_choices_all_have_keyboard_shortcuts(config):
 
 def test_small_answer(config):
     conventional_commits = ConventionalCommitsCz(config)
-    answers = {
+    answers: ConventionalCommitsAnswers = {
         "prefix": "fix",
         "scope": "users",
         "subject": "email pattern corrected",
         "is_breaking_change": False,
         "body": "",
         "footer": "",
     }
-    message = conventional_commits.message(cast("ConventionalCommitsAnswers", answers))
+    message = conventional_commits.message(answers)
     assert message == "fix(users): email pattern corrected"
 
 
 def test_long_answer(config):
     conventional_commits = ConventionalCommitsCz(config)
-    answers = {
+    answers: ConventionalCommitsAnswers = {
         "prefix": "fix",
         "scope": "users",
         "subject": "email pattern corrected",
         "is_breaking_change": False,
         "body": "complete content",
         "footer": "closes #24",
     }
-    message = conventional_commits.message(cast("ConventionalCommitsAnswers", answers))
+    message = conventional_commits.message(answers)
     assert (
         message
         == "fix(users): email pattern corrected\n\ncomplete content\n\ncloses #24"
@@ -92,15 +90,15 @@ def test_long_answer(config):
 
 def test_breaking_change_in_footer(config):
     conventional_commits = ConventionalCommitsCz(config)
-    answers = {
+    answers: ConventionalCommitsAnswers = {
         "prefix": "fix",
         "scope": "users",
         "subject": "email pattern corrected",
         "is_breaking_change": True,
         "body": "complete content",
         "footer": "migrate by renaming user to users",
     }
-    message = conventional_commits.message(cast("ConventionalCommitsAnswers", answers))
+    message = conventional_commits.message(answers)
     print(message)
     assert (
         message
@@ -145,15 +143,15 @@ def test_breaking_change_message_formats(
         breaking_change_exclamation_in_title
     )
     conventional_commits = ConventionalCommitsCz(config)
-    answers = {
+    answers: ConventionalCommitsAnswers = {
         "prefix": "feat",
         "scope": scope,
         "subject": "email pattern corrected",
         "is_breaking_change": True,
         "body": "complete content",
         "footer": "migrate by renaming user to users",
     }
-    message = conventional_commits.message(cast("ConventionalCommitsAnswers", answers))
+    message = conventional_commits.message(answers)
     assert message == expected_message