refactor: remove self.encoding for better maintainability

Author: bearomorphism

commitizen/changelog_formats/base.py

@@ -24,7 +24,6 @@ def __init__(self, config: BaseConfig) -> None:
         # Constructor needs to be redefined because `Protocol` prevent instantiation by default
         # See: https://bugs.python.org/issue44807
         self.config = config
-        self.encoding = self.config.settings["encoding"]
         self.tag_rules = TagRules(
             scheme=get_version_scheme(self.config.settings),
             tag_format=self.config.settings["tag_format"],
@@ -36,7 +35,9 @@ def get_metadata(self, filepath: str) -> Metadata:
         if not os.path.isfile(filepath):
             return Metadata()
 
-        with open(filepath, encoding=self.encoding) as changelog_file:
+        with open(
+            filepath, encoding=self.config.settings["encoding"]
+        ) as changelog_file:
             return self.get_metadata_from_file(changelog_file)
 
     def get_metadata_from_file(self, file: IO[Any]) -> Metadata:

commitizen/commands/bump.py

@@ -67,7 +67,6 @@ def __init__(self, config: BaseConfig, arguments: BumpArgs) -> None:
             raise NotAGitProjectError()
 
         self.config: BaseConfig = config
-        self.encoding = config.settings["encoding"]
         self.arguments = arguments
         self.bump_settings = cast(
             BumpArgs,
@@ -335,7 +334,7 @@ def __call__(self) -> None:
                 str(new_version),
                 self.bump_settings["version_files"],
                 check_consistency=self.check_consistency,
-                encoding=self.encoding,
+                encoding=self.config.settings["encoding"],
             )
         )
 

commitizen/commands/changelog.py

@@ -67,7 +67,6 @@ def __init__(self, config: BaseConfig, arguments: ChangelogArgs) -> None:
             else changelog_file_name
         )
 
-        self.encoding = self.config.settings["encoding"]
         self.cz = factory.committer_factory(self.config)
 
         self.start_rev = arguments.get("start_rev") or self.config.settings.get(
@@ -157,7 +156,9 @@ def _find_incremental_rev(self, latest_version: str, tags: Iterable[GitTag]) ->
     def _write_changelog(
         self, changelog_out: str, lines: list[str], changelog_meta: changelog.Metadata
     ) -> None:
-        with smart_open(self.file_name, "w", encoding=self.encoding) as changelog_file:
+        with smart_open(
+            self.file_name, "w", encoding=self.config.settings["encoding"]
+        ) as changelog_file:
             partial_changelog: str | None = None
             if self.incremental:
                 new_lines = changelog.incremental_build(
@@ -259,7 +260,9 @@ def __call__(self) -> None:
 
         lines = []
         if self.incremental and os.path.isfile(self.file_name):
-            with open(self.file_name, encoding=self.encoding) as changelog_file:
+            with open(
+                self.file_name, encoding=self.config.settings["encoding"]
+            ) as changelog_file:
                 lines = changelog_file.readlines()
 
         self._write_changelog(changelog_out, lines, changelog_meta)

commitizen/commands/check.py

@@ -71,7 +71,6 @@ def __init__(self, config: BaseConfig, arguments: CheckArgs, *args: object) -> N
             self.commit_msg = sys.stdin.read()
 
         self.config: BaseConfig = config
-        self.encoding = config.settings["encoding"]
         self.cz = factory.committer_factory(self.config)
 
     def __call__(self) -> None:
@@ -105,7 +104,9 @@ def _get_commit_message(self) -> str | None:
             # Get commit message from command line (--message)
             return self.commit_msg
 
-        with open(self.commit_msg_file, encoding=self.encoding) as commit_file:
+        with open(
+            self.commit_msg_file, encoding=self.config.settings["encoding"]
+        ) as commit_file:
             # Get commit message from file (--commit-msg-file)
             return commit_file.read()
 

commitizen/commands/commit.py

@@ -48,7 +48,6 @@ def __init__(self, config: BaseConfig, arguments: CommitArgs) -> None:
             raise NotAGitProjectError()
 
         self.config: BaseConfig = config
-        self.encoding = config.settings["encoding"]
         self.cz = factory.committer_factory(self.config)
         self.arguments = arguments
         self.backup_file_path = get_backup_file_path()
@@ -59,7 +58,9 @@ def _read_backup_message(self) -> str | None:
             return None
 
         # Read commit message from backup
-        with open(self.backup_file_path, encoding=self.encoding) as f:
+        with open(
+            self.backup_file_path, encoding=self.config.settings["encoding"]
+        ) as f:
             return f.read().strip()
 
     def _prompt_commit_questions(self) -> str:
@@ -146,7 +147,9 @@ def __call__(self) -> None:
         out.info(f"\n{commit_message}\n")
 
         if write_message_to_file:
-            with smart_open(write_message_to_file, "w", encoding=self.encoding) as file:
+            with smart_open(
+                write_message_to_file, "w", encoding=self.config.settings["encoding"]
+            ) as file:
                 file.write(commit_message)
 
         if dry_run:
@@ -160,7 +163,9 @@ def __call__(self) -> None:
             out.error(c.err)
 
             # Create commit backup
-            with smart_open(self.backup_file_path, "w", encoding=self.encoding) as f:
+            with smart_open(
+                self.backup_file_path, "w", encoding=self.config.settings["encoding"]
+            ) as f:
                 f.write(commit_message)
 
             raise CommitError()

commitizen/commands/init.py

@@ -121,7 +121,6 @@ class Init:
 
     def __init__(self, config: BaseConfig, *args: object) -> None:
         self.config: BaseConfig = config
-        self.encoding = config.settings["encoding"]
         self.cz = factory.committer_factory(self.config)
         self.project_info = ProjectInfo()
 
@@ -163,7 +162,9 @@ def __call__(self) -> None:
         if hook_types:
             config_data = self._get_config_data()
             with smart_open(
-                self._PRE_COMMIT_CONFIG_PATH, "w", encoding=self.encoding
+                self._PRE_COMMIT_CONFIG_PATH,
+                "w",
+                encoding=self.config.settings["encoding"],
             ) as config_file:
                 yaml.safe_dump(config_data, stream=config_file)
 
@@ -355,7 +356,9 @@ def _get_config_data(self) -> dict[str, Any]:
             # .pre-commit-config.yaml does not exist
             return {"repos": [CZ_HOOK_CONFIG]}
 
-        with open(self._PRE_COMMIT_CONFIG_PATH, encoding=self.encoding) as config_file:
+        with open(
+            self._PRE_COMMIT_CONFIG_PATH, encoding=self.config.settings["encoding"]
+        ) as config_file:
             config_data: dict[str, Any] = yaml.safe_load(config_file) or {}
 
         if not isinstance(repos := config_data.get("repos"), list):