technofab/bumpver
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/bumpver.git synced 2025-12-12 06:20:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

formatting updates

Browse source
This commit is contained in:
Manuel Barkhau 2018-11-06 21:45:33 +01:00
parent 3385f2d675
commit 1129de0beb
11 changed files with 153 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/pycalver/__init__.py
View file

@ -3,9 +3,6 @@
#
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
import os
"""PyCalVer: Automatic CalVer Versioning for Python Packages."""
__version__ = "v201809.0002-beta"
DEBUG = os.environ.get("PYDEBUG", "0") == "1"

38
src/pycalver/__main__.py
View file

@ -4,6 +4,11 @@
#
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
"""
CLI module for pycalver.
Provided subcommands: show, init, incr, bump
"""
import io
import os
@ -24,13 +29,13 @@ log = logging.getLogger("pycalver.__main__")
def _init_loggers(verbose: bool) -> None:
if DEBUG:
log_formatter = logging.Formatter('%(levelname)s - %(name)s - %(message)s')
log_formatter = logging.Formatter("%(levelname)s - %(name)s - %(message)s")
log_level = logging.DEBUG
elif verbose:
log_formatter = logging.Formatter('%(levelname)s - %(message)s')
log_formatter = logging.Formatter("%(levelname)s - %(message)s")
log_level = logging.INFO
else:
log_formatter = logging.Formatter('%(message)s')
log_formatter = logging.Formatter("%(message)s")
log_level = logging.WARNING
loggers = [log, vcs.log, parse.log, config.log, rewrite.log, version.log]
@ -47,11 +52,12 @@ def _init_loggers(verbose: bool) -> None:
@click.group()
def cli():
"""parse and update project versions automatically."""
"""Parse and update project versions."""
@cli.command()
def show() -> None:
"""Show current version."""
_init_loggers(verbose=False)
cfg: config.MaybeConfig = config.parse()
@ -69,6 +75,7 @@ def show() -> None:
"--release", default=None, metavar="<name>", help="Override release name of current_version"
)
def incr(old_version: str, release: str = None) -> None:
"""Increment a version number for demo purposes."""
_init_loggers(verbose=False)
if release and release not in parse.VALID_RELESE_VALUES:
@ -76,7 +83,7 @@ def incr(old_version: str, release: str = None) -> None:
log.error(f"Valid arguments are: {', '.join(parse.VALID_RELESE_VALUES)}")
sys.exit(1)
new_version = version.bump(old_version, release=release)
new_version = version.incr(old_version, release=release)
new_version_nfo = parse.parse_version_info(new_version)
print("PyCalVer Version:", new_version)
@ -88,7 +95,7 @@ def incr(old_version: str, release: str = None) -> None:
"--dry", default=False, is_flag=True, help="Display diff of changes, don't rewrite files."
)
def init(dry: bool) -> None:
"""Initialize [pycalver] configuration in setup.cfg"""
"""Initialize [pycalver] configuration."""
_init_loggers(verbose=False)
cfg : config.MaybeConfig = config.parse()
@ -138,6 +145,7 @@ def init(dry: bool) -> None:
def bump(
release: str, verbose: bool, dry: bool, commit: bool, tag: bool, allow_dirty: bool
) -> None:
"""Increment the current version string and update project files."""
_init_loggers(verbose)
if release and release not in parse.VALID_RELESE_VALUES:
@ -152,7 +160,7 @@ def bump(
sys.exit(1)
old_version = cfg.current_version
new_version = version.bump(old_version, release=release)
new_version = version.incr(old_version, release=release)
log.info(f"Old Version: {old_version}")
log.info(f"New Version: {new_version}")
@ -163,15 +171,17 @@ def bump(
file_patterns = cfg.file_patterns
filepaths = set(file_patterns.keys())
_vcs = vcs.get_vcs()
if _vcs is None:
log.warn("Version Control System not found, aborting commit.")
else:
_vcs.assert_not_dirty(filepaths, allow_dirty)
rewrite.rewrite(new_version, file_patterns, dry, verbose)
if dry or not commit or _vcs is None:
try:
_vcs = vcs.get_vcs()
except OSError:
log.warn("Version Control System not found, aborting commit.")
return
_vcs.assert_not_dirty(filepaths, allow_dirty)
if dry or not commit:
return
# TODO (mb 2018-09-04): add files and commit

2
src/pycalver/config.py
View file

@ -1,7 +1,7 @@
# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# (C) 2018 Manuel Barkhau (@mbarkhau)
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
import io

2
src/pycalver/lex_id.py
View file

@ -1,7 +1,7 @@
# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# (C) 2018 Manuel Barkhau (@mbarkhau)
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
"""

50
src/pycalver/parse.py
View file

@ -1,7 +1,7 @@
# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# (C) 2018 Manuel Barkhau (@mbarkhau)
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
import re
@ -17,7 +17,7 @@ VALID_RELESE_VALUES = ("alpha", "beta", "dev", "rc", "post")
# https://regex101.com/r/fnj60p/10
PYCALVER_RE: typ.Pattern[str] = re.compile(r"""
PYCALVER_PATTERN = r"""
\b
(?P<version>
(?P<calver>
@ -34,8 +34,19 @@ PYCALVER_RE: typ.Pattern[str] = re.compile(r"""
(?:alpha|beta|dev|rc|post)
)?
)(?:\s|$)
""", flags=re.VERBOSE)
"""
PYCALVER_RE: typ.Pattern[str] = re.compile(PYCALVER_PATTERN, flags=re.VERBOSE)
PATTERN_ESCAPES = [
("\u005c", "\u005c\u005c"),
("-" , "\u005c-"),
("." , "\u005c."),
("+" , "\u005c+"),
("*" , "\u005c*"),
("[" , "\u005c["),
("(" , "\u005c("),
]
# NOTE (mb 2018-09-03): These are matchers for parts, which are
# used in the patterns, they're not for validation. This means
@ -45,11 +56,11 @@ PYCALVER_RE: typ.Pattern[str] = re.compile(r"""
RE_PATTERN_PARTS = {
"pep440_version" : r"\d{6}\.[1-9]\d*(a|b|dev|rc|post)?\d*",
"version" : r"v\d{6}\.\d{4,}(\-(alpha|beta|dev|rc|post))?",
"calver" : r"v\d{6}",
"build" : r"\.\d{4,}",
"release" : r"(\-(alpha|beta|dev|rc|post))?",
'pep440_version': r"\d{6}\.[1-9]\d*(a|b|dev|rc|post)?\d*",
'version' : r"v\d{6}\.\d{4,}(\-(alpha|beta|dev|rc|post))?",
'calver' : r"v\d{6}",
'build' : r"\.\d{4,}",
'release' : r"(\-(alpha|beta|dev|rc|post))?",
}
@ -81,20 +92,17 @@ def parse_version_info(version: str) -> VersionInfo:
return VersionInfo(pep440_version=pep440_version, **match.groupdict())
def iter_pattern_matches(lines: typ.List[str], pattern: str) -> typ.Iterable[PatternMatch]:
def _iter_pattern_matches(lines: typ.List[str], pattern: str) -> typ.Iterable[PatternMatch]:
# The pattern is escaped, so that everything besides the format
# string variables is treated literally.
pattern_re = re.compile(
pattern
.replace("\\", "\\\\")
.replace("-", "\\-")
.replace(".", "\\.")
.replace("+", "\\+")
.replace("*", "\\*")
.replace("[", "\\[")
.replace("(", "\\(")
.format(**RE_PATTERN_PARTS)
)
pattern_tmpl = pattern
for char, escaped in PATTERN_ESCAPES:
pattern_tmpl = pattern_tmpl.replace(char, escaped)
pattern_str = pattern_tmpl.format(**RE_PATTERN_PARTS)
pattern_re = re.compile(pattern_str)
for lineno, line in enumerate(lines):
match = pattern_re.search(line)
if match:
@ -104,5 +112,5 @@ def iter_pattern_matches(lines: typ.List[str], pattern: str) -> typ.Iterable[Pat
def parse_patterns(lines: typ.List[str], patterns: typ.List[str]) -> typ.List[PatternMatch]:
all_matches: typ.List[PatternMatch] = []
for pattern in patterns:
all_matches.extend(iter_pattern_matches(lines, pattern))
all_matches.extend(_iter_pattern_matches(lines, pattern))
return all_matches

19
src/pycalver/vcs.py
View file

@ -1,12 +1,12 @@
# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# (C) 2018 Manuel Barkhau (@mbarkhau)
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
#
# pycalver/vcs.py (this file) is based on code from the
# bumpversion project: https://github.com/peritus/bumpversion
# MIT License - (C) 2013-2014 Filip Noetzel
# Copyright (c) 2013-2014 Filip Noetzel - MIT License
import os
import sys
@ -83,9 +83,9 @@ class BaseVCS:
class Git(BaseVCS):
_TEST_USABLE_COMMAND = ["git", "rev-parse", "--git-dir"]
_COMMIT_COMMAND = ["git", "commit" , "-F"]
_STATUS_COMMAND = ["git", "status" , "--porcelain"]
_TEST_USABLE_COMMAND = ["git", "rev-parse", '--git-dir']
_COMMIT_COMMAND = ["git", "commit" , '-F']
_STATUS_COMMAND = ["git", "status" , '--porcelain']
@classmethod
def tag(cls, name):
@ -99,8 +99,8 @@ class Git(BaseVCS):
class Mercurial(BaseVCS):
_TEST_USABLE_COMMAND = ["hg", 'root']
_COMMIT_COMMAND = ["hg", "commit", "--logfile"]
_STATUS_COMMAND = ["hg", "status", "-mard"]
_COMMIT_COMMAND = ["hg", "commit", '--logfile']
_STATUS_COMMAND = ["hg", "status", '-mard']
@classmethod
def tag(cls, name):
@ -114,9 +114,10 @@ class Mercurial(BaseVCS):
VCS = [Git, Mercurial]
def get_vcs() -> typ.Optional[typ.Type[BaseVCS]]:
def get_vcs() -> typ.Type[BaseVCS]:
"""Get appropriate sub"""
for vcs in VCS:
if vcs.is_usable():
return vcs
return None
raise OSError("No such directory .hg/ or .git/ ")

18
src/pycalver/version.py
View file

@ -1,8 +1,9 @@
# This file is part of the pycalver project
# https://github.com/mbarkhau/pycalver
#
# (C) 2018 Manuel Barkhau (@mbarkhau)
# Copyright (c) 2018 Manuel Barkhau (@mbarkhau) - MIT License
# SPDX-License-Identifier: MIT
"""Functions related to version string manipulation."""
import logging
import typing as typ
@ -15,19 +16,26 @@ 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 bump(old_version: str, *, release: str = None) -> str:
# old_version is assumed to be a valid calver string,
# validated in pycalver.config.parse.
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.bump' called with '{old_version}', "
f"'version.incr' called with '{old_version}', "
+ f"which is from the future, "
+ f"maybe your system clock is out of sync."
)

22
test/test_config.py
View file

@ -23,7 +23,9 @@ def test_parse_default_config():
def test_parse(tmpdir):
setup_path = tmpdir.mkdir("minimal").join("setup.cfg")
setup_path.write("\n".join((
setup_path.write(
"\n".join(
(
"[pycalver]",
"current_version = v201808.0001-dev",
"commit = False",
@ -32,7 +34,9 @@ def test_parse(tmpdir):
"[pycalver:file:setup.cfg]",
"patterns = ",
" current_version = {version}",
)))
)
)
)
cfg = config.parse(str(setup_path))
@ -64,11 +68,15 @@ def test_parse_empty_config(tmpdir):
def test_parse_missing_version(tmpdir):
setup_path = tmpdir.mkdir("fail").join("setup.cfg")
setup_path.write("\n".join((
setup_path.write(
"\n".join(
(
"[pycalver]",
# f"current_version = v201808.0001-dev",
"commit = False",
)))
)
)
)
cfg = config.parse(str(setup_path))
assert cfg is None
@ -76,11 +84,7 @@ def test_parse_missing_version(tmpdir):
def test_parse_invalid_version(tmpdir):
setup_path = tmpdir.mkdir("fail").join("setup.cfg")
setup_path.write("\n".join((
"[pycalver]",
"current_version = 0.1.0",
"commit = False",
)))
setup_path.write("\n".join(("[pycalver]", "current_version = 0.1.0", "commit = False")))
cfg = config.parse(str(setup_path))
assert cfg is None

2
test/test_lex_id.py
View file

@ -18,7 +18,7 @@ def test_next_id_overflow():
def test_next_id_random():
for i in range(1000):
prev_id = str(random.randint(1, 100000))
prev_id = str(random.randint(1, 100_000))
try:
next_id = lex_id.next_id(prev_id)
assert prev_id < next_id

12
test/test_rewrite.py
View file

@ -3,13 +3,13 @@ from pycalver import rewrite
def test_rewrite_lines():
old_lines = [
'# This file is part of the pycalver project',
'# https://github.com/mbarkhau/pycalver',
'#',
'# (C) 2018 Manuel Barkhau (@mbarkhau)',
'# SPDX-License-Identifier: MIT',
"# This file is part of the pycalver project",
"# https://github.com/mbarkhau/pycalver",
"#",
"# (C) 2018 Manuel Barkhau (@mbarkhau)",
"# SPDX-License-Identifier: MIT",
'',
'import os',
"import os",
'',
'__version__ = "v201809.0002-beta"',
'DEBUG = os.environ.get("PYDEBUG", "0") == "1"',

33
test/test_version.py
View file

@ -14,44 +14,41 @@ def test_current_calver():
def test_bump_beta():
calver = version.current_calver()
cur_version = calver + ".0001-beta"
assert cur_version < version.bump(cur_version)
assert version.bump(cur_version).endswith("-beta")
assert version.bump(cur_version, release="alpha").endswith("-alpha")
assert version.bump(cur_version, release="final").endswith("0002")
assert cur_version < version.incr(cur_version)
assert version.incr(cur_version).endswith("-beta")
assert version.incr(cur_version, release="alpha").endswith("-alpha")
assert version.incr(cur_version, release="final").endswith("0002")
def test_bump_final():
calver = version.current_calver()
cur_version = calver + ".0001"
assert cur_version < version.bump(cur_version)
assert version.bump(cur_version, release="alpha").endswith("-alpha")
assert version.bump(cur_version, release="final").endswith("0002")
assert version.bump(cur_version).endswith("0002")
assert cur_version < version.incr(cur_version)
assert version.incr(cur_version, release="alpha").endswith("-alpha")
assert version.incr(cur_version, release="final").endswith("0002")
assert version.incr(cur_version).endswith("0002")
def test_bump_future():
future_date = dt.datetime.today() + dt.timedelta(days=300)
future_calver = future_date.strftime("v%Y%m")
cur_version = future_calver + ".0001"
assert cur_version < version.bump(cur_version)
assert cur_version < version.incr(cur_version)
def test_bump_random():
def test_bump_random(monkeypatch):
cur_date = dt.date.today()
cur_version = cur_date.strftime("v%Y%m") + ".0001-dev"
def _mock_current_calver():
return cur_date.strftime("v%Y%m")
_orig_current_calver = version.current_calver
version.current_calver = _mock_current_calver
try:
monkeypatch.setattr(version, 'current_calver', _mock_current_calver)
for i in range(1000):
cur_date += dt.timedelta(days=int((1 + random.random()) ** 10))
new_version = version.bump(cur_version, release=random.choice([
None, "alpha", "beta", "rc", "final"
]))
new_version = version.incr(
cur_version, release=random.choice([None, "alpha", "beta", "rc", 'final'])
)
assert cur_version < new_version
cur_version = new_version
finally:
version.current_calver = _orig_current_calver