refactor(questions): type questions with TypedDict #1485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

Lee-W merged 1 commit into commitizen-tools:refactors from bearomorphism:typed-questions

Jun 8, 2025

Merged

refactor(questions): type questions with TypedDict #1485

Lee-W merged 1 commit into commitizen-tools:refactors from bearomorphism:typed-questions

Jun 8, 2025

Conversation

bearomorphism

Copy link

Contributor

@bearomorphism bearomorphism commented May 31, 2025 •

edited

Loading

Description

A better version of #1467

Make the type of questions more strict. Not sure whether we should deprecate the type Questions.

Checklist

I have read the contributing guidelines

Code Changes

Add test cases to all the changes you introduce
Run poetry all locally to ensure this change passes linter check and tests
Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
Update the documentation for the changes

Documentation Changes

Run poetry doc locally to ensure the documentation pages renders correctly
- Check if there are any broken links in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:
INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

@bearomorphism bearomorphism requested review from woile, Lee-W and noirbizarre as code owners

May 31, 2025 15:31

@github-actions github-actions bot added pr-status: wait-for-review type: refactor labels

May 31, 2025

bearomorphism

bearomorphism commented

May 31, 2025

View reviewed changes

commitizen/commands/commit.py Show resolved Hide resolved

@codecov Codecov

Copy link

codecov bot commented May 31, 2025 •

edited

Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.88%. Comparing base (a9cd957) to head (f18342b).
Report is 7 commits behind head on refactors.

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

Flag	Coverage Δ
unittests	`97.88% <100.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Lee-W

Lee-W reviewed

Jun 8, 2025

View reviewed changes

commitizen/cz/base.py Show resolved Hide resolved

Lee-W

Lee-W reviewed

Jun 8, 2025

View reviewed changes

commitizen/defaults.py

# Type

Questions = Iterable[MutableMapping[str, Any]]

Questions = Iterable[MutableMapping[str, Any]]# TODO: deprecate this?

Copy link

Member

@Lee-W Lee-W Jun 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good

Lee-W

Lee-W approved these changes

Jun 8, 2025

View reviewed changes

Copy link

Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly good; respond to one of your questions. Let me know if you want to address it in this PR or the next. Thanks!

@Lee-W Lee-W added pr-status: ready-to-merge and removed pr-status: wait-for-review labels

Jun 8, 2025

@Lee-W Lee-W force-pushed the refactors branch 2 times, most recently from baee83e to a9cd957 Compare

June 8, 2025 13:31

@bearomorphism


 refactor(questions): type questions with TypedDict

f18342b

@bearomorphism bearomorphism force-pushed the typed-questions branch from 0a2c7b3 to f18342b Compare

June 8, 2025 14:00

This was referenced Jun 8, 2025

Deprecate Questions in defaults.py #1514

Closed

we might be able to move it to type_checking. but this can be next pr or let ruff handle it in the future #1515

Open

@github-actions github-actions bot added the pr-status: wait-for-review label

Jun 8, 2025

@bearomorphism bearomorphism mentioned this pull request

Jun 8, 2025

4.8.3 candidate #1457

Merged

10 tasks

Lee-W

Lee-W approved these changes

Jun 8, 2025

View reviewed changes

@Lee-W Lee-W merged commit 626e67c into commitizen-tools:refactors

Jun 8, 2025

18 checks passed

@bearomorphism bearomorphism deleted the typed-questions branch

June 13, 2025 05:10

Labels

pr-status: ready-to-merge pr-status: wait-for-review type: refactor

2 participants

@bearomorphism @Lee-W

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(questions): type questions with TypedDict #1485

refactor(questions): type questions with TypedDict #1485

Uh oh!

Conversation

@bearomorphism bearomorphism commented May 31, 2025 •

edited

Loading

Uh oh!

Description

Checklist

Code Changes

Documentation Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

Uh oh!

codecov bot commented May 31, 2025 •

edited

Loading

Uh oh!

Codecov Report

Uh oh!

Uh oh!

@Lee-W Lee-W Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

refactor(questions): type questions with TypedDict #1485

refactor(questions): type questions with TypedDict #1485

Uh oh!

Conversation

@bearomorphism bearomorphism commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Code Changes

Documentation Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

Uh oh!

codecov bot commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

@Lee-W Lee-W Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

@bearomorphism bearomorphism commented May 31, 2025 •

edited

Loading

codecov bot commented May 31, 2025 •

edited

Loading