Skip to content

refactor(BaseConfig): update docstring, extract factory method and re… #1601

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.

Sign up for GitHub

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
Open
wants to merge 1 commit into
base: v4-9-2
Choose a base branch
from
Open

refactor(BaseConfig): update docstring, extract factory method and re… #1601

wants to merge 1 commit into from

Conversation

@bearomorphism
Copy link
Contributor

…move unnecessary variable assignment

Description

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 and fix any broken links (internal or external) 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

@codecov
Copy link

codecov bot commented Sep 14, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 97.05882% with 2 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (v4-9-2@a472bea). Learn more about missing BASE report.

Files with missing lines Patch % Lines
commitizen/config/__init__.py 95.65% 1 Missing ⚠️
commitizen/config/factory.py 92.85% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff            @@
##             v4-9-2    #1601   +/-   ##
=========================================
  Coverage          ?   98.25%           
=========================================
  Files             ?       59           
  Lines             ?     2690           
  Branches          ?        0           
=========================================
  Hits              ?     2643           
  Misses            ?       47           
  Partials          ?        0
Flag Coverage Δ
unittests 98.25% <97.05%> (?)

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.

bearomorphism
bearomorphism commented Sep 14, 2025
View reviewed changes
commitizen/config/json_config.py Outdated


class JsonConfig(BaseConfig):
def __init__(self, *, data: bytes | str, path: Path | str) -> None:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can remove the str of the parameter path in the future? I'm not sure if that will be a breaking change

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine to remove the str, at most, it would generate a mypy error

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed | str

bearomorphism
bearomorphism commented Sep 14, 2025
View reviewed changes
commitizen/config/base_config.py
def __init__(self) -> None:
self.is_empty_config = False
self._settings: Settings = DEFAULT_SETTINGS.copy()
self.encoding = self.settings["encoding"]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure why this member variable exists. It will be stale if self._settings is updated somewhere.

@bearomorphism bearomorphism marked this pull request as draft September 15, 2025 02:33
@bearomorphism bearomorphism marked this pull request as ready for review September 15, 2025 05:06
bearomorphism
bearomorphism commented Sep 15, 2025
View reviewed changes
commitizen/config/base_config.py
from typing import Self


class BaseConfig:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should this be an abstract class?

Copy link
Member

Choose a reason for hiding this comment

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

Ideally, a Protocol, but it doesn't hurt like this

Copy link
Contributor Author

@bearomorphism bearomorphism Sep 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks. I found it odd that we can create BaseConfig objects and it's sometimes confusing. I attempted to refactor it on another branch (not published yet) but many tests would be affected.

@Lee-W Lee-W added this to the 4.9.2 milestone Sep 15, 2025
@bearomorphism bearomorphism changed the base branch from master to v4-9-2 September 18, 2025 17:54
@bearomorphism bearomorphism mentioned this pull request Sep 19, 2025
Open
@Lee-W Lee-W modified the milestones: 4.10.1, 4.10.0 Sep 19, 2025
@bearomorphism bearomorphism force-pushed the refactor-config branch 2 times, most recently from 44419b9 to 02d15ef Compare September 20, 2025 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@woile woile Awaiting requested review from woile woile is a code owner

@Lee-W Lee-W Awaiting requested review from Lee-W Lee-W is a code owner

@noirbizarre noirbizarre Awaiting requested review from noirbizarre noirbizarre is a code owner

Assignees

No one assigned

Labels

pr-status: wait-for-review type: documentation type: refactor

Projects

None yet

Milestone

4.10.0

Development

Successfully merging this pull request may close these issues.

3 participants

@bearomorphism @woile @Lee-W