refactor(question): strict type with pydantic for questions

Author: bearomorphism

commitizen/commands/commit.py

@@ -24,6 +24,7 @@
     NothingToCommitError,
 )
 from commitizen.git import smart_open
+from commitizen.question import ListQuestion
 
 
 class Commit:
@@ -52,10 +53,12 @@ def prompt_commit_questions(self) -> str:
         # Prompt user for the commit message
         cz = self.cz
         questions = cz.questions()
-        for question in filter(lambda q: q["type"] == "list", questions):
-            question["use_shortcuts"] = self.config.settings["use_shortcuts"]
+        for question in (q for q in questions if isinstance(q, ListQuestion)):
+            question.use_shortcuts = self.config.settings["use_shortcuts"]
         try:
-            answers = questionary.prompt(questions, style=cz.style)
+            answers = questionary.prompt(
+                (q.model_dump() for q in questions), style=cz.style
+            )
         except ValueError as err:
             root_err = err.__context__
             if isinstance(root_err, CzException):

commitizen/cz/base.py

@@ -9,7 +9,7 @@
 
 from commitizen import git
 from commitizen.config.base_config import BaseConfig
-from commitizen.defaults import Questions
+from commitizen.question import CzQuestion
 
 
 class MessageBuilderHook(Protocol):
@@ -68,7 +68,7 @@ def __init__(self, config: BaseConfig) -> None:
             self.config.settings.update({"style": BaseCommitizen.default_style_config})
 
     @abstractmethod
-    def questions(self) -> Questions:
+    def questions(self) -> list[CzQuestion]:
         """Questions regarding the commit message."""
 
     @abstractmethod

commitizen/cz/conventional_commits/conventional_commits.py

@@ -4,7 +4,7 @@
 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
+from commitizen.question import CzQuestion, CzQuestionModel
 
 __all__ = ["ConventionalCommitsCz"]
 
@@ -40,8 +40,8 @@ class ConventionalCommitsCz(BaseCommitizen):
     }
     changelog_pattern = defaults.BUMP_PATTERN
 
-    def questions(self) -> Questions:
-        return [
+    def questions(self) -> list[CzQuestion]:
+        questions = [
             {
                 "type": "list",
                 "name": "prefix",
@@ -146,6 +146,9 @@ def questions(self) -> Questions:
                 ),
             },
         ]
+        return [
+            CzQuestionModel.model_validate({"question": q}).question for q in questions
+        ]
 
     def message(self, answers: dict) -> str:
         prefix = answers["prefix"]

commitizen/cz/customize/customize.py

@@ -2,6 +2,8 @@
 
 from typing import TYPE_CHECKING
 
+from commitizen.question import CzQuestion, CzQuestionModel
+
 if TYPE_CHECKING:
     from jinja2 import Template
 else:
@@ -14,7 +16,6 @@
 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"]
@@ -45,8 +46,11 @@ def __init__(self, config: BaseConfig):
             if value := self.custom_settings.get(attr_name):
                 setattr(self, attr_name, value)
 
-    def questions(self) -> Questions:
-        return self.custom_settings.get("questions", [{}])
+    def questions(self) -> list[CzQuestion]:
+        questions = self.custom_settings.get("questions", [{}])
+        return [
+            CzQuestionModel.model_validate({"question": q}).question for q in questions
+        ]
 
     def message(self, answers: dict) -> str:
         message_template = Template(self.custom_settings.get("message_template", ""))

commitizen/cz/jira/jira.py

@@ -1,14 +1,14 @@
 import os
 
 from commitizen.cz.base import BaseCommitizen
-from commitizen.defaults import Questions
+from commitizen.question import CzQuestion, CzQuestionModel
 
 __all__ = ["JiraSmartCz"]
 
 
 class JiraSmartCz(BaseCommitizen):
