python-semantic-release · lukasbehammer · Oct 19, 2024 · Sep 7, 2024 · Oct 19, 2024 · Oct 19, 2024
diff --git a/action.sh b/action.sh
@@ -35,6 +35,7 @@ ARGS+=("$(eval_boolean_action_input "push" "$INPUT_PUSH" "--push" "--no-push")")
 ARGS+=("$(eval_boolean_action_input "changelog" "$INPUT_CHANGELOG" "--changelog" "--no-changelog")") || exit 1
 ARGS+=("$(eval_boolean_action_input "vcs_release" "$INPUT_VCS_RELEASE" "--vcs-release" "--no-vcs-release")") || exit 1
 ARGS+=("$(eval_boolean_action_input "build" "$INPUT_BUILD" "" "--skip-build")") || exit 1
+ARGS+=("$(eval_boolean_action_input "pep440" "$INPUT_PEP440" "--version-compat=pep440" "--version-compat=semver")") || exit 1

 # Handle --patch, --minor, --major
 # https://stackoverflow.com/a/47541882

diff --git a/action.yml b/action.yml
@@ -108,6 +108,12 @@ inputs:
    description: |
      Build metadata to append to the new version

+  pep440:
+    type: string
+    required: false
+    description: |
+      Whether or not to use PEP440 versioning.
+
 outputs:
  is_prerelease:
    description: |

diff --git a/pyproject.toml b/pyproject.toml
@@ -165,7 +165,7 @@ commands =
 [testenv:ruff]
 deps = .[dev]
 commands =
-    ruff check . --statistics --output-format=text
+    ruff check . --statistics --output-format=full
 """

 [tool.mypy]

diff --git a/src/semantic_release/cli/commands/version.py b/src/semantic_release/cli/commands/version.py
@@ -74,17 +74,17 @@ def is_forced_prerelease(
    )


-def last_released(repo_dir: Path, tag_format: str) -> tuple[Tag, Version] | None:
+def last_released(repo_dir: Path, tag_format: str, version_compat: str) -> tuple[Tag, Version] | None:
    with Repo(str(repo_dir)) as git_repo:
        ts_and_vs = tags_and_versions(
-            git_repo.tags, VersionTranslator(tag_format=tag_format)
+            git_repo.tags, VersionTranslator(tag_format=tag_format, version_compat=version_compat)
        )

    return ts_and_vs[0] if ts_and_vs else None


 def version_from_forced_level(
-    repo_dir: Path, forced_level_bump: LevelBump, translator: VersionTranslator
+    repo_dir: Path, forced_level_bump: LevelBump, translator: VersionTranslator,
 ) -> Version:
    with Repo(str(repo_dir)) as git_repo:
        ts_and_vs = tags_and_versions(git_repo.tags, translator)
@@ -323,6 +323,12 @@ def build_distributions(
    default=None,
    help="Force the next version to use this prerelease token, if it is a prerelease",
 )
+@click.option(
+    "--version-compat",
+    "version_compat",
+    default=None,
+    help="Choose a versioning scheme to use",
+)
 @click.option(
    "--major",
    "force_level",
@@ -399,6 +405,7 @@ def version(  # noqa: C901
    print_last_released_tag: bool,
    as_prerelease: bool,
    prerelease_token: str | None,
+    version_compat: str,
    commit_changes: bool,
    create_tag: bool,
    update_changelog: bool,
@@ -436,7 +443,7 @@ def version(  # noqa: C901
    if print_last_released or print_last_released_tag:
        # TODO: get tag format a better way
        if not (
-            last_release := last_released(config.repo_dir, tag_format=config.tag_format)
+            last_release := last_released(config.repo_dir, tag_format=config.tag_format, version_compat=version_compat)
        ):
            log.warning("No release tags found.")
            return
@@ -470,6 +477,10 @@ def version(  # noqa: C901
        log.info("Forcing use of %s as the prerelease token", prerelease_token)
        translator.prerelease_token = prerelease_token

+    if version_compat:
+        translator.version_compat = version_compat
+    log.info("Using %s as the version compatibility scheme", translator.version_compat)
+
    # Only push if we're committing changes
    if push_changes and not commit_changes and not create_tag:
        log.info("changes will not be pushed because --no-commit disables pushing")

diff --git a/src/semantic_release/cli/config.py b/src/semantic_release/cli/config.py
@@ -45,7 +45,12 @@
    ScipyCommitParser,
    TagCommitParser,
 )
-from semantic_release.const import COMMIT_MESSAGE, DEFAULT_COMMIT_AUTHOR, SEMVER_REGEX
+from semantic_release.const import (
+    COMMIT_MESSAGE,
+    DEFAULT_COMMIT_AUTHOR,
+    PEP440_REGEX,
+    SEMVER_REGEX,
+)
 from semantic_release.errors import (
    DetachedHeadGitError,
    InvalidConfiguration,
@@ -239,6 +244,7 @@ class BranchConfig(BaseModel):
    match: str = "(main|master)"
    prerelease_token: str = "rc"  # noqa: S105
    prerelease: bool = False
+    version_compat: str = "semver"

    @field_validator("match", mode="after")
    @classmethod
@@ -712,7 +718,9 @@ def from_raw_config(  # noqa: C901
            try:
                path, search_text = decl.split(":", maxsplit=1)
                # VersionDeclarationABC handles path existence check
-                vd = TomlVersionDeclaration(path, search_text)
+                vd = TomlVersionDeclaration(
+                    path, search_text, version_compat=branch_config.version_compat
+                )
            except ValueError as exc:
                log.exception("Invalid TOML declaration %r", decl)
                raise InvalidConfiguration(
@@ -724,6 +732,10 @@ def from_raw_config(  # noqa: C901
        for decl in () if raw.version_variables is None else raw.version_variables:
            try:
                path, variable = decl.split(":", maxsplit=1)
+                if branch_config.version_compat == "pep440":
+                    version_pattern = PEP440_REGEX
+                else:
+                    version_pattern = SEMVER_REGEX
                # VersionDeclarationABC handles path existence check
                search_text = str.join(
                    "",
@@ -734,10 +746,10 @@ def from_raw_config(  # noqa: C901
                        # Supports walrus, equals sign, or colon as assignment operator ignoring whitespace separation
                        r"\s*(:=|[:=])\s*",
                        # Supports optional matching quotations around version number of a SEMVER pattern
-                        f"""(?P<quote2>['"])?(?P<version>{SEMVER_REGEX.pattern})(?P=quote2)?""",
+                        f"""(?P<quote2>['"])?(?P<version>{version_pattern.pattern})(?P=quote2)?""",
                    ],
                )
