commitizen 4.16.5__tar.gz → 4.17.1__tar.gz

{commitizen-4.16.5 → commitizen-4.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commitizen
-Version: 4.16.5
+Version: 4.17.1
 Summary: Python commitizen client tool
 Keywords: commitizen,conventional,commits,git
 Author: Santiago Fraire
@@ -349,11 +349,6 @@ After installation, you can verify the completion is working by:
 
 For more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/).
 
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=commitizen-tools/commitizen)](https://star-history.com/#commitizen-tools/commitizen)
-
-
 ## Sponsors
 
 These are our cool sponsors!

commitizen-4.17.1/commitizen/__version__.py

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

{commitizen-4.16.5 → commitizen-4.17.1}/commitizen/cli.py

@@ -583,7 +583,6 @@ data = {
                         "const": "USE_GIT_COMMITS",
                         "choices": ["USE_GIT_COMMITS"]
                         + [str(increment) for increment in VersionIncrement],
-                        "exclusive_group": "group2",
                     },
                     {
                         "name": "manual_version",

{commitizen-4.16.5 → commitizen-4.17.1}/commitizen/commands/changelog.py

@@ -31,7 +31,7 @@ class ChangelogArgs(TypedDict, total=False):
     change_type_order: list[str]
     current_version: str
     dry_run: bool
-    file_name: str
+    file_name: str | None
     incremental: bool
     merge_prerelease: bool
     rev_range: str

{commitizen-4.16.5 → commitizen-4.17.1}/commitizen/commands/init.py

@@ -109,13 +109,7 @@ class Init:
             tag_format = self._ask_tag_format(tag)  # confirm & text
             update_changelog_on_bump = self._ask_update_changelog_on_bump()  # confirm
             major_version_zero = self._ask_major_version_zero(version)  # confirm
-            hook_types: list[str] | None = questionary.checkbox(
-                "What types of pre-commit hook you want to install? (Leave blank if you don't want to install)",
-                choices=[
-                    questionary.Choice("commit-msg", checked=False),
-                    questionary.Choice("pre-push", checked=False),
-                ],
-            ).unsafe_ask()
+            hook_types = self._ask_hook_types()
         except KeyboardInterrupt:
             raise InitFailedError("Stopped by user")
 
@@ -128,13 +122,9 @@ class Init:
             ) as config_file:
                 yaml.safe_dump(config_data, stream=config_file)
 
-            if not project_info.is_pre_commit_installed():
-                raise InitFailedError(
-                    "Failed to install pre-commit hook.\n"
-                    "pre-commit is not installed in current environment."
-                )
+            installer = self._ask_hook_installer()
 
-            cmd_args = ["pre-commit", "install"]
+            cmd_args = [installer, "install"]
             for ty in hook_types:
                 cmd_args.extend(["--hook-type", ty])
             c = cmd.run(cmd_args)
@@ -164,6 +154,48 @@ class Init:
         out.info("\tcz bump\n")
         out.success("Configuration complete 🚀")
 
+    def _ask_hook_types(self) -> list[str] | None:
+        """Ask which pre-commit hook types to install.
+
+        Skip the question when neither ``pre-commit`` nor ``prek`` is
+        installed, so users who do not use those tools are not prompted.
+        """
+        if not project_info.available_hook_installers():
+            out.info("No pre-commit hook detected, skipping question")
+            return None
+
+        hook_types: list[str] | None = questionary.checkbox(
+            "What types of pre-commit hook you want to install? (Leave blank if you don't want to install)",
+            choices=[
+                questionary.Choice("commit-msg", checked=False),
+                questionary.Choice("pre-push", checked=False),
+            ],
+        ).unsafe_ask()
+        return hook_types
+
+    def _ask_hook_installer(self) -> str:
+        """Choose ``pre-commit`` or ``prek`` when installing Git hooks.
+
+        Detection already accepts either tool, but install used to
+        hard-code ``pre-commit``. Use the only available installer, or
+        ask when both are on PATH.
+        """
+        installers = project_info.available_hook_installers()
+        if not installers:
+            raise InitFailedError(
+                "Failed to install pre-commit hook.\n"
+                "Neither pre-commit nor prek is installed in the current environment."
+            )
+        if len(installers) == 1:
+            return installers[0]
+
+        installer: str = questionary.select(
+            "Which hook installer do you want to use?",
+            choices=installers,
+            style=self.cz.style,
+        ).unsafe_ask()
+        return installer
+
     def _ask_config_path(self) -> Path:
         filename: str = questionary.select(
             "Please choose a supported config file: ",

{commitizen-4.16.5 → commitizen-4.17.1}/commitizen/commands/version.py

@@ -4,14 +4,20 @@ from typing import TypedDict
 
 from packaging.version import InvalidVersion
 
-from commitizen import out
+from commitizen import bump, factory, git, out
 from commitizen.__version__ import __version__
 from commitizen.config import BaseConfig
-from commitizen.exceptions import NoVersionSpecifiedError, VersionSchemeUnknown
+from commitizen.exceptions import (
+    NoCommitsFoundError,
+    NoPatternMapError,
+    NotAGitProjectError,
+    NoVersionSpecifiedError,
+    VersionSchemeUnknown,
+)
 from commitizen.providers import get_provider
 from commitizen.tags import TagRules
 from commitizen.version_increment import VersionIncrement
-from commitizen.version_schemes import Increment, get_version_scheme
+from commitizen.version_schemes import Increment, VersionProtocol, get_version_scheme
 
 
 class VersionArgs(TypedDict, total=False):
@@ -63,6 +69,9 @@ class Version:
             or self.arguments.get("next")
             or self.arguments.get("manual_version")
         ):
+            # TODO: once `cz --version` is implemented, move `self.cz` back to __init__
+            self.cz = factory.committer_factory(self.config)
+
             version_str = self.arguments.get("manual_version")
             if version_str is None:
                 try:
@@ -84,11 +93,15 @@ class Version:
 
             if next_increment_str := self.arguments.get("next"):
                 if next_increment_str == "USE_GIT_COMMITS":
+                    # Only check under `git` to allow the user to do stuff like
+                    # `cz version 1.2.3 --major`
+                    if not git.is_git_project():
+                        raise NotAGitProjectError()
+
                     # TODO: implement USE_GIT_COMMITS by deriving the increment from
                     # git history. This requires refactoring the bump logic out of
                     # `commitizen/commands/bump.py` so it can be reused here. See #1678.
-                    out.error("--next USE_GIT_COMMITS is not implemented yet.")
-                    return
+                    version = self._get_next_git_version(version)
 
                 next_increment = VersionIncrement.from_value(next_increment_str)
                 increment: Increment | None
@@ -100,6 +113,9 @@ class Version:
                     increment = "MINOR"
                 else:
                     increment = "MAJOR"
+
+                # TODO: Consider adding all the parameters `.bump` supports:
+                # prerelease, prerelease_offset,exact_increment, etc...
                 version = version.bump(increment=increment)
 
             if self.arguments.get("major"):
@@ -139,3 +155,39 @@ class Version:
 
         # If no arguments are provided, just show the installed commitizen version
         out.write(__version__)
+
+    def _get_next_git_version(
+        self, current_version: VersionProtocol
+    ) -> VersionProtocol:
+        """Calculate the next version based on commits."""
+        rules = TagRules.from_settings(self.config.settings)
+        current_tag = rules.find_tag_for(git.get_tags(), current_version)
+        commits = git.get_commits(current_tag.name if current_tag else None)
+
+        # No commits, there is no need to create an empty tag.
+        # Unless we previously had a prerelease.
+        if not commits and not current_version.is_prerelease:
+            raise NoCommitsFoundError("[NO_COMMITS_FOUND]\nNo new commits found.")
+
+        bump_map = (
+            self.cz.bump_map_major_version_zero
+            if self.config.settings["major_version_zero"]
+            else self.cz.bump_map
+        )
+        bump_pattern = self.cz.bump_pattern
+
+        if not bump_map or not bump_pattern:
+            raise NoPatternMapError(
+                f"'{self.config.settings['name']}' rule does not support bump"
+            )
+        increment = bump.find_increment(
+            commits, regex=bump_pattern, increments_map=bump_map
+        )
+
+        # TODO: Consider adding all the parameters `.bump` supports:
+        # prerelease, prerelease_offset,exact_increment, etc..
+        new_version = current_version.bump(
+            increment,
+        )
+
+        return new_version

{commitizen-4.16.5 → commitizen-4.17.1}/commitizen/project_info.py

@@ -4,9 +4,22 @@ import shutil
 from pathlib import Path
 from typing import Literal
 
+_HOOK_INSTALLERS = ("pre-commit", "prek")
+
+
+def available_hook_installers() -> list[str]:
+    """Return hook installer CLIs found on PATH.
+
+    ``pre-commit`` and ``prek`` are interchangeable. ``pre-commit`` is
+    listed first when both are present so existing setups keep a stable
+    default unless the user is asked to choose.
+    """
+    return [tool for tool in _HOOK_INSTALLERS if shutil.which(tool)]
+
 
 def is_pre_commit_installed() -> bool:
-    return any(shutil.which(tool) for tool in ("pre-commit", "prek"))
+    """Return whether any supported hook installer is on PATH."""
+    return bool(available_hook_installers())
 
 
 def get_default_version_provider() -> Literal[

{commitizen-4.16.5 → commitizen-4.17.1}/docs/README.md

@@ -303,11 +303,6 @@ After installation, you can verify the completion is working by:
 
 For more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/).
 
-## Star History
-
-[![Star History Chart](https://api.star-history.com/svg?repos=commitizen-tools/commitizen)](https://star-history.com/#commitizen-tools/commitizen)
-
-
 ## Sponsors
 
 These are our cool sponsors!

commitizen-4.17.1/pyproject.toml

@@ -0,0 +1,363 @@
+[project]
+name = "commitizen"
+version = "4.17.1"
+description = "Python commitizen client tool"
+license = "MIT"
+license-files = ["LICENSE"]
+readme = "docs/README.md"
+requires-python = ">=3.10,<4.0"
+dependencies = [
+    "questionary (>=2.0,<3.0)",
+    "prompt_toolkit!=3.0.52",
+    "decli (>=0.6.0,<1.0)",
+    "colorama (>=0.4.1,<1.0)",
+    "termcolor (>=1.1.0,<4.0.0)",
+    "packaging>=26",
+    "tomlkit (>=0.8.0,<1.0.0)",
+    "jinja2>=2.10.3",
+    "pyyaml>=3.08",
+    "argcomplete >=1.12.1,<3.8",
+    "typing-extensions (>=4.0.1,<5.0.0) ; python_version < '3.11'",
+    "charset-normalizer (>=2.1.0,<4)",
+    "deprecated (>=1.2.13, <2)",
+    "importlib-metadata >=8.0.0,<8.7.0 ; python_version < '3.10'",
+]
+keywords = [
+    "commitizen",
+    "conventional",
+    "commits",
+    "git",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+]
+
+[[project.authors]]
+name = "Santiago Fraire"
+email = "santiwilly@gmail.com"
+
+[[project.maintainers]]
+name = "Wei Lee"
+email = "weilee.rx@gmail.com"
+
+[[project.maintainers]]
+name = "Axel H."
+email = "noirbizarre@gmail.com"
+
+[[project.maintainers]]
+name = "Tim Hsiung"
+email = "bear890707@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/commitizen-tools/commitizen"
+Documentation = "https://commitizen-tools.github.io/commitizen/"
+Repository = "https://github.com/commitizen-tools/commitizen"
+Issues = "https://github.com/commitizen-tools/commitizen/issues"
+Changelog = "https://github.com/commitizen-tools/commitizen/blob/master/CHANGELOG.md"
+
+[project.scripts]
+cz = "commitizen.cli:main"
+git-cz = "commitizen.cli:main"
+
+[project.entry-points."commitizen.plugin"]
+cz_conventional_commits = "commitizen.cz.conventional_commits:ConventionalCommitsCz"
+cz_jira = "commitizen.cz.jira:JiraSmartCz"
+cz_customize = "commitizen.cz.customize:CustomizeCommitsCz"
+
+[project.entry-points."commitizen.changelog_format"]
+markdown = "commitizen.changelog_formats.markdown:Markdown"
+asciidoc = "commitizen.changelog_formats.asciidoc:AsciiDoc"
+textile = "commitizen.changelog_formats.textile:Textile"
+restructuredtext = "commitizen.changelog_formats.restructuredtext:RestructuredText"
+
+[project.entry-points."commitizen.provider"]
+cargo = "commitizen.providers:CargoProvider"
+commitizen = "commitizen.providers:CommitizenProvider"
+composer = "commitizen.providers:ComposerProvider"
+npm = "commitizen.providers:NpmProvider"
+pep621 = "commitizen.providers:Pep621Provider"
+poetry = "commitizen.providers:PoetryProvider"
+scm = "commitizen.providers:ScmProvider"
+uv = "commitizen.providers:UvProvider"
+
+[project.entry-points."commitizen.scheme"]
+pep440 = "commitizen.version_schemes:Pep440"
+semver = "commitizen.version_schemes:SemVer"
+semver2 = "commitizen.version_schemes:SemVer2"
+
+[dependency-groups]
+dev = [
+    { include-group = "base" },
+    { include-group = "test" },
+    { include-group = "linters" },
+    { include-group = "documentation" },
+    { include-group = "script" },
+    "ipython>=8.0",
+    "tox>4",
+    "tox-uv",
+]
+base = [
+    "mkdocs-llmstxt>=0.5.0",
+    "poethepoet>=0.34.0",
+]
+test = [
+    "pytest>=9",
+    "pytest-cov>=4",
+    "pytest-mock>=3.10",
+    "pytest-regressions>=2.4.0",
+    "pytest-freezer>=0.4.6",
+    "pytest-xdist>=3.1.0",
+    "pytest-gitconfig>=0.9.0",
+    "pre-commit>=4.5.1",
+]
+linters = [
+    "ruff>=0.11.5",
+    "mypy>=1.16.0",
+    "types-deprecated>=1.2.9.2",
+    "types-python-dateutil>=2.8.19.13",
+    "types-PyYAML>=5.4.3",
+    "types-termcolor>=0.1.1",
+    "types-colorama>=0.4.15.20240311",
+    "prek>=0.2.28",
+]
+documentation = [
+    "mkdocs>=1.4.2,<2",
+    "mkdocs-git-revision-date-localized-plugin>=1.5.0",
+    "mkdocs-material>=9.1.6",
+]
+script = ["rich>=13.7.1"]
+
+[build-system]
+requires = ["uv_build >= 0.9.17, < 0.13"]
+build-backend = "uv_build"
+
+[tool.commitizen]
+tag_format = "v$version"
+version_files = [
+    "commitizen/__version__.py",
+    ".pre-commit-config.yaml:rev:.+Commitizen",
+]
+version_provider = "uv"
+version_scheme = "pep440"
+annotated_tag = true
+
+[tool.uv.build-backend]
+module-name = "commitizen"
+module-root = ""
+include = ["commitizen/py.typed"]
+
+[tool.coverage.report]
+show_missing = true
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    'if self\.debug',
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+omit = [
+    "env/*",
+    "venv/*",
+    ".venv/*",
+    "*/virtualenv/*",
+    "*/virtualenvs/*",
+    "*/tests/*",
+]
+
+[tool.pytest]
+addopts = ["--strict-markers"]
+testpaths = ["tests/"]
+filterwarnings = ['ignore:Call to deprecated function \(or staticmethod\) get_smart_tag_range:DeprecationWarning']
+
+[tool.tox]
+requires = ["tox>=4.22"]
+env_list = [
+    "3.10",
+    "3.11",
+    "3.12",
+    "3.13",
+    "3.14",
+]
+
+[tool.tox.env_run_base]
+description = "Run tests suite against Python {base_python}"
+dependency_groups = ["test"]
+commands = [[
+    "pytest",
+    { replace = "posargs", extend = true },
+]]
+
+[tool.ruff]
+required-version = ">=0.11.5"
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "ANN001",
+    "ANN2",
+    "E",
+    "F",
+    "UP",
+    "I",
+    "PGH003",
+    "PGH004",
+    "RUF022",
+    "RUF100",
+    "PT",
+    "S101",
+    "TC001",
+    "TC002",
+    "TC003",
+    "TC004",
+    "TC005",
+    "TC006",
+]
+ignore = [
+    "E501",
+    "D1",
+    "D415",
+]
+extend-safe-fixes = [
+    "TC",
+    "UP",
+    "PT006",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "ANN",
+    "S101",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = [
+    "commitizen",
+    "tests",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.mypy]
+files = [
+    "commitizen",
+    "tests",
+    "scripts",
+]
+disallow_untyped_decorators = true
+disallow_subclassing_any = true
+warn_return_any = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = "py.*"
+ignore_missing_imports = true
+
+[tool.codespell]
+skip = ".git*,*.svg,*.lock"
+check-hidden = true
+ignore-words-list = "asend"
+
+[tool.poe.executor]
+type = "uv"
+
+[tool.poe.tasks.format]
+help = "Format the code"
+
+[[tool.poe.tasks.format.sequence]]
+cmd = "ruff check --fix"
+
+[[tool.poe.tasks.format.sequence]]
+cmd = "ruff format"
+
+[tool.poe.tasks.lint]
+help = "Lint the code"
+
+[[tool.poe.tasks.lint.sequence]]
+cmd = "ruff check"
+
+[[tool.poe.tasks.lint.sequence]]
+cmd = "mypy"
+
+[tool.poe.tasks.check-commit]
+help = "Check the commit messages"
+cmd = "cz --no-raise 3 check --rev-range origin/master.."
+
+[tool.poe.tasks.test]
+help = "Run the test suite"
+cmd = "pytest -n auto --dist=loadfile"
+
+[tool.poe.tasks."test:all"]
+help = "Run the test suite on all supported Python versions"
+cmd = "tox --parallel"
+
+[tool.poe.tasks."test:regen"]
+help = "Regenerate the test fixtures"
+
+[[tool.poe.tasks."test:regen".parallel]]
+ref = "test -k 'not py_' --regen-all"
+
+[[tool.poe.tasks."test:regen".parallel]]
+ref = "test:all -- -k py_ --regen-all"
+
+[tool.poe.tasks.cover]
+help = "Run the test suite with coverage"
+ref = "test --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen  --junitxml=junit.xml -o junit_family=legacy"
+
+[tool.poe.tasks.all]
+help = "Run all tasks"
+sequence = [
+    "format",
+    "lint",
+    "check-commit",
+    "cover",
+]
+
+[tool.poe.tasks."doc:screenshots"]
+help = "Render documentation screenshots"
+
+[[tool.poe.tasks."doc:screenshots".parallel]]
+script = "scripts.gen_cli_help_screenshots:gen_cli_help_screenshots"
+
+[[tool.poe.tasks."doc:screenshots".parallel]]
+script = "scripts.gen_cli_interactive_gifs:gen_cli_interactive_gifs"
+
+[tool.poe.tasks."doc:build"]
+help = "Build the documentation"
+cmd = "mkdocs build"
+
+[tool.poe.tasks.doc]
+help = "Live documentation server"
+cmd = "mkdocs serve --livereload"
+
+[tool.poe.tasks.ci]
+help = "Run all tasks in CI"
+sequence = [
+    "check-commit",
+    { cmd = "prek run --all-files" },
+    "cover",
+]
+
+[tool.poe.tasks.ci.env]
+SKIP = "no-commit-to-branch"
+
+[tool.poe.tasks.setup-pre-commit]
+help = "Install pre-commit hooks"
+cmd = "prek install"

commitizen-4.16.5/pyproject.toml → commitizen-4.17.1/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "commitizen"
-version = "4.16.5"
+version = "4.17.1"
 description = "Python commitizen client tool"
 authors = [{ name = "Santiago Fraire", email = "santiwilly@gmail.com" }]
 maintainers = [
@@ -133,7 +133,7 @@ script = [
 ]
 
 [build-system]
-requires = ["uv_build >= 0.9.17, <0.12"]
+requires = ["uv_build >= 0.9.17, < 0.13"]
 build-backend = "uv_build"
 
 

commitizen-4.16.5/commitizen/__version__.py

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