Skip to content

Add type hints for cli.py #1479

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

Merged
merged 3 commits into from
May 31, 2025
Merged

Conversation

gbaian10
Copy link
Contributor

@gbaian10 gbaian10 commented May 31, 2025

Description

Resolves #1477

I hope this can be merged into the refactors branch instead of master.

Checklist

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

Copy link
Contributor

@bearomorphism bearomorphism left a comment

Choose a reason for hiding this comment

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

👍👍👍

config: str | None = None
debug: bool = False
name: str | None = None
no_raise: str | None = None
Copy link
Member

Choose a reason for hiding this comment

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

We could probably add a comment mentioning that it will later be parsed as list[int]. A bit confusing at the first glance

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

Copy link

codecov bot commented May 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.82%. Comparing base (c0220cd) to head (b5b76a0).
Report is 5 commits behind head on refactors.

Additional details and impacted files
@@            Coverage Diff             @@
##           refactors    #1479   +/-   ##
==========================================
  Coverage      97.82%   97.82%           
==========================================
  Files             57       57           
  Lines           2618     2619    +1     
==========================================
+ Hits            2561     2562    +1     
  Misses            57       57           
Flag Coverage Δ
unittests 97.82% <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.

gbaian10 added 2 commits May 31, 2025 13:55
Since the project requires Python >=3.9, argparse only raises SystemExit
when non-existent commands are provided, making TypeError handling unnecessary.
@Lee-W Lee-W merged commit 59fd3f5 into commitizen-tools:refactors May 31, 2025
18 checks passed
@gbaian10 gbaian10 deleted the cli-type-hints branch May 31, 2025 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants