commitizen 4.8.3__tar.gz → 4.9.0__tar.gz

{commitizen-4.8.3 → commitizen-4.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: commitizen
-Version: 4.8.3
+Version: 4.9.0
 Summary: Python commitizen client tool
 License: MIT License
          
@@ -47,10 +47,10 @@ Requires-Dist: argcomplete (>=1.12.1,<3.7)
 Requires-Dist: charset-normalizer (>=2.1.0,<4)
 Requires-Dist: colorama (>=0.4.1,<1.0)
 Requires-Dist: decli (>=0.6.0,<1.0)
-Requires-Dist: importlib-metadata (>=8.0.0,!=8.7.0,<9.0.0) ; python_version == "3.9"
-Requires-Dist: importlib-metadata (>=8.0.0,<9.0.0) ; python_version != "3.9"
+Requires-Dist: importlib-metadata (>=8.0.0,<8.7.0) ; python_version < "3.10"
 Requires-Dist: jinja2 (>=2.10.3)
 Requires-Dist: packaging (>=19)
+Requires-Dist: prompt_toolkit (!=3.0.52)
 Requires-Dist: pyyaml (>=3.08)
 Requires-Dist: questionary (>=2.0,<3.0)
 Requires-Dist: termcolor (>=1.1.0,<4.0.0)
@@ -128,6 +128,7 @@ Before installing Commitizen, ensure you have:
 #### Global Installation (Recommended)
 
 The recommended way to install Commitizen is using [`pipx`](https://pipx.pypa.io/) or [`uv`](https://docs.astral.sh/uv/), which ensures a clean, isolated installation:
+
 **Using pipx:**
 ```bash
 # Install Commitizen
@@ -176,7 +177,7 @@ poetry add commitizen --dev
 
 **Using uv:**
 ```bash
-uv add commitizen
+uv add --dev commitizen
 ```
 
 **Using pdm:**

commitizen-4.9.0/commitizen/__version__.py

@@ -0,0 +1 @@
+__version__ = "4.9.0"

{commitizen-4.8.3 → commitizen-4.9.0}/commitizen/changelog.py

@@ -29,11 +29,13 @@ from __future__ import annotations
 
 import re
 from collections import OrderedDict, defaultdict
-from collections.abc import Generator, Iterable, Mapping, Sequence
+from collections.abc import Generator, Iterable, Mapping, MutableMapping, Sequence
 from dataclasses import dataclass
 from datetime import date
+from itertools import chain
 from typing import TYPE_CHECKING, Any
 
+from deprecated import deprecated
 from jinja2 import (
     BaseLoader,
     ChoiceLoader,
@@ -88,33 +90,32 @@ def generate_tree_from_commits(
     pat = re.compile(changelog_pattern)
     map_pat = re.compile(commit_parser, re.MULTILINE)
     body_map_pat = re.compile(commit_parser, re.MULTILINE | re.DOTALL)
-    current_tag: GitTag | None = None
     rules = rules or TagRules()
 
     # Check if the latest commit is not tagged
-    if commits:
-        latest_commit = commits[0]
-        current_tag = get_commit_tag(latest_commit, tags)
-
-    current_tag_name: str = unreleased_version or "Unreleased"
-    current_tag_date: str = ""
-    if unreleased_version is not None:
-        current_tag_date = date.today().isoformat()
-    if current_tag is not None and current_tag.name:
-        current_tag_name = current_tag.name
-        current_tag_date = current_tag.date
 
+    current_tag = get_commit_tag(commits[0], tags) if commits else None
+    current_tag_name = unreleased_version or "Unreleased"
+    current_tag_date = (
+        date.today().isoformat() if unreleased_version is not None else ""
+    )
+
+    used_tags: set[GitTag] = set()
+    if current_tag:
+        used_tags.add(current_tag)
+        if current_tag.name:
+            current_tag_name = current_tag.name
+            current_tag_date = current_tag.date
+
+    commit_tag: GitTag | None = None
     changes: dict = defaultdict(list)
-    used_tags: list = [current_tag]
     for commit in commits:
-        commit_tag = get_commit_tag(commit, tags)
-
         if (
-            commit_tag
+            (commit_tag := get_commit_tag(commit, tags))
             and commit_tag not in used_tags
             and rules.include_in_changelog(commit_tag)
         ):
-            used_tags.append(commit_tag)
+            used_tags.add(commit_tag)
             release = {
                 "version": current_tag_name,
                 "date": current_tag_date,
@@ -127,24 +128,15 @@ def generate_tree_from_commits(
             current_tag_date = commit_tag.date
             changes = defaultdict(list)
 
-        matches = pat.match(commit.message)
-        if not matches:
+        if not pat.match(commit.message):
             continue
 
-        # Process subject from commit message
-        if message := map_pat.match(commit.message):
-            process_commit_message(
-                changelog_message_builder_hook,
-                message,
-                commit,
-                changes,
-                change_type_map,
-            )
-
-        # Process body from commit message
-        body_parts = commit.body.split("\n\n")
-        for body_part in body_parts:
-            if message := body_map_pat.match(body_part):
+        # Process subject and body from commit message
+        for message in chain(
+            [map_pat.match(commit.message)],
+            (body_map_pat.match(block) for block in commit.body.split("\n\n")),
+        ):
+            if message:
                 process_commit_message(
                     changelog_message_builder_hook,
                     message,
@@ -167,8 +159,8 @@ def process_commit_message(
     hook: MessageBuilderHook | None,
     parsed: re.Match[str],
     commit: GitCommit,
-    changes: dict[str | None, list],
-    change_type_map: dict[str, str] | None = None,
+    ref_changes: MutableMapping[str | None, list],
+    change_type_map: Mapping[str, str] | None = None,
 ) -> None:
     message: dict[str, Any] = {
         "sha1": commit.rev,
@@ -178,13 +170,16 @@ def process_commit_message(
         **parsed.groupdict(),
     }
 
-    if processed := hook(message, commit) if hook else message:
-        messages = [processed] if isinstance(processed, dict) else processed
-        for msg in messages:
-            change_type = msg.pop("change_type", None)
-            if change_type_map:
-                change_type = change_type_map.get(change_type, change_type)
-            changes[change_type].append(msg)
+    processed_msg = hook(message, commit) if hook else message
+    if not processed_msg:
+        return
+
+    messages = [processed_msg] if isinstance(processed_msg, dict) else processed_msg
+    for msg in messages:
+        change_type = msg.pop("change_type", None)
+        if change_type_map:
+            change_type = change_type_map.get(change_type, change_type)
+        ref_changes[change_type].append(msg)
 
 
 def generate_ordered_changelog_tree(
@@ -251,6 +246,7 @@ def incremental_build(
     unreleased_start = metadata.unreleased_start
     unreleased_end = metadata.unreleased_end
     latest_version_position = metadata.latest_version_position
+
     skip = False
     output_lines: list[str] = []
     for index, line in enumerate(lines):
@@ -260,9 +256,7 @@ def incremental_build(
             skip = False
             if (
                 latest_version_position is None
-                or isinstance(latest_version_position, int)
-                and isinstance(unreleased_end, int)
-                and latest_version_position > unreleased_end
+                or latest_version_position > unreleased_end
             ):
                 continue
 
@@ -271,16 +265,32 @@ def incremental_build(
 
         if index == latest_version_position:
             output_lines.extend([new_content, "\n"])
-
         output_lines.append(line)
-    if not isinstance(latest_version_position, int):
-        if output_lines and output_lines[-1].strip():
-            # Ensure at least one blank line between existing and new content.
-            output_lines.append("\n")
-        output_lines.append(new_content)
+
+    if latest_version_position is not None:
+        return output_lines
+
+    if output_lines and output_lines[-1].strip():
+        # Ensure at least one blank line between existing and new content.
+        output_lines.append("\n")
+    output_lines.append(new_content)
     return output_lines
 
 
+def get_next_tag_name_after_version(tags: Iterable[GitTag], version: str) -> str | None:
+    it = iter(tag.name for tag in tags)
+    for name in it:
+        if name == version:
+            return next(it, None)
+
+    raise NoCommitsFoundError(f"Could not find a valid revision range. {version=}")
+
+
+@deprecated(
+    reason="This function is unused and will be removed in v5",
+    version="5.0.0",
+    category=DeprecationWarning,
+)
 def get_smart_tag_range(
     tags: Sequence[GitTag], newest: str, oldest: str | None = None
 ) -> list[GitTag]:
@@ -308,7 +318,7 @@ def get_smart_tag_range(
 
 
 def get_oldest_and_newest_rev(
-    tags: Sequence[GitTag],
+    tags: Iterable[GitTag],
     version: str,
     rules: TagRules,
 ) -> tuple[str | None, str]:
@@ -318,39 +328,26 @@ def get_oldest_and_newest_rev(
     - `0.1.0..0.4.0`: as a range
     - `0.3.0`: as a single version
     """
-    oldest: str | None = None
-    newest: str | None = None
-    try:
-        oldest, newest = version.split("..")
-    except ValueError:
-        newest = version
-    if not (newest_tag := rules.find_tag_for(tags, newest)):
+    oldest_version, sep, newest_version = version.partition("..")
+    if not sep:
+        newest_version = version
+        oldest_version = ""
+
+    def get_tag_name(v: str) -> str:
+        if tag := rules.find_tag_for(tags, v):
+            return tag.name
         raise NoCommitsFoundError("Could not find a valid revision range.")
 
-    oldest_tag = None
-    oldest_tag_name = None
-    if oldest:
-        if not (oldest_tag := rules.find_tag_for(tags, oldest)):
-            raise NoCommitsFoundError("Could not find a valid revision range.")
-        oldest_tag_name = oldest_tag.name
+    newest_tag_name = get_tag_name(newest_version)
+    oldest_tag_name = get_tag_name(oldest_version) if oldest_version else None
 
-    tags_range = get_smart_tag_range(
-        tags, newest=newest_tag.name, oldest=oldest_tag_name
+    oldest_rev = get_next_tag_name_after_version(
+        tags, oldest_tag_name or newest_tag_name
     )
-    if not tags_range:
-        raise NoCommitsFoundError("Could not find a valid revision range.")
-
-    oldest_rev: str | None = tags_range[-1].name
-    newest_rev = newest_tag.name
-
-    # check if it's the first tag created
-    # and it's also being requested as part of the range
-    if oldest_rev == tags[-1].name and oldest_rev == oldest_tag_name:
-        return None, newest_rev
-
-    # when they are the same, and it's also the
-    # first tag created
-    if oldest_rev == newest_rev:
-        return None, newest_rev
 
-    return oldest_rev, newest_rev
+    # Return None for oldest_rev if:
+    # 1. The oldest tag is the last tag in the list and matches the requested oldest tag
+    # 2. The oldest and the newest tag are the same
+    if oldest_rev == newest_tag_name:
+        return None, newest_tag_name
+    return oldest_rev, newest_tag_name

{commitizen-4.8.3 → commitizen-4.9.0}/commitizen/cli.py

@@ -52,16 +52,13 @@ class ParseKwargs(argparse.Action):
     ) -> None:
         if not isinstance(values, str):
             return
-        if "=" not in values:
+
+        key, sep, value = values.partition("=")
+        if not key or not sep:
             raise InvalidCommandArgumentError(
                 f"Option {option_string} expect a key=value format"
             )
         kwargs = getattr(namespace, self.dest, None) or {}
-        key, value = values.split("=", 1)
-        if not key:
-            raise InvalidCommandArgumentError(
-                f"Option {option_string} expect a key=value format"
-            )
         kwargs[key] = value.strip("'\"")
         setattr(namespace, self.dest, kwargs)
 
@@ -474,6 +471,13 @@ data = {
                         "help": "a range of git rev to check. e.g, master..HEAD",
                         "exclusive_group": "group1",
                     },
+                    {
+                        "name": ["-d", "--use-default-range"],
+                        "action": "store_true",
+                        "default": False,
+                        "help": "check from the default branch to HEAD. e.g, refs/remotes/origin/master..HEAD",
+                        "exclusive_group": "group1",
+                    },
                     {
                         "name": ["-m", "--message"],
                         "help": "commit message that needs to be checked",
@@ -583,20 +587,19 @@ def parse_no_raise(comma_separated_no_raise: str) -> list[int]:
     Receives digits and strings and outputs the parsed integer which
     represents the exit code found in exceptions.
     """
-    no_raise_items: list[str] = comma_separated_no_raise.split(",")
-    no_raise_codes: list[int] = []
-    for item in no_raise_items:
-        if item.isdecimal():
-            no_raise_codes.append(int(item))
-            continue
+
+    def exit_code_from_str_or_skip(s: str) -> ExitCode | None:
         try:
-            exit_code = ExitCode[item.strip()]
-        except KeyError:
-            out.warn(f"WARN: no_raise key `{item}` does not exist. Skipping.")
-            continue
-        else:
-            no_raise_codes.append(exit_code.value)
-    return no_raise_codes
+            return ExitCode.from_str(s)
+        except (KeyError, ValueError):
+            out.warn(f"WARN: no_raise value `{s}` is not a valid exit code. Skipping.")
+            return None
+
+    return [
+        code.value
+        for s in comma_separated_no_raise.split(",")
+        if (code := exit_code_from_str_or_skip(s)) is not None
+    ]
 
 
 if TYPE_CHECKING:

{commitizen-4.8.3 → commitizen-4.9.0}/commitizen/commands/bump.py

@@ -23,7 +23,6 @@ from commitizen.exceptions import (
     NoPatternMapError,
     NotAGitProjectError,
     NotAllowed,
-    NoVersionSpecifiedError,
 )
 from commitizen.providers import get_provider
 from commitizen.tags import TagRules
@@ -163,11 +162,7 @@ class Bump:
     def __call__(self) -> None:
         """Steps executed to bump."""
         provider = get_provider(self.config)
-
-        try:
-            current_version = self.scheme(provider.get_version())
-        except TypeError:
-            raise NoVersionSpecifiedError()
+        current_version = self.scheme(provider.get_version())
 
         increment = self.arguments["increment"]
         prerelease = self.arguments["prerelease"]
@@ -177,36 +172,22 @@ class Bump:
         build_metadata = self.arguments["build_metadata"]
         get_next = self.arguments["get_next"]
         allow_no_commit = self.arguments["allow_no_commit"]
+        major_version_zero = self.arguments["major_version_zero"]
 
         if manual_version:
-            if increment:
-                raise NotAllowed("--increment cannot be combined with MANUAL_VERSION")
-
-            if prerelease:
-                raise NotAllowed("--prerelease cannot be combined with MANUAL_VERSION")
-
-            if devrelease is not None:
-                raise NotAllowed("--devrelease cannot be combined with MANUAL_VERSION")
-
-            if is_local_version:
-                raise NotAllowed(
-                    "--local-version cannot be combined with MANUAL_VERSION"
-                )
-
-            if build_metadata:
-                raise NotAllowed(
-                    "--build-metadata cannot be combined with MANUAL_VERSION"
-                )
-
-            if self.bump_settings["major_version_zero"]:
-                raise NotAllowed(
-                    "--major-version-zero cannot be combined with MANUAL_VERSION"
-                )
-
-            if get_next:
-                raise NotAllowed("--get-next cannot be combined with MANUAL_VERSION")
-
-        if self.bump_settings["major_version_zero"] and current_version.release[0]:
+            for val, option in (
+                (increment, "--increment"),
+                (prerelease, "--prerelease"),
+                (devrelease is not None, "--devrelease"),
+                (is_local_version, "--local-version"),
+                (build_metadata, "--build-metadata"),
+                (major_version_zero, "--major-version-zero"),
+                (get_next, "--get-next"),
+            ):
+                if val:
+                    raise NotAllowed(f"{option} cannot be combined with MANUAL_VERSION")
+
+        if major_version_zero and current_version.release[0]:
             raise NotAllowed(
                 f"--major-version-zero is meaningless for current version {current_version}"
             )
@@ -215,11 +196,13 @@ class Bump:
             raise NotAllowed("--local-version cannot be combined with --build-metadata")
 
         if get_next:
-            # if trying to use --get-next, we should not allow --changelog or --changelog-to-stdout
-            if self.changelog_flag or self.changelog_to_stdout:
-                raise NotAllowed(
-                    "--changelog or --changelog-to-stdout is not allowed with --get-next"
-                )
+            for value, option in (
+                (self.changelog_flag, "--changelog"),
+                (self.changelog_to_stdout, "--changelog-to-stdout"),
+            ):
+                if value:
+                    raise NotAllowed(f"{option} cannot be combined with --get-next")
+
             # --get-next is a special case, taking precedence over config for 'update_changelog_on_bump'
             self.changelog_config = False
             # Setting dry_run to prevent any unwanted changes to the repo or files

{commitizen-4.8.3 → commitizen-4.9.0}/commitizen/commands/changelog.py

@@ -11,7 +11,6 @@ from typing import Any, TypedDict, cast
 from commitizen import changelog, defaults, factory, git, out
 from commitizen.changelog_formats import get_changelog_format
 from commitizen.config import BaseConfig
-from commitizen.cz.base import ChangelogReleaseHook, MessageBuilderHook
 from commitizen.cz.utils import strip_local_version
 from commitizen.exceptions import (
     DryRunExit,
@@ -174,28 +173,23 @@ class Changelog:
 
             changelog_file.write(changelog_out)
 
-    def _export_template(self) -> None:
-        tpl = changelog.get_changelog_template(self.cz.template_loader, self.template)
-        # TODO: fix the following type ignores
-        src = Path(tpl.filename)  # type: ignore[arg-type]
-        Path(self.export_template_to).write_text(src.read_text())  # type: ignore[arg-type]
+    def _export_template(self, dist: str) -> None:
+        filename = changelog.get_changelog_template(
+            self.cz.template_loader, self.template
+        ).filename
+        if filename is None:
+            raise NotAllowed("Template filename is not set")
+
+        text = Path(filename).read_text()
+        Path(dist).write_text(text)
 
     def __call__(self) -> None:
         commit_parser = self.cz.commit_parser
         changelog_pattern = self.cz.changelog_pattern
         start_rev = self.start_rev
-        unreleased_version = self.unreleased_version
-        changelog_meta = changelog.Metadata()
-        change_type_map: dict[str, str] | None = self.change_type_map
-        changelog_message_builder_hook: MessageBuilderHook | None = (
-            self.cz.changelog_message_builder_hook
-        )
-        changelog_release_hook: ChangelogReleaseHook | None = (
-            self.cz.changelog_release_hook
-        )
 
         if self.export_template_to:
-            return self._export_template()
+            return self._export_template(self.export_template_to)
 
         if not changelog_pattern or not commit_parser:
             raise NoPatternMapError(
@@ -209,33 +203,37 @@ class Changelog:
         assert self.file_name
 
         tags = self.tag_rules.get_version_tags(git.get_tags(), warn=True)
-        end_rev = ""
+        changelog_meta = changelog.Metadata()
         if self.incremental:
             changelog_meta = self.changelog_format.get_metadata(self.file_name)
             if changelog_meta.latest_version:
                 start_rev = self._find_incremental_rev(
                     strip_local_version(changelog_meta.latest_version_tag or ""), tags
                 )
+
+        end_rev = ""
         if self.rev_range:
             start_rev, end_rev = changelog.get_oldest_and_newest_rev(
                 tags,
                 self.rev_range,
                 self.tag_rules,
             )
+
         commits = git.get_commits(start=start_rev, end=end_rev, args="--topo-order")
         if not commits and (
             self.current_version is None or not self.current_version.is_prerelease
         ):
             raise NoCommitsFoundError("No commits found")
+
         tree = changelog.generate_tree_from_commits(
             commits,
             tags,
             commit_parser,
             changelog_pattern,
-            unreleased_version,
-            change_type_map=change_type_map,
-            changelog_message_builder_hook=changelog_message_builder_hook,
-            changelog_release_hook=changelog_release_hook,
+            self.unreleased_version,
+            change_type_map=self.change_type_map,
+            changelog_message_builder_hook=self.cz.changelog_message_builder_hook,
+            changelog_release_hook=self.cz.changelog_release_hook,
             rules=self.tag_rules,
         )
         if self.change_type_order:
@@ -243,11 +241,15 @@ class Changelog:
                 tree, self.change_type_order
             )
 
-        extras = self.cz.template_extras.copy()
-        extras.update(self.config.settings["extras"])
-        extras.update(self.extras)
         changelog_out = changelog.render_changelog(
-            tree, loader=self.cz.template_loader, template=self.template, **extras
+            tree,
+            self.cz.template_loader,
+            self.template,
+            **{
+                **self.cz.template_extras,
+                **self.config.settings["extras"],
+                **self.extras,
+            },
         ).lstrip("\n")
 
         # Dry_run is executed here to avoid checking and reading the files

{commitizen-4.8.3 → commitizen-4.9.0}/commitizen/commands/check.py

@@ -21,6 +21,7 @@ class CheckArgs(TypedDict, total=False):
     message_length_limit: int
     allowed_prefixes: list[str]
     message: str
+    use_default_range: bool
 
 
 class Check:
@@ -40,6 +41,7 @@ class Check:
         self.allow_abort = bool(
             arguments.get("allow_abort", config.settings["allow_abort"])
         )
+        self.use_default_range = bool(arguments.get("use_default_range"))
         self.max_msg_length = arguments.get("message_length_limit", 0)
 
         # we need to distinguish between None and [], which is a valid value
@@ -50,25 +52,28 @@ class Check:
             else config.settings["allowed_prefixes"]
         )
 
-        self._valid_command_argument()
-
-        self.config: BaseConfig = config
-        self.encoding = config.settings["encoding"]
-        self.cz = factory.committer_factory(self.config)
-
-    def _valid_command_argument(self) -> None:
         num_exclusive_args_provided = sum(
             arg is not None
-            for arg in (self.commit_msg_file, self.commit_msg, self.rev_range)
+            for arg in (
+                self.commit_msg_file,
+                self.commit_msg,
+                self.rev_range,
+            )
         )
-        if num_exclusive_args_provided == 0 and not sys.stdin.isatty():
-            self.commit_msg = sys.stdin.read()
-        elif num_exclusive_args_provided != 1:
+
+        if num_exclusive_args_provided > 1:
             raise InvalidCommandArgumentError(
                 "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command! "
                 "See 'cz check -h' for more information"
             )
 
+        if num_exclusive_args_provided == 0 and not sys.stdin.isatty():
+            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:
         """Validate if commit messages follows the conventional pattern.
 
@@ -109,7 +114,10 @@ class Check:
             return [git.GitCommit(rev="", title="", body=self._filter_comments(msg))]
 
         # Get commit messages from git log (--rev-range)
-        return git.get_commits(end=self.rev_range)
+        return git.get_commits(
+            git.get_default_branch() if self.use_default_range else None,
+            self.rev_range,
+        )
 
     @staticmethod
     def _filter_comments(msg: str) -> str:
@@ -134,7 +142,7 @@ class Check:
             The filtered commit message without comments.
         """
 
-        lines = []
+        lines: list[str] = []
         for line in msg.split("\n"):
             if "# ------------------------ >8 ------------------------" in line:
                 break