-                pd = PatternVersionDeclaration(path, search_text)
+                pd = PatternVersionDeclaration(path, search_text, version_compat=branch_config.version_compat)
            except ValueError as exc:
                log.exception("Invalid variable declaration %r", decl)
                raise InvalidConfiguration(
@@ -800,7 +812,9 @@ def from_raw_config(  # noqa: C901

        # version_translator
        version_translator = VersionTranslator(
-            tag_format=raw.tag_format, prerelease_token=branch_config.prerelease_token
+            tag_format=raw.tag_format,
+            prerelease_token=branch_config.prerelease_token,
+            version_compat=branch_config.version_compat,
        )

        build_cmd_env = {}

diff --git a/src/semantic_release/const.py b/src/semantic_release/const.py
@@ -19,6 +19,56 @@
    flags=re.VERBOSE,
 )

+PEP440_REGEX = re.compile(
+    r"""
+    v?
+    (?:(?P<epoch>[0-9]+)!)?
+    (?P<major>0|[1-9]\d*)
+    \.
+    (?P<minor>0|[1-9]\d*)
+    \.
+    (?P<patch>0|[1-9]\d*)
+    (?:[-_\.]?(?P<prerelease>(?:(a|b|c|rc|alpha|beta|pre|preview|dev|post|rev|r))(?:[-_\.]?(?:[0-9]+))*))?
+    (?:\+(?P<buildmetadata>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))?
+    """,
+    flags=re.VERBOSE | re.IGNORECASE,
+)
+
+# PEP440_PATTERN = re.compile(
+#     r"""
+#     ^\s*
+#     v?
+#     (?:
+#         (?:(?P<epoch>[0-9]+)!)?                           # epoch
+#         (?P<release>[0-9]+(?:\.[0-9]+)*)                  # release segment
+#         (?P<pre>                                          # pre-release
+#             [-_\.]?
+#             (?P<pre_l>(a|b|c|rc|alpha|beta|pre|preview))
+#             [-_\.]?
+#             (?P<pre_n>[0-9]+)?
+#         )?
+#         (?P<post>                                         # post release
+#             (?:-(?P<post_n1>[0-9]+))
+#             |
+#             (?:
+#                 [-_\.]?
+#                 (?P<post_l>post|rev|r)
+#                 [-_\.]?
+#                 (?P<post_n2>[0-9]+)?
+#             )
+#         )?
+#         (?P<dev>                                          # dev release
+#             [-_\.]?
+#             (?P<dev_l>dev)
+#             [-_\.]?
+#             (?P<dev_n>[0-9]+)?
+#         )?
+#     )
+#     (?:\+(?P<local>[a-z0-9]+(?:[-_\.][a-z0-9]+)*))?       # local version
+#     \s*$
+#     """,
+# )
+
 COMMIT_MESSAGE = "{version}\n\nAutomatically generated by python-semantic-release"
 DEFAULT_COMMIT_AUTHOR = "semantic-release <semantic-release>"
 DEFAULT_VERSION = "0.0.0"

diff --git a/src/semantic_release/version/declaration.py b/src/semantic_release/version/declaration.py
@@ -20,11 +20,12 @@ class VersionDeclarationABC(ABC):
    within the source tree of the repository
    """

-    def __init__(self, path: Path | str, search_text: str) -> None:
+    def __init__(self, path: Path | str, search_text: str, version_compat: str) -> None:
        self.path = Path(path)
        if not self.path.exists():
            raise FileNotFoundError(f"path {self.path.resolve()!r} does not exist")
        self.search_text = search_text
+        self.version_compat = version_compat
        self._content: str | None = None

    @property
@@ -106,7 +107,7 @@ def parse(self) -> set[Version]:
                self.search_text,
                maybe_version,
            )
-            valid_version = Version.parse(maybe_version)
+            valid_version = Version.parse(maybe_version, version_compat=self.version_compat)
            return {valid_version} if valid_version else set()
        # Maybe in future raise error if not found?
        return set()
@@ -137,8 +138,8 @@ class PatternVersionDeclaration(VersionDeclarationABC):

    _VERSION_GROUP_NAME = "version"

-    def __init__(self, path: Path | str, search_text: str) -> None:
-        super().__init__(path, search_text)
+    def __init__(self, path: Path | str, search_text: str, version_compat: str) -> None:
+        super().__init__(path, search_text, version_compat)
        self.search_re = re.compile(self.search_text, flags=re.MULTILINE)
        if self._VERSION_GROUP_NAME not in self.search_re.groupindex:
            raise ValueError(
@@ -159,7 +160,7 @@ def parse(self) -> set[Version]:
        to check for this condition.
        """
        versions = {
-            Version.parse(m.group(self._VERSION_GROUP_NAME))
+            Version.parse(m.group(self._VERSION_GROUP_NAME), version_compat=self.version_compat)
            for m in self.search_re.finditer(self.content, re.MULTILINE)
        }


diff --git a/src/semantic_release/version/translator.py b/src/semantic_release/version/translator.py
@@ -3,7 +3,6 @@
 import logging
 import re

-from semantic_release.const import SEMVER_REGEX
 from semantic_release.helpers import check_tag_format
 from semantic_release.version.version import Version

@@ -16,8 +15,6 @@ class VersionTranslator:
    instances.
    """

-    _VERSION_REGEX = SEMVER_REGEX
-
    @classmethod
    def _invert_tag_format_to_re(cls, tag_format: str) -> re.Pattern[str]:
        r"""
@@ -44,10 +41,12 @@ def __init__(
        self,
        tag_format: str = "v{version}",
        prerelease_token: str = "rc",  # noqa: S107
+        version_compat: str = "semver"
    ) -> None:
        check_tag_format(tag_format)
        self.tag_format = tag_format
        self.prerelease_token = prerelease_token
+        self.version_compat = version_compat
        self.from_tag_re = self._invert_tag_format_to_re(self.tag_format)

    def from_string(self, version_str: str) -> Version:
@@ -59,6 +58,7 @@ def from_string(self, version_str: str) -> Version:
            version_str,
            tag_format=self.tag_format,
            prerelease_token=self.prerelease_token,
+            version_compat=self.version_compat,
        )

    def from_tag(self, tag: str) -> Version | None: