fix: add missing encoding parameter

Add `encoding` parameter to `open` and `smart_open` method calls where missed. Use `defaults.encoding` as default.

Author: adam-grant-hendry

commitizen/bump.py

@@ -5,7 +5,7 @@
 from collections import OrderedDict
 from string import Template
 
-from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message
+from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message, encoding
 from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit, smart_open
 from commitizen.version_schemes import DEFAULT_SCHEME, Version, VersionScheme
@@ -48,9 +48,9 @@ def update_version_in_files(
     current_version: str,
     new_version: str,
     files: list[str],
-    encoding: str,
     *,
     check_consistency=False,
+    encoding: str = encoding,
 ) -> None:
     """Change old version to the new one in every file given.
 
@@ -71,7 +71,7 @@ def update_version_in_files(
             current_version,
             new_version,
             regex,
-            encoding,
+            encoding=encoding,
         )
 
         if check_consistency and not current_version_found:
@@ -91,7 +91,7 @@ def _bump_with_regex(
     current_version: str,
     new_version: str,
     regex: str,
-    encoding: str,
+    encoding: str = encoding,
 ) -> tuple[bool, str]:
     current_version_found = False
     lines = []

commitizen/changelog.py

@@ -36,6 +36,7 @@
 
 from commitizen import out
 from commitizen.bump import normalize_tag
+from commitizen.defaults import encoding
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 from commitizen.version_schemes import (
@@ -214,7 +215,7 @@ def parse_title_type_of_line(value: str) -> str | None:
 
 
 def get_metadata(
-    filepath: str, scheme: VersionScheme = Pep440, encoding: str = "utf-8"
+    filepath: str, scheme: VersionScheme = Pep440, encoding: str = encoding
 ) -> dict:
     unreleased_start: int | None = None
     unreleased_end: int | None = None

commitizen/changelog_parser.py

@@ -13,6 +13,8 @@
 from collections import defaultdict
 from typing import Generator, Iterable
 
+from commitizen.defaults import encoding
+
 MD_VERSION_RE = r"^##\s(?P<version>[a-zA-Z0-9.+]+)\s?\(?(?P<date>[0-9-]+)?\)?"
 MD_CHANGE_TYPE_RE = r"^###\s(?P<change_type>[a-zA-Z0-9.+\s]+)"
 MD_MESSAGE_RE = (
@@ -36,7 +38,7 @@
 ]
 
 
-def find_version_blocks(filepath: str, encoding: str) -> Generator:
+def find_version_blocks(filepath: str, encoding: str = encoding) -> Generator:
     """Find version block (version block: contains all the information about a version.)
 
     E.g:

commitizen/commands/bump.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
 import os
-from logging import getLogger
 import warnings
+from logging import getLogger
 
 import questionary
 
@@ -23,7 +23,7 @@
     NoVersionSpecifiedError,
 )
 from commitizen.providers import get_provider
-from commitizen.version_schemes import get_version_scheme, InvalidVersion
+from commitizen.version_schemes import InvalidVersion, get_version_scheme
 
 logger = getLogger("commitizen")
 
@@ -298,8 +298,8 @@ def __call__(self):  # noqa: C901
             str(current_version),
             str(new_version),
             version_files,
-            self.encoding,
             check_consistency=self.check_consistency,
+            encoding=self.encoding,
         )
 
         provider.set_version(str(new_version))

commitizen/commands/changelog.py

@@ -145,7 +145,7 @@ def __call__(self):
             changelog_meta = changelog.get_metadata(
                 self.file_name,
                 self.scheme,
-                self.encoding,
+                encoding=self.encoding,
             )
             latest_version = changelog_meta.get("latest_version")
             if latest_version:

commitizen/commands/commit.py

@@ -83,7 +83,7 @@ def __call__(self):
         out.info(f"\n{m}\n")
 
         if write_message_to_file:
-            with smart_open(write_message_to_file, "w") as file:
+            with smart_open(write_message_to_file, "w", encoding=self.encoding) as file:
                 file.write(m)
 
         if dry_run:

tests/test_changelog_parser.py

@@ -47,7 +47,9 @@ def existing_changelog_file(tmpdir):
 
 
 def test_read_changelog_blocks(existing_changelog_file):
-    blocks = changelog_parser.find_version_blocks(existing_changelog_file, "utf-8")
+    blocks = changelog_parser.find_version_blocks(
+        existing_changelog_file, encoding="utf-8"
+    )
     blocks = list(blocks)
     amount_of_blocks = len(blocks)
     assert amount_of_blocks == 2
@@ -127,7 +129,9 @@ def test_transform_change_type_fail():
 
 
 def test_generate_block_tree(existing_changelog_file):
-    blocks = changelog_parser.find_version_blocks(existing_changelog_file, "utf-8")
+    blocks = changelog_parser.find_version_blocks(
+        existing_changelog_file, encoding="utf-8"
+    )
     block = next(blocks)
     tree = changelog_parser.generate_block_tree(block)
     assert tree == {
@@ -157,7 +161,9 @@ def test_generate_block_tree(existing_changelog_file):
 
 
 def test_generate_full_tree(existing_changelog_file):
-    blocks = changelog_parser.find_version_blocks(existing_changelog_file, "utf-8")
+    blocks = changelog_parser.find_version_blocks(
+        existing_changelog_file, encoding="utf-8"
+    )
     tree = list(changelog_parser.generate_full_tree(blocks))
 
     assert tree == [