Merge branch 'master' into bump-doc-version-files

Author: bearomorphism

.pre-commit-config.yaml

@@ -48,7 +48,7 @@ repos:
           - tomli
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v4.9.1 # automatically updated by Commitizen
+    rev: v4.10.0 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,3 +1,36 @@
+## v4.10.0 (2025-11-10)
+
+### Feat
+
+- add config option for line length warning
+- **conventional_commits**: allow exclamation in title on BC
+- **version**: add the ability to just print major or minor version
+- allow `amend!` prefix as created by `git --fixup=reword:<commit>`
+
+### Fix
+
+- **commands/version**: add missing return
+- **test**: set terminal width for cli tests
+- **Init**: raise InitFailedError on keyboard interrupt on pre-commit hook question, simplify logic, remove unreachable code path
+
+### Refactor
+
+- **bump**: cleanup related to update_version_file
+- **RestructuredTest**: rename variable, fix typo and remove unnecessary string copy
+- **TomlConfig**: minor cleanups for DX
+- **Commit**: refactor _prompt_commit_questions and fix some type hint
+- **hooks**: refactor to improve readability
+- **Init**: make project_info a module and remove self.project_info
+- **BaseConfig**: update docstring, extract factory method and remove unnecessary variable assignment
+- remove self.encoding for better maintainability
+- **utils**: make get_backup_file_path to return a path for semantic correctness
+- remove unnecessary class member tag_format
+- **Bump**: remove use of getattr
+- **ConventionalCommitsCz**: rewrite message method to make the pattern more clear
+- **cmd**: unnest try except
+- **BaseCommitizen**: remove NotImplementedError and make them abstract method
+- **BaseCommitizen**: construct Style object directly to get rid of potential type error
+
 ## v4.9.1 (2025-09-10)
 
 ### Fix

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "4.9.1"
+__version__ = "4.10.0"

commitizen/bump.py

@@ -3,13 +3,13 @@
 import os
 import re
 from collections import OrderedDict
-from collections.abc import Iterable
+from collections.abc import Generator, Iterable
 from glob import iglob
 from logging import getLogger
 from string import Template
 from typing import cast
 
-from commitizen.defaults import BUMP_MESSAGE, ENCODING, MAJOR, MINOR, PATCH
+from commitizen.defaults import BUMP_MESSAGE, MAJOR, MINOR, PATCH
 from commitizen.exceptions import CurrentVersionNotFoundError
 from commitizen.git import GitCommit, smart_open
 from commitizen.version_schemes import Increment, Version
@@ -64,8 +64,8 @@ def update_version_in_files(
     new_version: str,
     files: Iterable[str],
     *,
-    check_consistency: bool = False,
-    encoding: str = ENCODING,
+    check_consistency: bool,
+    encoding: str,
 ) -> list[str]:
     """Change old version to the new one in every file given.
 
@@ -75,16 +75,22 @@ def update_version_in_files(
 
     Returns the list of updated files.
     """
