commitizen 3.29.0__tar.gz → 3.29.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: commitizen
-Version: 3.29.0
+Version: 3.29.1
 Summary: Python commitizen client tool
 Home-page: https://github.com/commitizen-tools/commitizen
 License: MIT
@@ -84,10 +84,18 @@ descriptive commits.
 
 ## Installation
 
-To make commitizen available in your system
+Install commitizen in your system using `pipx` (Recommended, <https://pypa.github.io/pipx/installation/>):
 
 ```bash
-pip install --user -U Commitizen
+pipx ensurepath
+pipx install commitizen
+pipx upgrade commitizen
+```
+
+Install commitizen using `pip` with `--user` flag:
+
+```bash
+pip install --user -U commitizen
 ```
 
 ### Python project

commitizen-3.29.1/commitizen/__version__.py

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

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/changelog.py

@@ -44,6 +44,7 @@ from jinja2 import (
 from commitizen import out
 from commitizen.bump import normalize_tag
 from commitizen.cz.base import ChangelogReleaseHook
+from commitizen.defaults import get_tag_regexes
 from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError
 from commitizen.git import GitCommit, GitTag
 from commitizen.version_schemes import (
@@ -93,16 +94,21 @@ def tag_included_in_changelog(
     return True
 
 
-def get_version_tags(scheme: type[BaseVersion], tags: list[GitTag]) -> list[GitTag]:
+def get_version_tags(
+    scheme: type[BaseVersion], tags: list[GitTag], tag_format: str
+) -> list[GitTag]:
     valid_tags: list[GitTag] = []
+    TAG_FORMAT_REGEXS = get_tag_regexes(scheme.parser.pattern)
+    tag_format_regex = tag_format
+    for pattern, regex in TAG_FORMAT_REGEXS.items():
+        tag_format_regex = tag_format_regex.replace(pattern, regex)
     for tag in tags:
-        try:
-            scheme(tag.name)
-        except InvalidVersion:
-            out.warn(f"InvalidVersion {tag}")
-        else:
+        if re.match(tag_format_regex, tag.name):
             valid_tags.append(tag)
-
+        else:
+            out.warn(
+                f"InvalidVersion {tag.name} doesn't match configured tag format {tag_format}"
+            )
     return valid_tags
 
 
@@ -351,7 +357,6 @@ def get_oldest_and_newest_rev(
         oldest, newest = version.split("..")
     except ValueError:
         newest = version
-
     newest_tag = normalize_tag(newest, tag_format=tag_format, scheme=scheme)
 
     oldest_tag = None

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/changelog_formats/asciidoc.py

@@ -18,7 +18,19 @@ class AsciiDoc(BaseFormat):
         matches = list(re.finditer(self.version_parser, m.group("title")))
         if not matches:
             return None
-        return matches[-1].group("version")
+        if "version" in matches[-1].groupdict():
+            return matches[-1].group("version")
+        partial_matches = matches[-1].groupdict()
+        try:
+            partial_version = f"{partial_matches['major']}.{partial_matches['minor']}.{partial_matches['patch']}"
+        except KeyError:
+            return None
+
+        if partial_matches.get("prerelease"):
+            partial_version = f"{partial_version}-{partial_matches['prerelease']}"
+        if partial_matches.get("devrelease"):
+            partial_version = f"{partial_version}{partial_matches['devrelease']}"
+        return partial_version
 
     def parse_title_level(self, line: str) -> int | None:
         m = self.RE_TITLE.match(line)

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/changelog_formats/base.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
 
 import os
+import re
 from abc import ABCMeta
 from re import Pattern
 from typing import IO, Any, ClassVar
 
 from commitizen.changelog import Metadata
 from commitizen.config.base_config import BaseConfig
+from commitizen.defaults import get_tag_regexes
 from commitizen.version_schemes import get_version_scheme
 
 from . import ChangelogFormat
@@ -25,10 +27,16 @@ class BaseFormat(ChangelogFormat, metaclass=ABCMeta):
         # See: https://bugs.python.org/issue44807
         self.config = config
         self.encoding = self.config.settings["encoding"]
+        self.tag_format = self.config.settings["tag_format"]
 
     @property
     def version_parser(self) -> Pattern:
-        return get_version_scheme(self.config).parser
+        tag_regex: str = self.tag_format
+        version_regex = get_version_scheme(self.config).parser.pattern
+        TAG_FORMAT_REGEXS = get_tag_regexes(version_regex)
+        for pattern, regex in TAG_FORMAT_REGEXS.items():
+            tag_regex = tag_regex.replace(pattern, regex)
+        return re.compile(tag_regex)
 
     def get_metadata(self, filepath: str) -> Metadata:
         if not os.path.isfile(filepath):

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/changelog_formats/markdown.py

@@ -19,7 +19,21 @@ class Markdown(BaseFormat):
         m = re.search(self.version_parser, m.group("title"))
         if not m:
             return None
-        return m.group("version")
+        if "version" in m.groupdict():
+            return m.group("version")
+        matches = m.groupdict()
+        try:
+            partial_version = (
+                f"{matches['major']}.{matches['minor']}.{matches['patch']}"
+            )
+        except KeyError:
+            return None
+
+        if matches.get("prerelease"):
+            partial_version = f"{partial_version}-{matches['prerelease']}"
+        if matches.get("devrelease"):
+            partial_version = f"{partial_version}{matches['devrelease']}"
+        return partial_version
 
     def parse_title_level(self, line: str) -> int | None:
         m = self.RE_TITLE.match(line)

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/changelog_formats/restructuredtext.py

@@ -46,7 +46,6 @@ class RestructuredText(BaseFormat):
             third = third.strip().lower()
             title: str | None = None
             kind: TitleKind | None = None
-
             if self.is_overlined_title(first, second, third):
                 title = second
                 kind = (first[0], third[0])
@@ -67,10 +66,29 @@ class RestructuredText(BaseFormat):
                 # Try to find the latest release done
                 m = re.search(self.version_parser, title)
                 if m:
-                    version = m.group("version")
-                    meta.latest_version = version
-                    meta.latest_version_position = index
-                    break  # there's no need for more info
+                    matches = m.groupdict()
+                    if "version" in matches:
+                        version = m.group("version")
+                        meta.latest_version = version
+                        meta.latest_version_position = index
+                        break  # there's no need for more info
+                    try:
+                        partial_version = (
+                            f"{matches['major']}.{matches['minor']}.{matches['patch']}"
+                        )
+                        if matches.get("prerelease"):
+                            partial_version = (
+                                f"{partial_version}-{matches['prerelease']}"
+                            )
+                        if matches.get("devrelease"):
+                            partial_version = (
+                                f"{partial_version}{matches['devrelease']}"
+                            )
+                        meta.latest_version = partial_version
+                        meta.latest_version_position = index
+                        break
+                    except KeyError:
+                        pass
         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

commitizen-3.29.1/commitizen/changelog_formats/textile.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+import re
+
+from .base import BaseFormat
+
+
+class Textile(BaseFormat):
+    extension = "textile"
+
+    RE_TITLE = re.compile(r"^h(?P<level>\d)\. (?P<title>.*)$")
+
+    def parse_version_from_title(self, line: str) -> str | None:
+        if not self.RE_TITLE.match(line):
+            return None
+        m = re.search(self.version_parser, line)
+        if not m:
+            return None
+        if "version" in m.groupdict():
+            return m.group("version")
+        matches = m.groupdict()
+        if not all(
+            [
+                version_segment in matches
+                for version_segment in ("major", "minor", "patch")
+            ]
+        ):
+            return None
+
+        partial_version = f"{matches['major']}.{matches['minor']}.{matches['patch']}"
+
+        if matches.get("prerelease"):
+            partial_version = f"{partial_version}-{matches['prerelease']}"
+        if matches.get("devrelease"):
+            partial_version = f"{partial_version}{matches['devrelease']}"
+        return partial_version
+
+    def parse_title_level(self, line: str) -> int | None:
+        m = self.RE_TITLE.match(line)
+        if not m:
+            return None
+        return int(m.group("level"))

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/commands/changelog.py

@@ -168,8 +168,10 @@ class Changelog:
         # Don't continue if no `file_name` specified.
         assert self.file_name
 
-        tags = changelog.get_version_tags(self.scheme, git.get_tags()) or []
-
+        tags = (
+            changelog.get_version_tags(self.scheme, git.get_tags(), self.tag_format)
+            or []
+        )
         end_rev = ""
         if self.incremental:
             changelog_meta = self.changelog_format.get_metadata(self.file_name)
@@ -182,7 +184,6 @@ class Changelog:
                 start_rev = self._find_incremental_rev(
                     strip_local_version(latest_tag_version), tags
                 )
-
         if self.rev_range:
             start_rev, end_rev = changelog.get_oldest_and_newest_rev(
                 tags,
@@ -190,13 +191,11 @@ class Changelog:
                 tag_format=self.tag_format,
                 scheme=self.scheme,
             )
-
         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,

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

@@ -132,3 +132,22 @@ bump_map_major_version_zero = OrderedDict(
 )
 change_type_order = ["BREAKING CHANGE", "Feat", "Fix", "Refactor", "Perf"]
 bump_message = "bump: version $current_version → $new_version"
+
+
+def get_tag_regexes(
+    version_regex: str,
+) -> dict[str, str]:
+    return {
+        "$version": version_regex,
+        "$major": r"(?P<major>\d+)",
+        "$minor": r"(?P<minor>\d+)",
+        "$patch": r"(?P<patch>\d+)",
+        "$prerelease": r"(?P<prerelease>\w+\d+)?",
+        "$devrelease": r"(?P<devrelease>\.dev\d+)?",
+        "${version}": version_regex,
+        "${major}": r"(?P<major>\d+)",
+        "${minor}": r"(?P<minor>\d+)",
+        "${patch}": r"(?P<patch>\d+)",
+        "${prerelease}": r"(?P<prerelease>\w+\d+)?",
+        "${devrelease}": r"(?P<devrelease>\.dev\d+)?",
+    }

{commitizen-3.29.0 → commitizen-3.29.1}/commitizen/providers/scm_provider.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import re
 from typing import Callable
 
+from commitizen.defaults import get_tag_regexes
 from commitizen.git import get_tags
 from commitizen.providers.base_provider import VersionProvider
 from commitizen.version_schemes import (
@@ -22,14 +23,7 @@ class ScmProvider(VersionProvider):
     It is meant for `setuptools-scm` or any package manager `*-scm` provider.
     """
 
-    TAG_FORMAT_REGEXS = {
-        "$version": r"(?P<version>.+)",
-        "$major": r"(?P<major>\d+)",
-        "$minor": r"(?P<minor>\d+)",
-        "$patch": r"(?P<patch>\d+)",
-        "$prerelease": r"(?P<prerelease>\w+\d+)?",
-        "$devrelease": r"(?P<devrelease>\.dev\d+)?",
-    }
+    TAG_FORMAT_REGEXS = get_tag_regexes(r"(?P<version>.+)")
 
     def _tag_format_matcher(self) -> Callable[[str], VersionProtocol | None]:
         version_scheme = get_version_scheme(self.config)

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

@@ -46,10 +46,18 @@ descriptive commits.
 
 ## Installation
 
-To make commitizen available in your system
+Install commitizen in your system using `pipx` (Recommended, <https://pypa.github.io/pipx/installation/>):
 
 ```bash
-pip install --user -U Commitizen
+pipx ensurepath
+pipx install commitizen
+pipx upgrade commitizen
+```
+
+Install commitizen using `pip` with `--user` flag:
+
+```bash
+pip install --user -U commitizen
 ```
 
 ### Python project

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

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "3.29.0"
+version = "3.29.1"
 tag_format = "v$version"
 version_files = [
   "pyproject.toml:version",
@@ -9,7 +9,7 @@ version_files = [
 
 [tool.poetry]
 name = "commitizen"
-version = "3.29.0"
+version = "3.29.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.6.0"
+ruff = ">=0.5.0,<0.7.0"
 pre-commit = ">=2.18,<4.0"
 mypy = "^1.4"
 types-PyYAML = ">=5.4.3,<7.0.0"

commitizen-3.29.0/commitizen/__version__.py

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

commitizen-3.29.0/commitizen/changelog_formats/textile.py

@@ -1,25 +0,0 @@
-from __future__ import annotations
-
-import re
-
-from .base import BaseFormat
-
-
-class Textile(BaseFormat):
-    extension = "textile"
-
-    RE_TITLE = re.compile(r"^h(?P<level>\d)\. (?P<title>.*)$")
-
-    def parse_version_from_title(self, line: str) -> str | None:
-        if not self.RE_TITLE.match(line):
-            return None
-        m = re.search(self.version_parser, line)
-        if not m:
-            return None
-        return m.group("version")
-
-    def parse_title_level(self, line: str) -> int | None:
-        m = self.RE_TITLE.match(line)
-        if not m:
-            return None
-        return int(m.group("level"))