refactor(BaseConfig): rename function

Author: bearomorphism

commitizen/config/base_config.py

@@ -19,6 +19,19 @@ def settings(self) -> Settings:
     def path(self) -> Path | None:
         return self._path
 
+    """
+    mypy does not like the following until 1.16
+    See https://github.com/python/mypy/pull/18510
+    TODO: update this when 1.16 is available
+
+    @path.setter
+    def path(self, path: str | Path) -> None:
+        self._path = Path(path)
+    """
+
+    def update_path(self, path: str | Path) -> None:
+        self._path = Path(path)
+
     def set_key(self, key, value):
         """Set or update a key in the conf.
 
@@ -30,8 +43,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()

commitizen/config/json_config.py

@@ -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.update_path(path)
         self._parse_setting(data)
 
     def init_empty_config_content(self):

commitizen/config/toml_config.py

@@ -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.update_path(path)
         self._parse_setting(data)
 
     def init_empty_config_content(self):

commitizen/config/yaml_config.py

@@ -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.update_path(path)
         self._parse_setting(data)
 
     def init_empty_config_content(self):

tests/commands/test_init_command.py

@@ -3,6 +3,7 @@
 import json
 import os
 import sys
+from pathlib import Path
 from typing import Any
 
 import pytest
@@ -86,7 +87,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(path)
 
     commands.Init(config)()
     captured = capsys.readouterr()