Coverage for packages/workshop/src/livery/workshop/_versions.py: 100%

Measured by coverage.py 7.16.2 on CPython 3.14 while the suites of tests, packages/workshop, packages/extensions/ty, packages/extensions/ruff, packages/extensions/python, packages/extensions/pytest, packages/extensions/pyrefly, packages/extensions/nanobind, packages/extensions/mypy, packages/extensions/mkdocstrings, packages/extensions/lfs, packages/extensions/docs, packages/extensions/cpp, packages/extensions/coverage, packages/extensions/conan, packages/extensions/cmake, packages/extensions/claude, packages/extensions/clang-tidy, packages/extensions/clang-format, packages/extensions/changelog, packages/extensions/basedpyright ran.

1"""The next version a package's unreleased commits earn.
2
3The release train's version comes from the commit convention the
4base already enforces (livery.workshop._conventional): the commits
5since the package's newest receipt tag that touch its directory,
6each read for a break and a feature. Before 1.0 a break or a feature
7bumps the minor version and anything else the patch; from 1.0 a break
8bumps the major, a feature the minor, anything else the patch. A
9release commit (``chore(release)``) earns nothing, and a commit whose
10subject follows no convention counts as a patch.
11
12A package with no receipt tag yet releases at its ``[release]
13baseline``, else at 0.0.0: the first release is the starting point,
14not a bump from it.
15"""
16
17from __future__ import annotations(empty)
18
19import re(empty)
20from pathlib import Path(empty)
21
22from livery import git(empty)
23from livery.workshop._contract import load_contract(empty)
24from livery.workshop._packages import Package(empty)
25
26#: A subject that marks a break: ``!`` before the colon.
27_BREAK_SUBJECT_RE = re.compile(r"^[A-Za-z]+(\([^)]*\))?!:")(empty)
28#: A footer that marks a break.
29_BREAK_FOOTER_RE = re.compile(r"^BREAKING[ -]CHANGE:", re.MULTILINE)(empty)
30#: A feature's subject.
31_FEATURE_RE = re.compile(r"^feat(\([^)]*\))?!?:")(empty)
32#: A release commit's subject, which earns no bump.
33_RELEASE_RE = re.compile(r"^chore\(release\)")(empty)
34
35#: The separators of one commit in the log read below.
36_FIELD = "\x1f"(empty)
37_RECORD = "\x1e"(empty)
38
39
40def baseline(package: Package) -> str:(empty)
41 """The version *package* first releases at: its declared baseline, else 0.0.0."""
42 contract = load_contract(package.directory / "workshop.toml")
43 release = contract.get("release") or {}
44 declared = release.get("baseline", "") if isinstance(release, dict) else ""
45 return str(declared) or "0.0.0"
46
47
48def bump(version: str, messages: list[tuple[str, str]]) -> str:(empty)
49 """*version* bumped by the (subject, body) pairs *messages*, or unchanged.
50
51 Raises:
52 ValueError: when *version* is not ``major.minor.patch``.
53 """
54 major, minor, patch = (int(part) for part in version.split("."))
55 counted = [m for m in messages if not _RELEASE_RE.match(m[0])]
56 if not counted:
57 return version
58 breaking = any(
59 _BREAK_SUBJECT_RE.match(subject) or _BREAK_FOOTER_RE.search(body)
60 for subject, body in counted
61 )
62 feature = any(_FEATURE_RE.match(subject) for subject, _body in counted)
63 if breaking and major >= 1:
64 return f"{major + 1}.0.0"
65 if breaking or feature:
66 return f"{major}.{minor + 1}.0"
67 return f"{major}.{minor}.{patch + 1}"
68
69
70def derive_version(root: Path, package: Package, *, released: str = "") -> str:(empty)
71 """The version *package*'s unreleased commits earn, bare semver.
72
73 *released* is the newest receipt's version, read from the tags
74 when empty. With no receipt the answer is the baseline. With one,
75 an answer equal to it means nothing unreleased touches the
76 package, which the caller reports.
77 """
78 if not released:
79 from livery.workshop._update import latest_released
80
81 released = latest_released(git.tags(root)).get(package.path, "")
82 if not released:
83 return baseline(package)
84 tag = f"{package.path}/v{released}"
85 log = git.run(
86 root,
87 "log",
88 f"--format=%s{_FIELD}%b{_RECORD}",
89 f"{tag}..HEAD",
90 "--",
91 package.path,
92 )
93 messages: list[tuple[str, str]] = []
94 for record in log.split(_RECORD):
95 if not record.strip():
96 continue
97 subject, _, body = record.strip("\n").partition(_FIELD)
98 messages.append((subject, body))
99 return bump(released, messages)