commitizen-tools · Lee-W · May 23, 2025 · May 20, 2025 · May 20, 2025
@@ -19,6 +19,15 @@ def settings(self) -> Settings:
    def path(self) -> Path | None:
        return self._path

+    @path.setter
+    def path(self, path: str | Path) -> None:
+        """
+        mypy does not like this until 1.16
+        See https://github.com/python/mypy/pull/18510
+        TODO: remove "type: ignore" from the call sites when 1.16 is available
+        """
+        self._path = Path(path)
+
    def set_key(self, key, value):
        """Set or update a key in the conf.

@@ -30,8 +39,5 @@ def set_key(self, key, value):
    def update(self, data: Settings) -> None:
        self._settings.update(data)

-    def add_path(self, path: str | Path) -> None:
-        self._path = Path(path)
-
    def _parse_setting(self, data: bytes | str) -> None:
        raise NotImplementedError()
@@ -13,7 +13,7 @@ class JsonConfig(BaseConfig):
    def __init__(self, *, data: bytes | str, path: Path | str):
        super().__init__()
        self.is_empty_config = False
-        self.add_path(path)
+        self.path = path  # type: ignore
        self._parse_setting(data)

    def init_empty_config_content(self):

@@ -14,7 +14,7 @@ class TomlConfig(BaseConfig):
    def __init__(self, *, data: bytes | str, path: Path | str):
        super().__init__()
        self.is_empty_config = False
-        self.add_path(path)
+        self.path = path  # type: ignore
        self._parse_setting(data)

    def init_empty_config_content(self):

@@ -14,7 +14,7 @@ class YAMLConfig(BaseConfig):
    def __init__(self, *, data: bytes | str, path: Path | str):
        super().__init__()
        self.is_empty_config = False
-        self.add_path(path)
+        self.path = path  # type: ignore
        self._parse_setting(data)

    def init_empty_config_content(self):

@@ -120,7 +120,7 @@ deprecated = "^1.2.13"
 [tool.poetry.group.linters.dependencies]
 ruff = ">=0.5.0,<0.10.0"
 pre-commit = ">=2.18,<5.0"
-mypy = "^1.4"
+mypy = "^1.15.0"
 types-deprecated = "^1.2.9.2"
 types-python-dateutil = "^2.8.19.13"
 types-PyYAML = ">=5.4.3,<7.0.0"
@@ -250,12 +250,7 @@ cover.help = "Run the test suite with coverage"
 cover.ref = "test --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen"

 all.help = "Run all tasks"
-all.sequence = [
-    "format",
-    "lint",
-    "cover",
-    "check-commit",
-]
+all.sequence = ["format", "lint", "cover", "check-commit"]

 "doc:screenshots".help = "Render documentation screeenshots"
 "doc:screenshots".script = "scripts.gen_cli_help_screenshots:gen_cli_help_screenshots"
@@ -267,10 +262,7 @@ doc.help = "Live documentation server"
 doc.cmd = "mkdocs serve"

 ci.help = "Run all tasks in CI"
-ci.sequence = [
-    { cmd = "pre-commit run --all-files" },
-    "cover",
-]
+ci.sequence = [{ cmd = "pre-commit run --all-files" }, "cover"]
 ci.env = { SKIP = "no-commit-to-branch" }

 setup-pre-commit.help = "Install pre-commit hooks"

@@ -86,7 +86,7 @@ def test_init_without_setup_pre_commit_hook(tmpdir, mocker: MockFixture, config)
 def test_init_when_config_already_exists(config, capsys):
    # Set config path
    path = os.sep.join(["tests", "pyproject.toml"])
-    config.add_path(path)
+    config.path = path

    commands.Init(config)()
    captured = capsys.readouterr()

@@ -1641,7 +1641,9 @@ def test_tags_rules_get_version_tags(capsys: pytest.CaptureFixture):

 def test_changelog_file_name_from_args_and_config():
    mock_config = Mock(spec=BaseConfig)
-    mock_config.path.parent = "/my/project"
+    mock_path = Mock(spec=Path)
+    mock_path.parent = Path("/my/project")
+    mock_config.path = mock_path
    mock_config.settings = {
        "name": "cz_conventional_commits",
        "changelog_file": "CHANGELOG.md",