refactor(questions): type questions with TypedDict #1485
+50
−14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bearomorphism
commented
May 31, 2025
| @@ -52,7 +52,7 @@ 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): | |||
| for question in (q for q in questions if q["type"] == "list"): | |||
There was a problem hiding this comment.
type inference only works this way
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## refactors #1485 +/- ##
=============================================
+ Coverage 97.87% 97.88% +0.01%
=============================================
Files 57 58 +1
Lines 2677 2700 +23
=============================================
+ Hits 2620 2643 +23
Misses 57 57
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Lee-W
reviewed
Jun 8, 2025
| @@ -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 | |||
There was a problem hiding this comment.
we might be able to move it to type_checking. but this can be next pr or let ruff handle it in the future
Lee-W
reviewed
Jun 8, 2025
| # Type | ||
| Questions = Iterable[MutableMapping[str, Any]] | ||
| Questions = Iterable[MutableMapping[str, Any]] # TODO: deprecate this? |
Lee-W
approved these changes
Jun 8, 2025
baee83e to
a9cd957
Compare
0a2c7b3 to
f18342b
Compare
This was referenced Jun 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
A better version of #1467
Make the type of questions more strict. Not sure whether we should deprecate the type
Questions.Checklist
Code Changes
poetry alllocally to ensure this change passes linter check and testsDocumentation Changes
poetry doclocally to ensure the documentation pages renders correctlyExpected Behavior
Steps to Test This Pull Request
Additional Context