Use packaging for version parsing (#2694)

Co-authored-by: Malcolm Smith <smith@chaquo.com>

Author: freakboy3742

changes/2693.bugfix.md

@@ -0,0 +1 @@
+Briefcase now accepts more version numbers as valid, including leading zeros in version components (e.g., `25.09.2`) and accepting all forms of capitalization in number suffixes (e.g., accepting both `1.2RC3` and `1.2rc3`).

src/briefcase/commands/base.py

@@ -1296,9 +1296,9 @@ def generate_template(
     ) -> None:
         # If a branch wasn't supplied through the --template-branch argument,
         # use the branch derived from the Briefcase version
-        version = Version(briefcase.__version__)
+        briefcase_version = Version(briefcase.__version__)
         if branch is None:
-            template_branch = f"v{version.base_version}"
+            template_branch = f"v{briefcase_version.base_version}"
         else:
             template_branch = branch
 
@@ -1310,7 +1310,7 @@ def generate_template(
             {
                 "template_source": template,
                 "template_branch": template_branch,
-                "briefcase_version": str(version),
+                "briefcase_version": str(briefcase_version),
             }
         )
 
@@ -1328,7 +1328,7 @@ def generate_template(
         except InvalidTemplateBranch:
             # Only use the main template if we're on a development branch of briefcase
             # and the user didn't explicitly specify which branch to use.
-            if version.dev is None or branch is not None:
+            if briefcase_version.dev is None or branch is not None:
                 raise
 
             # Development branches can use the main template.

src/briefcase/commands/create.py

@@ -243,6 +243,8 @@ def generate_app_template(self, app: AppConfig):
             {
                 # Ensure the output format is in the case we expect
                 "format": self.output_format.lower(),
+                # Ensure the version number is in string form
+                "version": str(app.version),
                 # Properties of the generating environment
                 # The full Python version string, including minor and dev/a/b/c suffixes
                 # (e.g., 3.11.0rc2)

src/briefcase/config.py

@@ -5,9 +5,10 @@
 import re
 import sys
 import unicodedata
-from types import SimpleNamespace
 from urllib.parse import urlparse
 
+from packaging.version import InvalidVersion, Version
+
 if sys.version_info >= (3, 11):  # pragma: no-cover-if-lt-py311
     import tomllib
 else:  # pragma: no-cover-if-gte-py311
@@ -17,7 +18,7 @@
 from briefcase.platforms import get_output_formats, get_platforms
 
 from .constants import RESERVED_WORDS
-from .exceptions import BriefcaseConfigError
+from .exceptions import BriefcaseConfigError, InvalidVersionError
 
 # PEP 508 restricts the naming of modules. The PEP defines a regex that uses
 # re.IGNORECASE; but in in practice, packaging uses a version that rolls out the lower
@@ -299,49 +300,6 @@ def is_valid_bundle_identifier(bundle):
     return VALID_BUNDLE_RE.match(bundle) is not None
 
 
-# This is the canonical definition from PEP440, modified to include named groups
-PEP440_CANONICAL_VERSION_PATTERN_RE = re.compile(
-    r"^((?P<epoch>[1-9][0-9]*)!)?"
-    r"(?P<release>(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*)"
-    r"((?P<pre_tag>a|b|rc)(?P<pre_value>0|[1-9][0-9]*))?"
-    r"(\.post(?P<post>0|[1-9][0-9]*))?"
-    r"(\.dev(?P<dev>0|[1-9][0-9]*))?$"
-)
-
-
-def is_pep440_canonical_version(version):
-    """Determine if the string describes a valid PEP440 canonical version specifier.
-
-    This implementation comes directly from PEP440 itself.
-
-    :returns: True if the version string is valid; false otherwise.
-    """
-    return PEP440_CANONICAL_VERSION_PATTERN_RE.match(version) is not None
-
-
-def parsed_version(version):
-    """Return a parsed version string.
-
-    :param version: The parsed version string
-    """
-    groupdict = PEP440_CANONICAL_VERSION_PATTERN_RE.match(version).groupdict()
-
-    # Convert dot separated string of integers to tuple of integers
-    groupdict["release"] = tuple(int(p) for p in groupdict.pop("release").split("."))
-
-    # Convert strings to values
-    for key in ("epoch", "pre_value", "post", "dev"):
-        try:
-            groupdict[key] = int(groupdict[key])
-        except TypeError:
-            pass
-
-    tag = groupdict.pop("pre_tag")
-    value = groupdict.pop("pre_value")
-    groupdict["pre"] = (tag, value) if tag is not None else None
-    return SimpleNamespace(**groupdict)
-
-
 def parse_boolean(value: str) -> bool:
     """Takes a string value and attempts to convert to a boolean value."""
 
@@ -419,13 +377,17 @@ def __init__(
         self.license = license
         self.requires_python = requires_python
 
-        # Version number is PEP440 compliant:
-        if not is_pep440_canonical_version(self.version):
-            raise BriefcaseConfigError(
-                f"Version number ({self.version}) is not valid.\n\n"
-                "Version numbers must be PEP440 compliant; "
-                "see https://www.python.org/dev/peps/pep-0440/ for details."
-            )
+        # Version number is compliant with PEP440 (and related updates):
+        try:
+            # If input is already a version object (can happen by copying), use as-is
+            if isinstance(version, Version):
+                self.version = version
+            else:
+                self.version = Version(version)
+        except InvalidVersion:
+            raise InvalidVersionError(
+                f"Version number ({self.version}) is not valid."
+            ) from None
 
     def __repr__(self):
         return f"<{self.project_name} v{self.version} GlobalConfig>"
@@ -537,14 +499,17 @@ def __init__(
             install=self.install_options,
         )
 
-        # Version number is PEP440 compliant:
-        if not is_pep440_canonical_version(self.version):
-            raise BriefcaseConfigError(
+        # Version number is compliant with PEP440 (and related updates):
+        try:
+            # If input is already a version object (can happen by copying), use as-is
+            if isinstance(version, Version):
+                self.version = version
+            else:
+                self.version = Version(version)
+        except InvalidVersion:
+            raise InvalidVersionError(
                 f"Version number for {self.app_name!r} ({self.version}) is not valid."
-                f"\n\n"
-                "Version numbers must be PEP440 compliant; "
-                "see https://www.python.org/dev/peps/pep-0440/ for details."
-            )
+            ) from None
 
         if self.sources:
             # Sources list doesn't include any duplicates

src/briefcase/exceptions.py

@@ -83,6 +83,16 @@ def __str__(self):
         return f"Briefcase configuration error: {self.msg}"
 
 
+class InvalidVersionError(BriefcaseConfigError):
+    def __init__(self, msg):
+        super().__init__(
+            f"{msg}\n\n"
+            "Version numbers must be PEP440 compliant; see "
+            "https://packaging.python.org/en/latest/specifications/version-specifiers/"
+            " for details."
+        )
+
+
 class UnsupportedHostError(BriefcaseError):
     def __init__(self, reason):
         super().__init__(error_code=110, skip_logfile=True)

src/briefcase/integrations/flatpak.py

@@ -4,6 +4,8 @@
 from collections.abc import Collection
 from pathlib import Path
 
+from packaging.version import Version
+
 from briefcase.exceptions import BriefcaseCommandError
 from briefcase.integrations.base import Tool, ToolCache
 from briefcase.integrations.subprocess import SubprocessArgT
@@ -297,7 +299,7 @@ def bundle(
         repo_url: str,
         bundle_identifier: str,
         app_name: str,
-        version: str,
+        version: Version,
         build_path: Path,
         output_path: Path,
     ):
@@ -328,7 +330,7 @@ def bundle(
                     "repo",
                     output_path,
                     bundle_identifier,
-                    version,
+                    str(version),
                 ]
                 + (["--verbose"] if self.tools.console.is_deep_debug else []),
                 check=True,

src/briefcase/platforms/android/gradle.py

@@ -17,7 +17,7 @@
     RunCommand,
     UpdateCommand,
 )
-from briefcase.config import AppConfig, parsed_version
+from briefcase.config import AppConfig
 from briefcase.console import ANSI_ESC_SEQ_RE_DEF
 from briefcase.debuggers.base import (
     AppPackagesPathMappings,
@@ -176,9 +176,7 @@ def output_format_template_context(self, app: AppConfig):
         try:
             version_code = app.version_code
         except AttributeError:
-            parsed = parsed_version(app.version)
-
-            v = ([*parsed.release, 0, 0])[:3]  # version triple
+            v = ([*app.version.release, 0, 0])[:3]  # version triple
             build = int(getattr(app, "build", "0"))
             version_code = f"{v[0]:d}{v[1]:02d}{v[2]:02d}{build:02d}".lstrip("0")
 

src/briefcase/platforms/linux/appimage.py

@@ -295,7 +295,7 @@ def build_app(self, app: AppConfig, **kwargs):  # pragma: no-cover-if-is-windows
             try:
                 # For some reason, the version has to be passed in as an
                 # environment variable, *not* in the configuration.
-                env["LINUXDEPLOY_OUTPUT_VERSION"] = app.version
+                env["LINUXDEPLOY_OUTPUT_VERSION"] = str(app.version)
                 # The internals of the binary aren't inherently visible, so
                 # there's no need to package copyright files. These files
                 # appear to be missing by default in the OS dev packages anyway,

src/briefcase/platforms/windows/__init__.py

@@ -8,7 +8,7 @@
 from zipfile import ZIP_DEFLATED, ZipFile
 
 from briefcase.commands import CreateCommand, PackageCommand, RunCommand
-from briefcase.config import AppConfig, parsed_version
+from briefcase.config import AppConfig
 from briefcase.exceptions import BriefcaseCommandError, UnsupportedHostError
 from briefcase.integrations.windows_sdk import WindowsSDK
 from briefcase.integrations.wix import WiX
@@ -145,9 +145,8 @@ def output_format_template_context(self, app: AppConfig):
         try:
             version_triple = app.version_triple
         except AttributeError:
-            parsed = parsed_version(app.version)
             version_triple = ".".join(
-                ([str(v) for v in parsed.release] + ["0", "0"])[:3]
+                ([str(v) for v in app.version.release] + ["0", "0"])[:3]
             )
 
         # The application needs a unique GUID.

src/briefcase/platforms/windows/app.py

@@ -122,7 +122,7 @@ def build_app(self, app: BaseConfig, **kwargs):
                         app.formal_name,
                         "--set-version-string",
                         "FileVersion",
-                        app.version,
+                        str(app.version),
                         "--set-version-string",
                         "InternalName",
                         app.module_name,
@@ -134,7 +134,7 @@ def build_app(self, app: BaseConfig, **kwargs):
                         app.formal_name,
                         "--set-version-string",
                         "ProductVersion",
-                        app.version,
+                        str(app.version),
                         "--set-icon",
                         "icon.ico",
                     ],