-    # TODO: separate check step and write step
-    updated = []
-    for path, regex in _files_and_regexes(files, current_version):
-        current_version_found, version_file = _bump_with_regex(
-            path,
-            current_version,
-            new_version,
-            regex,
-            encoding=encoding,
-        )
+    updated_files = []
+
+    for path, pattern in _resolve_files_and_regexes(files, current_version):
+        current_version_found = False
+        bumped_lines = []
+
+        with open(path, encoding=encoding) as version_file:
+            for line in version_file:
+                bumped_line = (
+                    line.replace(current_version, new_version)
+                    if pattern.search(line)
+                    else line
+                )
+
+                current_version_found = current_version_found or bumped_line != line
+                bumped_lines.append(bumped_line)
 
         if check_consistency and not current_version_found:
             raise CurrentVersionNotFoundError(
@@ -93,53 +99,32 @@ def update_version_in_files(
                 "version_files are possibly inconsistent."
             )
 
+        bumped_version_file_content = "".join(bumped_lines)
+
         # Write the file out again
         with smart_open(path, "w", encoding=encoding) as file:
-            file.write(version_file)
-        updated.append(path)
-    return updated
+            file.write(bumped_version_file_content)
+        updated_files.append(path)
+
+    return updated_files
 
 
-def _files_and_regexes(patterns: Iterable[str], version: str) -> list[tuple[str, str]]:
+def _resolve_files_and_regexes(
+    patterns: Iterable[str], version: str
+) -> Generator[tuple[str, re.Pattern], None, None]:
     """
     Resolve all distinct files with their regexp from a list of glob patterns with optional regexp
     """
-    out: set[tuple[str, str]] = set()
+    filepath_set: set[tuple[str, str]] = set()
     for pattern in patterns:
         drive, tail = os.path.splitdrive(pattern)
         path, _, regex = tail.partition(":")
         filepath = drive + path
-        if not regex:
-            regex = re.escape(version)
+        regex = regex or re.escape(version)
 
-        for file in iglob(filepath):
-            out.add((file, regex))
+        filepath_set.update((path, regex) for path in iglob(filepath))
 
-    return sorted(out)
-
-
-def _bump_with_regex(
-    version_filepath: str,
-    current_version: str,
-    new_version: str,
-    regex: str,
-    encoding: str = ENCODING,
-) -> tuple[bool, str]:
-    current_version_found = False
-    lines = []
-    pattern = re.compile(regex)
-    with open(version_filepath, encoding=encoding) as f:
-        for line in f:
-            if not pattern.search(line):
-                lines.append(line)
-                continue
-
-            bumped_line = line.replace(current_version, new_version)
-            if bumped_line != line:
-                current_version_found = True
-            lines.append(bumped_line)
-
-    return current_version_found, "".join(lines)
+    return ((path, re.compile(regex)) for path, regex in sorted(filepath_set))
 
 
 def create_commit_message(

commitizen/changelog_formats/base.py

@@ -24,11 +24,9 @@ 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_format = self.config.settings["tag_format"]
         self.tag_rules = TagRules(
             scheme=get_version_scheme(self.config.settings),
-            tag_format=self.tag_format,
+            tag_format=self.config.settings["tag_format"],
             legacy_tag_formats=self.config.settings["legacy_tag_formats"],
             ignored_tag_formats=self.config.settings["ignored_tag_formats"],
         )
@@ -37,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/changelog_formats/restructuredtext.py

@@ -1,92 +1,88 @@
 from __future__ import annotations
 
-import sys
 from itertools import zip_longest
-from typing import IO, TYPE_CHECKING, Any, Union
+from typing import IO
 
 from commitizen.changelog import Metadata
 
 from .base import BaseFormat
 
-if TYPE_CHECKING:
-    # TypeAlias is Python 3.10+ but backported in typing-extensions
-    if sys.version_info >= (3, 10):
-        from typing import TypeAlias
-    else:
-        from typing_extensions import TypeAlias
-
-
-# Can't use `|` operator and native type because of https://bugs.python.org/issue42233 only fixed in 3.10
-TitleKind: TypeAlias = Union[str, tuple[str, str]]
-
 
 class RestructuredText(BaseFormat):
     extension = "rst"
 
-    def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
+    def get_metadata_from_file(self, file: IO[str]) -> Metadata:
         """
         RestructuredText section titles are not one-line-based,
         they spread on 2 or 3 lines and levels are not predefined
-        but determined byt their occurrence order.
+        but determined by their occurrence order.
 
         It requires its own algorithm.
 
         For a more generic approach, you need to rely on `docutils`.
         """
-        meta = Metadata()
-        unreleased_title_kind: TitleKind | None = None
-        in_overlined_title = False
-        lines = file.readlines()
+        out_metadata = Metadata()
+        unreleased_title_kind: str | tuple[str, str] | None = None
+        is_overlined_title = False
+        lines = [line.strip().lower() for line in file.readlines()]
+
         for index, (first, second, third) in enumerate(
             zip_longest(lines, lines[1:], lines[2:], fillvalue="")
         ):
-            first = first.strip().lower()
-            second = second.strip().lower()
-            third = third.strip().lower()
             title: str | None = None
-            kind: TitleKind | None = None
-            if self.is_overlined_title(first, second, third):
+            kind: str | tuple[str, str] | None = None
+            if _is_overlined_title(first, second, third):
                 title = second
                 kind = (first[0], third[0])
-                in_overlined_title = True
-            elif not in_overlined_title and self.is_underlined_title(first, second):
+                is_overlined_title = True
+            elif not is_overlined_title and _is_underlined_title(first, second):
                 title = first
                 kind = second[0]
             else:
-                in_overlined_title = False
-
-            if title:
-                if "unreleased" in title:
-                    unreleased_title_kind = kind
-                    meta.unreleased_start = index
-                    continue
-                elif unreleased_title_kind and unreleased_title_kind == kind:
-                    meta.unreleased_end = index
-                # Try to find the latest release done
-                if version := self.tag_rules.search_version(title):
-                    meta.latest_version = version[0]
-                    meta.latest_version_tag = version[1]
-                    meta.latest_version_position = index
-                    break
-        if meta.unreleased_start is not None and meta.unreleased_end is None:
-            meta.unreleased_end = (
-                meta.latest_version_position if meta.latest_version else index + 1
+                is_overlined_title = False
+
+            if not title:
+                continue
+
+            if "unreleased" in title:
+                unreleased_title_kind = kind
+                out_metadata.unreleased_start = index
+                continue
+
+            if unreleased_title_kind and unreleased_title_kind == kind:
+                out_metadata.unreleased_end = index
+            # Try to find the latest release done
+            if version := self.tag_rules.search_version(title):
+                out_metadata.latest_version = version[0]
+                out_metadata.latest_version_tag = version[1]
+                out_metadata.latest_version_position = index
+                break
+
+        if (
+            out_metadata.unreleased_start is not None
+            and out_metadata.unreleased_end is None
+        ):
+            out_metadata.unreleased_end = (
+                out_metadata.latest_version_position
+                if out_metadata.latest_version
+                else len(lines)
             )
 
-        return meta
-
-    def is_overlined_title(self, first: str, second: str, third: str) -> bool:
-        return (
-            len(first) >= len(second)
-            and len(first) == len(third)
-            and all(char == first[0] for char in first[1:])
-            and first[0] == third[0]
-            and self.is_underlined_title(second, third)
-        )
-
-    def is_underlined_title(self, first: str, second: str) -> bool:
-        return (
-            len(second) >= len(first)
-            and not second.isalnum()
-            and all(char == second[0] for char in second[1:])
-        )
+        return out_metadata
+
+
+def _is_overlined_title(first: str, second: str, third: str) -> bool:
+    return (
+        len(first) == len(third) >= len(second)
+        and first[0] == third[0]
+        and all(char == first[0] for char in first)
+        and _is_underlined_title(second, third)
+    )
+
+
+def _is_underlined_title(first: str, second: str) -> bool:
+    return (
+        len(second) >= len(first)
+        and not second.isalnum()
+        and all(char == second[0] for char in second)
+    )

commitizen/cli.py

@@ -160,7 +160,6 @@ def __call__(
                     {
                         "name": ["-l", "--message-length-limit"],
                         "type": int,
-                        "default": 0,
                         "help": "length limit of the commit message; 0 for no limit",
                     },
                     {
@@ -499,7 +498,6 @@ def __call__(
                     {
                         "name": ["-l", "--message-length-limit"],
                         "type": int,
-                        "default": 0,
                         "help": "length limit of the commit message; 0 for no limit",
                     },
                 ],
@@ -543,6 +541,18 @@ def __call__(
                         "action": "store_true",
                         "exclusive_group": "group1",
                     },
+                    {
+                        "name": ["--major"],
+                        "help": "get just the major version",
+                        "action": "store_true",
+                        "exclusive_group": "group2",
+                    },
+                    {
+                        "name": ["--minor"],
+                        "help": "get just the minor version",
+                        "action": "store_true",
+                        "exclusive_group": "group2",
+                    },
                 ],
             },
         ],