Merge pull request #529 from ikerreyes/calver-by-date

CalVer by date

Author: RonnyPfannschmidt

CHANGELOG.rst

@@ -6,6 +6,7 @@ v6.0.0
 * drop egg building (use wheels)
 * add git node_date metadata to get the commit time-stamp of HEAD
 * allow version schemes to be priority ordered lists of version schemes
+* support for calendar versioning (calver) by date
 
 v5.0.2
 ======

setup.cfg

@@ -62,6 +62,7 @@ setuptools_scm.version_scheme =
     python-simplified-semver = setuptools_scm.version:simplified_semver_version
     release-branch-semver = setuptools_scm.version:release_branch_semver_version
     no-guess-dev = setuptools_scm.version:no_guess_dev_version
+    calver-by-date = setuptools_scm.version:calver_by_date
 
 [options.extras_require]
 toml =

src/setuptools_scm/version.py

@@ -309,6 +309,71 @@ def no_guess_dev_version(version):
         return version.format_with("{tag}.post1.dev{distance}")
 
 
+def date_ver_match(ver):
+    match = re.match(
+        (
+            r"^(?P<date>(?P<year>\d{2}|\d{4})(?:\.\d{1,2}){2})"
+            r"(?:\.(?P<patch>\d*)){0,1}?$"
+        ),
+        str(ver),
+    )
+    return match
+
+
+def guess_next_date_ver(version, node_date=None, date_fmt=None):
+    """
+    same-day -> patch +1
+    other-day -> today
+
+    distance is always added as .devX
+    """
+    match = date_ver_match(version)
+    if match is None:
+        raise ValueError(
+            "{version} does not correspond to a valid versioning date, "
+            "please correct or use a custom version scheme".format(version=version)
+        )
+    # deduct date format if not provided
+    if date_fmt is None:
+        date_fmt = "%Y.%m.%d" if len(match.group("year")) == 4 else "%y.%m.%d"
+    head_date = node_date or datetime.date.today()
+    # compute patch
+    tag_date = datetime.datetime.strptime(match.group("date"), date_fmt).date()
+    if tag_date == head_date:
+        patch = match.group("patch") or "0"
+        patch = int(patch) + 1
+    else:
+        if tag_date > head_date:
+            # warn on future times
+            warnings.warn(
+                "your previous tag  ({}) is ahead your node date ({})".format(
+                    tag_date, head_date
+                )
+            )
+        patch = 0
+    next_version = "{node_date:{date_fmt}}.{patch}".format(
+        node_date=head_date, date_fmt=date_fmt, patch=patch
+    )
+    # rely on the Version object to ensure consistency (e.g. remove leading 0s)
+    # TODO: support for intentionally non-normalized date versions
+    next_version = str(Version(next_version))
+    return next_version
+
+
+def calver_by_date(version):
+    if version.exact and not version.dirty:
+        return version.format_with("{tag}")
+    # TODO: move the release-X check to a new scheme
+    if version.branch is not None and version.branch.startswith("release-"):
+        branch_ver = _parse_version_tag(version.branch.split("-")[-1], version.config)
+        if branch_ver is not None:
+            ver = branch_ver["version"]
+            match = date_ver_match(ver)
+            if match:
+                return ver
+    return version.format_next_version(guess_next_date_ver, node_date=version.node_date)
+
+
 def _format_local_with_time(version, time_format):
 
     if version.exact or version.node is None:

testing/test_version.py

@@ -1,3 +1,5 @@
+from datetime import date, timedelta
+
 import pytest
 from setuptools_scm.config import Configuration
 from setuptools_scm.version import (
@@ -8,6 +10,7 @@
     no_guess_dev_version,
     guess_next_version,
     format_version,
+    calver_by_date,
 )
 
 
@@ -180,3 +183,98 @@ def test_format_version_schemes():
         local_scheme="no-local-version",
         version_scheme=[lambda v: None, "guess-next-dev"],
     )
+
+
+def date_to_str(date_=None, days_offset=0, fmt="{dt:%y}.{dt.month}.{dt.day}"):
+    date_ = date_ or date.today()
+    date_ = date_ - timedelta(days=days_offset)
+    return fmt.format(dt=date_)
+
+
+@pytest.mark.parametrize(
+    "version, expected_next",
+    [
+        pytest.param(
+            meta(date_to_str(days_offset=3), config=c),
+            date_to_str(days_offset=3),
+            id="exact",
+        ),
+        pytest.param(
+            meta(date_to_str() + ".1", config=c), date_to_str() + ".1", id="exact patch"
+        ),
+        pytest.param(
+            meta(date_to_str(fmt="20.01.02"), config=c),
+            "20.1.2",
+            id="leading 0s",
+        ),
+        pytest.param(
+            meta(date_to_str(days_offset=3), config=c, dirty=True),
+            date_to_str() + ".0.dev0",
+            id="dirty other day",
+        ),
+        pytest.param(
+            meta(date_to_str(), config=c, distance=2, branch="default"),
+            date_to_str() + ".1.dev2",
+            id="normal branch",
+        ),
+        pytest.param(
+            meta(date_to_str(fmt="{dt:%Y}.{dt.month}.{dt.day}"), config=c),
+            date_to_str(fmt="{dt:%Y}.{dt.month}.{dt.day}"),
+            id="4 digits year",
+        ),
+        pytest.param(
+            meta(date_to_str(), config=c, distance=2, branch="release-2021.05.06"),
+            "2021.05.06",
+            id="release branch",
+        ),
+        pytest.param(
+            meta(date_to_str() + ".2", config=c, distance=2, branch="release-21.5.1"),
+            "21.5.1",
+            id="release branch short",
+        ),
+        pytest.param(
+            meta(
+                date_to_str(days_offset=3) + ".2",
+                config=c,
+                node_date=date.today() - timedelta(days=2),
+            ),
+            date_to_str(days_offset=3) + ".2",
+            id="node date clean",
+        ),
+        pytest.param(
+            meta(
+                date_to_str(days_offset=2) + ".2",
+                config=c,
+                distance=2,
+                node_date=date.today() - timedelta(days=2),
+            ),
+            date_to_str(date.today() - timedelta(days=2)) + ".3.dev2",
+            id="node date distance",
+        ),
+    ],
+)
+def test_calver_by_date(version, expected_next):
+    computed = calver_by_date(version)
+    assert computed == expected_next
+
+
+@pytest.mark.parametrize(
+    "version, expected_next",
+    [
+        pytest.param(meta("1.0.0", config=c), "1.0.0", id="SemVer exact"),
+        pytest.param(
+            meta("1.0.0", config=c, dirty=True),
+            "1.0.0",
+            id="SemVer dirty",
+            marks=pytest.mark.xfail,
+        ),
+    ],
+)
+def test_calver_by_date_semver(version, expected_next):
+    computed = calver_by_date(version)
+    assert computed == expected_next
+
+
+def test_calver_by_date_future_warning():
+    with pytest.warns(UserWarning, match="your previous tag*"):
+        calver_by_date(meta(date_to_str(days_offset=-2), config=c, distance=2))