commitizen 3.29.1__tar.gz → 3.30.1__tar.gz

{commitizen-3.29.1 → commitizen-3.30.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commitizen
-Version: 3.29.1
+Version: 3.30.1
 Summary: Python commitizen client tool
 Home-page: https://github.com/commitizen-tools/commitizen
 License: MIT
@@ -21,6 +21,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Dist: argcomplete (>=1.12.1,<3.6)
 Requires-Dist: charset-normalizer (>=2.1.0,<4)
@@ -41,6 +42,7 @@ Description-Content-Type: text/markdown
 [![PyPI Package latest release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)
 [![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/commitizen?style=flat-square)](https://pypi.org/project/commitizen/)
 [![Supported versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/commitizen?style=flat-square)](https://anaconda.org/conda-forge/commitizen)
 [![homebrew](https://img.shields.io/homebrew/v/commitizen?color=teal&style=flat-square)](https://formulae.brew.sh/formula/commitizen)
 [![Codecov](https://img.shields.io/codecov/c/github/commitizen-tools/commitizen.svg?style=flat-square)](https://codecov.io/gh/commitizen-tools/commitizen)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
@@ -100,19 +102,27 @@ pip install --user -U commitizen
 
 ### Python project
 
-You can add it to your local project using one of these:
+You can add it to your local project using one of the following.
+
+With `pip`:
 
 ```bash
 pip install -U commitizen
 ```
 
-for Poetry >= 1.2.0:
+With `conda`:
+
+```bash
+conda install -c conda-forge commitizen
+```
+
+With Poetry >= 1.2.0:
 
 ```bash
 poetry add commitizen --group dev
 ```
 
-for Poetry < 1.2.0:
+With Poetry < 1.2.0:
 
 ```bash
 poetry add commitizen --dev

commitizen-3.30.1/commitizen/__version__.py

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

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/cli.py

@@ -156,6 +156,12 @@ data = {
                         "action": "store_true",
                         "help": "Tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.",
                     },
+                    {
+                        "name": ["-e", "--edit"],
+                        "action": "store_true",
+                        "default": False,
+                        "help": "edit the commit message before committing",
+                    },
                     {
                         "name": ["-l", "--message-length-limit"],
                         "type": int,
@@ -541,7 +547,7 @@ def commitizen_excepthook(
             original_excepthook(type, value, traceback)
         exit_code = value.exit_code
         if exit_code in no_raise:
-            exit_code = 0
+            exit_code = ExitCode.EXPECTED_EXIT
         sys.exit(exit_code)
     else:
         original_excepthook(type, value, traceback)

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/commands/check.py

@@ -54,7 +54,7 @@ class Check:
             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: str | None = sys.stdin.read()
+            self.commit_msg = sys.stdin.read()
         elif num_exclusive_args_provided != 1:
             raise InvalidCommandArgumentError(
                 "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command! "
@@ -107,7 +107,9 @@ class Check:
             return [git.GitCommit(rev="", title="", body=msg)]
 
         # Get commit messages from git log (--rev-range)
-        return git.get_commits(end=self.rev_range)
+        if self.rev_range:
+            return git.get_commits(end=self.rev_range)
+        return git.get_commits()
 
     @staticmethod
     def _filter_comments(msg: str) -> str:

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/commands/commit.py

@@ -2,6 +2,9 @@ from __future__ import annotations
 
 import contextlib
 import os
+import shutil
+import subprocess
+import tempfile
 
 import questionary
 
@@ -72,9 +75,27 @@ class Commit:
 
         return message
 
+    def manual_edit(self, message: str) -> str:
+        editor = git.get_core_editor()
+        if editor is None:
+            raise RuntimeError("No 'editor' value given and no default available.")
+        exec_path = shutil.which(editor)
+        if exec_path is None:
+            raise RuntimeError(f"Editor '{editor}' not found.")
+        with tempfile.NamedTemporaryFile(mode="w", delete=False) as file:
+            file.write(message)
+        file_path = file.name
+        argv = [exec_path, file_path]
+        subprocess.call(argv)
+        with open(file_path) as temp_file:
+            message = temp_file.read().strip()
+        file.unlink()
+        return message
+
     def __call__(self):
         dry_run: bool = self.arguments.get("dry_run")
         write_message_to_file: bool = self.arguments.get("write_message_to_file")
+        manual_edit: bool = self.arguments.get("edit")
 
         is_all: bool = self.arguments.get("all")
         if is_all:
@@ -101,6 +122,9 @@ class Commit:
         else:
             m = self.prompt_commit_questions()
 
+        if manual_edit:
+            m = self.manual_edit(m)
+
         out.info(f"\n{m}\n")
 
         if write_message_to_file:

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/cz/base.py

@@ -61,7 +61,7 @@ class BaseCommitizen(metaclass=ABCMeta):
     template_loader: BaseLoader = PackageLoader("commitizen", "templates")
     template_extras: dict[str, Any] = {}
 
-    def __init__(self, config: BaseConfig):
+    def __init__(self, config: BaseConfig) -> None:
         self.config = config
         if not self.config.settings.get("style"):
             self.config.settings.update({"style": BaseCommitizen.default_style_config})
@@ -83,19 +83,19 @@ class BaseCommitizen(metaclass=ABCMeta):
             ]
         )
 
-    def example(self) -> str | None:
+    def example(self) -> str:
         """Example of the commit message."""
         raise NotImplementedError("Not Implemented yet")
 
-    def schema(self) -> str | None:
+    def schema(self) -> str:
         """Schema definition of the commit message."""
         raise NotImplementedError("Not Implemented yet")
 
-    def schema_pattern(self) -> str | None:
+    def schema_pattern(self) -> str:
         """Regex matching the schema used for message validation."""
         raise NotImplementedError("Not Implemented yet")
 
-    def info(self) -> str | None:
+    def info(self) -> str:
         """Information about the standardized commit message."""
         raise NotImplementedError("Not Implemented yet")
 

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/cz/customize/customize.py

@@ -1,9 +1,14 @@
 from __future__ import annotations
 
-try:
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
     from jinja2 import Template
-except ImportError:
-    from string import Template  # type: ignore
+else:
+    try:
+        from jinja2 import Template
+    except ImportError:
+        from string import Template
 
 
 from commitizen import defaults
@@ -68,16 +73,16 @@ class CustomizeCommitsCz(BaseCommitizen):
         else:
             return message_template.render(**answers)
 
-    def example(self) -> str | None:
-        return self.custom_settings.get("example")
+    def example(self) -> str:
+        return self.custom_settings.get("example") or ""
 
-    def schema_pattern(self) -> str | None:
-        return self.custom_settings.get("schema_pattern")
+    def schema_pattern(self) -> str:
+        return self.custom_settings.get("schema_pattern") or ""
 
-    def schema(self) -> str | None:
-        return self.custom_settings.get("schema")
+    def schema(self) -> str:
+        return self.custom_settings.get("schema") or ""
 
-    def info(self) -> str | None:
+    def info(self) -> str:
         info_path = self.custom_settings.get("info_path")
         info = self.custom_settings.get("info")
         if info_path:
@@ -86,4 +91,4 @@ class CustomizeCommitsCz(BaseCommitizen):
             return content
         elif info:
             return info
-        return None
+        return ""

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/defaults.py

@@ -45,7 +45,7 @@ class Settings(TypedDict, total=False):
     changelog_merge_prerelease: bool
     update_changelog_on_bump: bool
     use_shortcuts: bool
-    style: list[tuple[str, str]] | None
+    style: list[tuple[str, str]]
     customize: CzSettings
     major_version_zero: bool
     pre_bump_hooks: list[str] | None

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/exceptions.py

@@ -42,7 +42,7 @@ class ExitCode(enum.IntEnum):
 class CommitizenException(Exception):
     def __init__(self, *args, **kwargs):
         self.output_method = kwargs.get("output_method") or out.error
-        self.exit_code = self.__class__.exit_code
+        self.exit_code: ExitCode = self.__class__.exit_code
         if args:
             self.message = args[0]
         elif hasattr(self.__class__, "message"):

{commitizen-3.29.1 → commitizen-3.30.1}/commitizen/git.py

@@ -271,6 +271,13 @@ def get_eol_style() -> EOLTypes:
         return map["native"]
 
 
+def get_core_editor() -> str | None:
+    c = cmd.run("git var GIT_EDITOR")
+    if c.out:
+        return c.out.strip()
+    return None
+
+
 def smart_open(*args, **kargs):
     """Open a file with the EOL style determined from Git."""
     return open(*args, newline=get_eol_style().get_eol_for_open(), **kargs)

{commitizen-3.29.1 → commitizen-3.30.1}/docs/README.md

@@ -3,6 +3,7 @@
 [![PyPI Package latest release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)
 [![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/commitizen?style=flat-square)](https://pypi.org/project/commitizen/)
 [![Supported versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/commitizen?style=flat-square)](https://anaconda.org/conda-forge/commitizen)
 [![homebrew](https://img.shields.io/homebrew/v/commitizen?color=teal&style=flat-square)](https://formulae.brew.sh/formula/commitizen)
 [![Codecov](https://img.shields.io/codecov/c/github/commitizen-tools/commitizen.svg?style=flat-square)](https://codecov.io/gh/commitizen-tools/commitizen)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat-square&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
@@ -62,19 +63,27 @@ pip install --user -U commitizen
 
 ### Python project
 
-You can add it to your local project using one of these:
+You can add it to your local project using one of the following.
+
+With `pip`:
 
 ```bash
 pip install -U commitizen
 ```
 
-for Poetry >= 1.2.0:
+With `conda`:
+
+```bash
+conda install -c conda-forge commitizen
+```
+
+With Poetry >= 1.2.0:
 
 ```bash
 poetry add commitizen --group dev
 ```
 
-for Poetry < 1.2.0:
+With Poetry < 1.2.0:
 
 ```bash
 poetry add commitizen --dev

{commitizen-3.29.1 → commitizen-3.30.1}/pyproject.toml

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "3.29.1"
+version = "3.30.1"
 tag_format = "v$version"
 version_files = [
   "pyproject.toml:version",
@@ -9,7 +9,7 @@ version_files = [
 
 [tool.poetry]
 name = "commitizen"
-version = "3.29.1"
+version = "3.30.1"
 description = "Python commitizen client tool"
 authors = ["Santiago Fraire <santiwilly@gmail.com>"]
 license = "MIT"
@@ -64,7 +64,7 @@ pytest-regressions = "^2.4.0"
 pytest-freezer = "^0.4.6"
 pytest-xdist = "^3.1.0"
 # linter
-ruff = ">=0.5.0,<0.7.0"
+ruff = ">=0.5.0,<0.8.0"
 pre-commit = ">=2.18,<4.0"
 mypy = "^1.4"
 types-PyYAML = ">=5.4.3,<7.0.0"

commitizen-3.29.1/commitizen/__version__.py

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