style(BaseConfig): update set_key comments and type annotation, remove duplicated docstring

Author: bearomorphism

commitizen/config/base_config.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from commitizen.defaults import DEFAULT_SETTINGS, Settings
 
@@ -33,11 +33,10 @@ def path(self) -> Path:
     def path(self, path: Path) -> None:
         self._path = Path(path)
 
-    def set_key(self, key: str, value: Any) -> Self:
-        """Set or update a key in the conf.
+    def set_key(self, key: str, value: object) -> Self:
+        """Set or update a key in the config file.
 
-        For now only strings are supported.
-        We use to update the version number.
+        Currently, only strings are supported for the parameter key.
         """
         raise NotImplementedError()
 

commitizen/config/json_config.py

@@ -2,7 +2,7 @@
 
 import json
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 from commitizen.exceptions import InvalidConfigurationError
 from commitizen.git import smart_open
@@ -31,18 +31,13 @@ def init_empty_config_content(self) -> None:
         ) as json_file:
             json.dump({"commitizen": {}}, json_file)
 
-    def set_key(self, key: str, value: Any) -> Self:
-        """Set or update a key in the conf.
-
-        For now only strings are supported.
-        We use to update the version number.
-        """
+    def set_key(self, key: str, value: object) -> Self:
         with open(self.path, "rb") as f:
-            parser = json.load(f)
+            config_doc = json.load(f)
 
-        parser["commitizen"][key] = value
+        config_doc["commitizen"][key] = value
         with smart_open(self.path, "w", encoding=self._settings["encoding"]) as f:
-            json.dump(parser, f, indent=2)
+            json.dump(config_doc, f, indent=2)
         return self
 
     def _parse_setting(self, data: bytes | str) -> None:

commitizen/config/toml_config.py

@@ -42,11 +42,6 @@ def init_empty_config_content(self) -> None:
             )
 
     def set_key(self, key: str, value: object) -> Self:
-        """Set or update a key in the conf.
-
-        For now only strings are supported.
-        We use to update the version number.
-        """
         with open(self.path, "rb") as f:
             config_doc = parse(f.read())
 

commitizen/config/yaml_config.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING
 
 import yaml
 
@@ -52,19 +52,14 @@ def _parse_setting(self, data: bytes | str) -> None:
         except (KeyError, TypeError):
             self.is_empty_config = True
 
-    def set_key(self, key: str, value: Any) -> Self:
-        """Set or update a key in the conf.
-
-        For now only strings are supported.
-        We use to update the version number.
-        """
+    def set_key(self, key: str, value: object) -> Self:
         with open(self.path, "rb") as yaml_file:
-            parser = yaml.load(yaml_file, Loader=yaml.FullLoader)
+            config_doc = yaml.load(yaml_file, Loader=yaml.FullLoader)
 
-        parser["commitizen"][key] = value
+        config_doc["commitizen"][key] = value
         with smart_open(
             self.path, "w", encoding=self._settings["encoding"]
         ) as yaml_file:
-            yaml.dump(parser, yaml_file, explicit_start=True)
+            yaml.dump(config_doc, yaml_file, explicit_start=True)
 
         return self