refactor(BaseConfig): update function name, upgrade mypy version

[bearomorphism]

Description

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

Expected Behavior

Steps to Test This Pull Request

Additional Context

[bearomorphism]

I just found this method name confusing. It's actually updating the path, right?

[Lee-W]

I think the main reason we make it this way is that we want to handle both str and Path implicitly. We probably could use a setter if that's better

[bearomorphism]

OK I was trying the following

    @property
    def path(self) -> Path | None:
        return self._path

    @path.setter
    def path(self, path: str | Path) -> None:
        self._path = Path(path)

but mypy isn't happy

commitizen/config/yaml_config.py:17: error: Incompatible types in assignment (expression has type "Path | str", variable has type "Path | None")  [assignment]
commitizen/config/toml_config.py:17: error: Incompatible types in assignment (expression has type "Path | str", variable has type "Path | None")  [assignment]
commitizen/config/json_config.py:16: error: Incompatible types in assignment (expression has type "Path | str", variable has type "Path | None")  [assignment]

I'm taking a look at related issues and PRs. Updating mypy to 1.15.0 does not work for me.

• What to do about setters of a different type than their property? python/mypy#3004
• Support properties with setter type different from getter type python/mypy#18510

[bearomorphism]

Looks like python/mypy#18510 will be part of 1.16.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.57%. Comparing base (120d514) to head (117e61c).
Report is 619 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1444      +/-   ##
==========================================
+ Coverage   97.33%   97.57%   +0.23%     
==========================================
  Files          42       57      +15     
  Lines        2104     2682     +578     
==========================================
+ Hits         2048     2617     +569     
- Misses         56       65       +9     

Flag	Coverage Δ
unittests	97.57% <100.00%> (+0.23%)	⬆️

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.