style: replace dict with Mapping

Author: bearomorphism

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.path = path  # type: ignore
+        self.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.path = path  # type: ignore
+        self.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.path = path  # type: ignore
+        self.path = path
         self._parse_setting(data)
 
     def init_empty_config_content(self):

commitizen/cz/base.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from abc import ABCMeta, abstractmethod
-from collections.abc import Iterable
+from collections.abc import Iterable, Mapping
 from typing import Any, Callable, Protocol
 
 from jinja2 import BaseLoader, PackageLoader
@@ -72,7 +72,7 @@ def questions(self) -> Questions:
         """Questions regarding the commit message."""
 
     @abstractmethod
-    def message(self, answers: dict) -> str:
+    def message(self, answers: Mapping[str, Any]) -> str:
         """Format your git message."""
 
     @property

commitizen/cz/customize/customize.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     from jinja2 import Template
@@ -48,7 +49,7 @@ def __init__(self, config: BaseConfig):
     def questions(self) -> Questions:
         return self.custom_settings.get("questions", [{}])
 
-    def message(self, answers: dict) -> str:
+    def message(self, answers: Mapping[str, Any]) -> str:
         message_template = Template(self.custom_settings.get("message_template", ""))
         if getattr(Template, "substitute", None):
             return message_template.substitute(**answers)  # type: ignore

commitizen/cz/jira/jira.py

@@ -1,4 +1,5 @@
 import os
+from collections.abc import Mapping
 
 from commitizen.cz.base import BaseCommitizen
 from commitizen.defaults import Questions
@@ -43,7 +44,7 @@ def questions(self) -> Questions:
             },
         ]
 
-    def message(self, answers: dict[str, str]) -> str:
+    def message(self, answers: Mapping[str, str]) -> str:
         return " ".join(
             x
             for k in ("message", "issues", "workflow", "time", "comment")

tests/conftest.py

@@ -3,7 +3,7 @@
 import os
 import re
 import tempfile
-from collections.abc import Iterator
+from collections.abc import Iterator, Mapping
 from pathlib import Path
 
 import pytest
@@ -209,7 +209,7 @@ def questions(self) -> list:
             },
         ]
 
-    def message(self, answers: dict) -> str:
+    def message(self, answers: Mapping) -> str:
         prefix = answers["prefix"]
         subject = answers.get("subject", "default message").trim()
         return f"{prefix}: {subject}"
@@ -225,7 +225,7 @@ class MockPlugin(BaseCommitizen):
     def questions(self) -> defaults.Questions:
         return []
 
-    def message(self, answers: dict) -> str:
+    def message(self, answers: Mapping) -> str:
         return ""
 
 

tests/test_cz_base.py

@@ -1,3 +1,5 @@
+from collections.abc import Mapping
+
 import pytest
 
 from commitizen.cz.base import BaseCommitizen
@@ -7,7 +9,7 @@ class DummyCz(BaseCommitizen):
     def questions(self):
         return [{"type": "input", "name": "commit", "message": "Initial commit:\n"}]
 
-    def message(self, answers: dict):
+    def message(self, answers: Mapping):
         return answers["commit"]