-    def questions(self) -> Questions:
-        return [
+    def questions(self) -> list[CzQuestion]:
+        questions = [
             {
                 "type": "input",
                 "name": "message",
@@ -42,6 +42,9 @@ def questions(self) -> Questions:
                 "filter": lambda x: "#comment " + x if x else "",
             },
         ]
+        return [
+            CzQuestionModel.model_validate({"question": q}).question for q in questions
+        ]
 
     def message(self, answers: dict) -> str:
         return " ".join(

commitizen/question.py

@@ -0,0 +1,49 @@
+from typing import Callable, Literal, Optional, Union
+
+from pydantic import BaseModel, Field
+
+
+class CzModel(BaseModel):
+    def model_dump(self, **kwargs):
+        return super().model_dump(exclude_unset=True, **kwargs)
+
+
+class Choice(CzModel):
+    value: str
+    name: str
+    key: Optional[str] = None
+
+
+class QuestionBase(CzModel):
+    name: str
+    message: str
+
+
+class ListQuestion(QuestionBase):
+    type: Literal["list"]
+    choices: list[Choice]
+    use_shortcuts: Optional[bool] = None
+
+
+class SelectQuestion(QuestionBase):
+    type: Literal["select"]
+    choices: list[Choice]
+    use_search_filter: Optional[bool] = None  # TODO: confirm type
+    use_jk_keys: Optional[bool] = None
+
+
+class InputQuestion(QuestionBase):
+    type: Literal["input"]
+    filter: Optional[Callable[[str], str]] = None
+
+
+class ConfirmQuestion(QuestionBase):
+    type: Literal["confirm"]
+    default: Optional[bool] = None
+
+
+CzQuestion = Union[ListQuestion, SelectQuestion, InputQuestion, ConfirmQuestion]
+
+
+class CzQuestionModel(CzModel):
+    question: CzQuestion = Field(discriminator="type")

tests/conftest.py

@@ -17,6 +17,7 @@
 from commitizen.config import BaseConfig
 from commitizen.cz import registry
 from commitizen.cz.base import BaseCommitizen
+from commitizen.question import CzQuestion
 from tests.utils import create_file_and_commit
 
 SIGNER = "GitHub Action"
@@ -222,7 +223,7 @@ def use_cz_semver(mocker):
 
 
 class MockPlugin(BaseCommitizen):
-    def questions(self) -> defaults.Questions:
+    def questions(self) -> list[CzQuestion]:
         return []
 
     def message(self, answers: dict) -> str:

tests/test_cz_conventional_commits.py

@@ -6,6 +6,7 @@
     parse_subject,
 )
 from commitizen.cz.exceptions import AnswerRequiredError
+from commitizen.question import ListQuestion
 
 valid_scopes = ["", "simple", "dash-separated", "camelCaseUPPERCASE"]
 
@@ -50,16 +51,15 @@ def test_questions(config):
     conventional_commits = ConventionalCommitsCz(config)
     questions = conventional_commits.questions()
     assert isinstance(questions, list)
-    assert isinstance(questions[0], dict)
 
 
 def test_choices_all_have_keyboard_shortcuts(config):
     conventional_commits = ConventionalCommitsCz(config)
     questions = conventional_commits.questions()
 
-    list_questions = (q for q in questions if q["type"] == "list")
+    list_questions = (q for q in questions if isinstance(q, ListQuestion))
     for select in list_questions:
-        assert all("key" in choice for choice in select["choices"])
+        assert all(choice.key is not None for choice in select.choices)
 
 
 def test_small_answer(config):

tests/test_cz_customize.py

@@ -443,7 +443,7 @@ def test_questions(config):
             "message": "Do you want to add body message in commit?",
         },
     ]
-    assert list(questions) == expected_questions
+    assert [q.model_dump() for q in questions] == expected_questions
 
 
 def test_questions_unicode(config_with_unicode):
@@ -466,7 +466,7 @@ def test_questions_unicode(config_with_unicode):
             "message": "Do you want to add body message in commit?",
         },
     ]
-    assert list(questions) == expected_questions
+    assert [q.model_dump() for q in questions] == expected_questions
 
 
 def test_answer(config):

tests/test_cz_jira.py

@@ -5,7 +5,6 @@ def test_questions(config):
     cz = JiraSmartCz(config)
     questions = cz.questions()
     assert isinstance(questions, list)
-    assert isinstance(questions[0], dict)
 
 
 def test_answer(config):

tests/test_cz_search_filter.py

@@ -2,6 +2,7 @@
 
 from commitizen.config import TomlConfig
 from commitizen.cz.customize import CustomizeCommitsCz
+from commitizen.question import SelectQuestion
 
 TOML_WITH_SEARCH_FILTER = r"""
 [tool.commitizen]
@@ -48,19 +49,21 @@ def config():
 def test_questions_with_search_filter(config):
     """Test that questions are properly configured with search filter"""
     cz = CustomizeCommitsCz(config)
-    questions = cz.questions()
+    question = cz.questions()[0]
+
+    assert isinstance(question, SelectQuestion)
 
     # Test that the first question (change_type) has search filter enabled
-    assert questions[0]["type"] == "select"
-    assert questions[0]["name"] == "change_type"
-    assert questions[0]["use_search_filter"] is True
-    assert questions[0]["use_jk_keys"] is False
+    assert question.type == "select"
+    assert question.name == "change_type"
+    assert question.use_search_filter is True
+    assert question.use_jk_keys is False
 
     # Test that the choices are properly configured
-    choices = questions[0]["choices"]
+    choices = question.choices
     assert len(choices) == 9  # We have 9 commit types
-    assert choices[0]["value"] == "fix"
-    assert choices[1]["value"] == "feat"
+    assert choices[0].value == "fix"
+    assert choices[1].value == "feat"
 
 
 def test_message_template(config):