bumpver/src/pycalver/version.py
2018-12-05 09:47:32 +01:00

72 lines
1.9 KiB
Python

# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
"""Functions related to version string manipulation."""
import logging
import pkg_resources
import typing as typ
import datetime as dt
from . import lex_id
from . import parse
log = logging.getLogger("pycalver.version")
def current_calver() -> str:
"""Generate calver version string based on current date.
example result: "v201812"
"""
return dt.date.today().strftime("v%Y%m")
def incr(old_version: str, *, release: str = None) -> str:
"""Increment a full PyCalVer version string.
Old_version is assumed to be a valid calver string,
already validated in pycalver.config.parse.
"""
old_ver = parse.parse_version_info(old_version)
new_calver = current_calver()
if old_ver.calver > new_calver:
log.warning(
f"'version.incr' called with '{old_version}', "
+ f"which is from the future, "
+ f"maybe your system clock is out of sync."
)
# leave calver as is (don't go back in time)
new_calver = old_ver.calver
new_build = lex_id.next_id(old_ver.build[1:])
new_release: typ.Optional[str] = None
if release is None:
if old_ver.release:
# preserve existing release
new_release = old_ver.release[1:]
else:
new_release = None
elif release == 'final':
new_release = None
else:
new_release = release
new_version = new_calver + "." + new_build
if new_release:
new_version += "-" + new_release
return new_version
def pycalver_to_pep440(version: str) -> str:
"""Derive pep440 compliant version string from PyCalVer version string.
>>> pycalver_to_pep440("v201811.0007-beta")
'201811.7b0'
"""
return str(pkg_resources.parse_version(version))